Filter results by

The Manifest

ARTIK cloud services are designed to communicate with any device regardless of how data is structured. Devices can upload data to ARTIK cloud services in any format that works for them, and can send data to targeted devices via ARTIK cloud services in any format that works for the targeted devices. Data is contained in a message.

ARTIK cloud services use what we call the Manifest to interpret the content so that it can be stored properly, or be sent to targeted devices correctly. When defining or updating a device type, you must provide a Manifest that describes the device data. Once you define the Manifest for your device type, ARTIK cloud services can then make its data available to other services and devices.

The Manifest can quickly be created on the Developer Dashboard via a Web form with a drag-and-drop interface. This Web form determines the structure of the JSON payload sent by your devices. Manifests are automatically approved, and are designed to facilitate prototyping and provide a fast path to production.

Peek into the basics

Once you have created a device type in the Developer Dashboard, you can define the Manifest using the same interface.

In the Dashboard, click on the device type name, and then click "+ New Manifest".

Create a Manifest New Button

Define the device fields

The device fields you input will appear in the Manifest JSON. ARTIK cloud services use them to interpret the data messages sent by the device.

Create a Manifest Device Fields

The field name is a unique name assigned to each field. Field names must be alphanumeric (no spaces or special characters).

ARTIK cloud services will auto-suggest a field name as you type. We recommend using the suggested name if the field is listed as a standard field (e.g., "distance", "weight", "temp"). You can also select a standard field by clicking "Browse standard fields".

Create a Manifest Standard Fields

You must select a data type and optionally provide a unit of measurement. If ARTIK cloud services recognize the field, these will be automatically populated. Standard units of measurement can be viewed by clicking "Browse", or can be specified using the unit symbol.

We strongly recommend providing a description and tags to help other developers learn about and discover your device type.

After saving each field, you may add more fields or create an optional field group to further organize the device fields in the Manifest.

Create a Manifest Field Group

Below, several related fields have been added to a field group called steps.

Create a Manifest Field Group

Define the device Actions

Defining device Actions is optional. An Action is a type of message that sends a command to a device.

Create a Manifest Actions

Click the "Device Actions" tab. As with device fields, a list of standard Actions is provided. If possible, use a standard Action for consistency with the ARTIK cloud services platform.

Provide an optional description for your device Action.

Create a Manifest Action Parameters

After saving, you have the option to define any additional parameters received by your Actions (some standard Actions already include relevant parameters). Below, we define a parameter state corresponding to an Action setState.

Create a Manifest Multi-Value Parameter

Parameters may also be multi-valued, meaning that they are composed of key-value pairs (e.g., an action named setColorRGB may receive a multi-valued parameter called colorRGB which, in turn, is composed of multiple values: red, green, and blue).

Create a Manifest Multi-Value Parameter

You may further define an acceptable range or selection of values for the Action parameter. Note that a field that fails to pass validation will cause the entire message payload to be rejected.

Activate the Manifest

Click on the "Activate Manifest" tab.

Create a Manifest Activate

A Manifest is automatically approved to go live. When ready, click the "Activate Manifest" button. (This will not publish your device type.)

You can later update this Manifest by navigating to your device type in the Dashboard, clicking to its "Manifest" page, and clicking the "+ New Version" button.