Skip to end of metadata
Go to start of metadata

The UI on GadgetKeeper allows for two basic operations on events:

A REST API tool, such as API Explorer provides additional operations for events, such as get/set datapoint values, get/set event details, etc. See Event Operations with REST API for more information.

Create Event

A new event for a "thing" can be created by clicking "New" in the "Events" section of the thing. A dialog box opens with the following settings:

FieldRequiredDescriptionDialog
Namex

Event name.

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

 

Data Type 

Event data type

  • A data value with the given data type must be included in the command that activates the event
Description Event description.

 

 

 

 

After an event has been created, it can be edited anytime by:

  1. Selecting the event in the "Events" section of the "thing"
  2. Clicking "Edit" in the details panel. A similar dialog box will open with the retained settings:

 

 

 

Push Event

Events serve no useful purpose unless they are activated. They are especially useful for recording data over a time period. There are many ways to activate an event, as explained in Create Event and Trigger. They can be activated by UI, REST API, script function, or dashboard widget. The "Push Event" dialog box on the UI is explained here. To open the dialog box for "Push Event":

  1. Select the event in the "Events" section of the "thing"
  2. Click "Push Event" in the details panel
FieldRequiredDescriptionDialog
FormatxThe request/response format (the only currently supported format is json)

 

Async If "Async" is checked, the push event operation will be performed asynchronously.
Event 

A value and a timestamp must be included whenever an event is pushed. The value must have the data type chosen for the event. A JSON data structure with "value" and "at" (timestamp) parameters is automatically generated when the dialog box is opened. The user can modify the given "value" parameter if needed. The current time is already generated for the "at" (timestamp) parameter.

 

 

 

 

 

 

  • No labels