¶ Endpoints
Endpoints are used to manage settings for individual clients or devices. Endpoints can be used to store unique credentials or other specific settings for your devices. Endpoints are associated with a single service.
¶ Endpoint List
The endpoint list provides details about each of your defined endpoints.
- Carat: Click the carat to expand more details about individual endpoints. Note that all charts show data from the past 30 days.
- Name: Name of the endpoint, used for display purposes only.
- Key: Key used to identify endpoint in triggers and other functions, the key must be unique within your account.
- Health: The Health column shows indicators based on the failures in the past 1, 7, and 30 days. <1% failure is green, 1%-50% is yellow, and >50% is red. This gives you a quick view on the health of your endpoints.
- Service: The service column shows which service the endpoint is associated with.
- Status: The Status column provides information about the current status of a endpoint.
- Trace: Indicates if trace is enabled on the endpoint.
- Last activity: The Last activity column shows when the endpoint last generated an event. Hover over the value to see the exact time.
- Actions: The actions column provides access to the logs for the specific endpoint, as well as the ability to edit or delete the endpoint. For LWM2M endpoints, you will also have an option to access the Object Browser if the device is currently connected.
¶ Endpoint Editor
The endpoint dialog is used to edit or create new endpoints.
- Endpoint name: Name of the endpoint, this field is only used for display purposes.
- Endpoint key: A globally unique key (across all accounts) that identifies the endpoint, this key is commonly used in triggers to reference an instance of a specific endpoint.
- Service: The service associated with the endpoint.
- Time before declared missing: The time in seconds for a device to be in-active to be declared "missing". This is useful for devices that report in infrequently and are not always connected. When a device is declared missing, it will generate an Endpoint Lifecycle event.
- Trace: Trace enables enhanced logging and event metadata depending on the underlying service used.
- Tags: Tags allow you to organize and query for your endpoints.
- Parameters: The parameters will be different for each endpoint based on its service, please refer to the individual documentation for the service you are using for detailed information.
¶ Endpoint Storage
Endpoint storage is a useful sub-system that stores complex objects related to endpoints. Storage objects may be set by the system, or can be set by the user via triggers or the API.
¶ Sample Use-Cases
- Store state information about an endpoint to track long running operations such as FOTA, or configuration updates.
- Store "twin" information including parameters that may need to be written to devices when they check in.
¶ Important Notes
- While you can access system defined storage objects, you must take care to avoid corrupting data, as it may lead to unexpected behavior.
¶ Viewing from the user interface
The endpoint storage for an endpoint is visible by expanding the endpoint in the Endpoint List and clicking on the storage icon.
¶ Access from triggers
Endpoint storage can be viewed and stored via the endpoint.storageGet() and endpoint.storageSet() functions. For more information checkout the documentation.
var obj = endpoint.storageGet('myendpoint', 'data')
obj.temp = 26.2
endpoint.storageSet('myendpoint', 'data', obj)