Skip to end of metadata
Go to start of metadata

GadgetKeeper's UI provides several options for creating and managing products and serial numbers

 

Create Product

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

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

FieldRequiredDescriptionDialog
Namex

Name of product

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

Default template

x

This is the default template the product is to be based on. If no other template is selected when a serial number is created for a new device, the default template is used

Public
 

Checking the "Public" option allows the product's details to be accessed by anyone

If this option is unchecked, the product's details are only accessible for things based on one of its serial numbers

Description      
 Product description.

 

 

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

        1. Selecting the product in the "Products" tab
        2. Clicking "Edit" in the "Information" section of the product. A similar dialog box will open with the retained settings

Add Serial Numbers

Once a new product has been created on GadgetKeeper, any new device in its product line can have its details entered in for it, including serial number and base template. A unique "thing" must also be created for a new device. This can be done manually, as shown in Create Thing From Serial Number, or automatically on activation, as shown in Activate Device.

GadgetKeeper maintains a list of all the product's serial numbers in the product's "Information" section. Clicking on the serial number in the "Serial Numbers" section will open a details panel with Id, thing, template, and status information

Before a new device can be registered and activated, it must have a serial number entered in for it. This is normally done by:

        1. Selecting the product in the "Products" tab
        2. Clicking "New" in the "Serial Numbers" section of the product. A dialog box will open as shown below for registering a new serial number:
FieldRequiredDescriptionDialog
Template If the template used is different from the default template for the product, the template must be selected from the drop-down menu
Version 

If the version used is not the latest version of the selected template, the version must be selected from the drop-down menu.

Serial Numbersx

Serial number (or numbers) for a new device

  • Must correspond with the serial number on the device
  • Must be unique within the GadgetKeeper platform
  • Can contain only alphanumeric characters, _ (underscore) and - (minus)
  • Must be separated by commas if there is more than one serial number entered

 

 

If both the "Template:" and "Version:" boxes have been left blank, as in this example, the product's serial number is based on the default template, and the version number defaults to its latest version

After a serial number has been created for a new device, it can be edited by:

        1. Selecting the product in the "Products" tab
        2. Selecting the serial number in the "Serial Numbers" section of the product.
        3. Clicking "Edit" in the details panel for the serial number. A similar dialog box will open with the retained settings

Note that it is no longer possible to edit serial number information after a "thing" has been created from the serial number, as shown in the following table and in Create Thing From Serial Number (or Activate Device).

Create Thing from Serial Number

The following procedure describes how to create a "thing" on GadgetKeeper that corresponds to a working device with a serial number. The serial number for the device must already been entered and  listed in the product's tab as shown in the previous step:

        1. Click "Things" in main menu to open the "Things" tab
        2. Click "+" in this tab to open the "Create Thing" dialog

Note that it isn't necessary to create a "thing" corresponding to the device if the user decides to create it automatically when activating the device, as described in Activate Device. More code is required if the user decides to have a unique name for the "thing" instead of the default name.

FieldRequiredDescriptionDialog
Namex

Name of thing

  • Must be unique within the thing list
  • Can contain: 
    Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'Constraint - thing event name'.
SerialxThe serial number found on the device must be entered here, and it must correspond with the serial number entered in the previous "Create Serial Numbers" step
Icon Select from a choice of several icons in the drop-down menu
Description Thing description

 

 

 

 

 

 

 

  

After clicking "Save", a new "thing" has been created to model the device, and its tab is opened.

    • The base template and version details can be found in the "Information" section under "Template". This also provides details on the model thing used in creating the version
    • The base product and serial number can also be found in the "Information" section under "Product"

This information can also be found in the "Serial Numbers" section of the product's tab. After selecting the serial number:

    • The base template, version details, and model thing details can be found under "Server version".
    • The "thing" created for the serial number can be found under "Thing"
    • The status of the serial number can be checked under "Status"

The new "thing" created here is actually a clone of the model thing that the template version is based on

 

Activating Device and Updating Firmware

 

After creating a product on GadgetKeeper and registering a serial number for a new device, the device can be activated, which includes registering it, and then downloading, installing, and verifying the latest firmware version. A detailed step-by-step procedure for activating a new device can be found in the Activate Device tutorial. This procedure is also summarized in Device Provisioning

Once a device is activated, it should periodically check for any new firmware versions periodically on GadgetKeeper. if a newer version is found, it should be downloaded, installed, and verified on GadgetKeeper. A detailed step-by-step procedure for updating firmware can be found in the Update Device Firmware tutorial. This procedure is also summarized in Firmware Update By GadgetKeeper.

Any part of the activation or firmware update procedure can be programmed to be done automatically by the device, according to a schedule, with little or no user interaction. Automated programming in a device would enable the new version to be scanned for according to a schedule, and then downloaded, installed, and verified on GadgetKeeper immediately, or the device could present the user with a series of options on how to proceed. Many options for this are explained in Device Initiated Firmware Update.


 

  • No labels