Skip to end of metadata
Go to start of metadata

The UI on GadgetKeeper provides several options for managing and updating templates and template versions:

 

Create Template

To create a new template, make sure the "Templates" tab is open by clicking "Templates" in the main menu.

The "Create Template" dialog box opens by clicking the green "plus" sign on the top right

FieldRequiredDescriptionDialog
Namex

Name of template

  • Must be unique within the template list
  • Can contain: 
    Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'Constraint - thing event name'.

 

Public
 

Checking the "Public" option allows the template to be accessed by anyone

If this option is unchecked, the template is only accessible for existing things it is based on

Description Template description.

 

 

 

After a template has been created, it can be edited anytime by:

  1. Selecting the template in the "Templates" tab
  2. In the "Information section, click "Edit" in the details panel. A similar dialog box will open with the retained settings

 

 

 

 

Create Version

Templates serve no useful purpose unless there are versions created for it. Each version is based on one of the existing "things". Creating a version also creates a new thing that is a clone of the prototype thing, and remains fixed as it was at the moment of creation

A new version for a template can be created by:

  1. Selecting the template in the "Templates" tab
  2. In the "Versions" section, click "New". A dialog box opens with the following settings:
FieldRequiredDescriptionDialog
Namex

Name of version

  • Must be unique within the template list
  • Can contain: 
    Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'Constraint - thing event name'.
  • The default setting is to name the first version "1", and increment from there
Prototype thingx

The selected "thing" that the template is to be based on

Update performed by thing 

When checked, it allows a device to initiate an update automatically to the this version without confirmation from the owner.

If this box is unchecked, the device owner must download this version manually using command options

Description Description of version

 

 

 

Update Version

After a version has been created, it can be edited (updated) anytime by:

  1. Selecting the template in the "Templates" tab
  2. Selecting the version In the "Versions" section of the template
  3. Clicking "Edit" in the details panel. A similar dialog box will open with the retained settings

Note that two new parameters appear in the "Edit Version" dialog box. These are explained as follows:






FieldRequiredDescription
Update to version Selecting a version here provides a notification to a device that it should update to a different (newer) version. The device receives this message when scanning for possible updates.
Update automatic 

When checked, it allows a device to initiate an update automatically to the the version indicated in "Update to version" without confirmation from the owner.

If this box is unchecked, the device owner must download the selected version manually using command options

 

 

 

Update Thing to New Version

Any working device in the field runs on firmware based on one the the versions of its production template. Each device must have a unique "thing" which contains information about its properties, firmware version, etc.

There are three ways to create a new "thing" based on a template. The new thing is actually a clone of the template version's model thing.

  1. Create a "thing" directly from the template (or template version), as described in Create Thing From Template
  2. Create a "thing" based on the serial number of a device as shown in Create Thing From Serial Number
  3. Create a "thing" by activating a new device, as explained in Activate Device

If a new production version becomes available, the device's "thing" on GadgetKeeper must be updated to that version as shown in Update Thing to New Version. This is done to notify the device that it should be updated to this new version.

Note: The "thing" can be updated only if it has a template name and version number already shown in its "Information" section ("thing" was created from a template or serial number)

To open the "Update Thing" dialog box, open the tab for the device's "thing", and then in the "Information" section, click "Update"

Select the newer version in the drop-down menu of "Upgrade to version", and then click "Update" to perform the update

 

 

 

 

 

 

  • No labels