Filter results by

Onboard a physical device

If you are in the business of making devices, your first step is to create a new device type on the Developer Dashboard. It only takes a few clicks. What about your physical devices?

Each of your physical devices corresponds to an instance of the device type you just created. It sends data messages to and/or receives Actions from ARTIK cloud services in the format you defined in the Manifest of the device type. To do that, each physical device must have a valid device ID and access token.

Onboarding devices is the process of obtaining and then loading these credentials on the physical devices. Below are suggestions for a number of use cases:

We assume you are familiar with device types and device and user tokens.

My device requires a higher level of security, such as secure device identification/authentication.

Consider Secure Device Registration to bring your device into ARTIK cloud services. Devices built with ARTIK Modules directly benefit from built-in secure device registration.

I am prototyping my device.

Onboard your device manually:

  1. Log into your account at My ARTIK Cloud.
  2. Connect a device of the device type you defined earlier.
  3. Get the device ID and token (device credentials).
  4. Write the device credentials into the code running on the physical device.

The device can now communicate with ARTIK cloud services via API calls.

Examples

My device has a UI and an internet connection.

Develop an application that runs the login flow on the device. The app does the following programmatically:

  1. Display the login UI and obtain the user token after login.
  2. Connect a device on ARTIK cloud services using the user token.
  3. Create a device token.

The device can now communicate with ARTIK cloud services using the device token.

My device has a UI with limited input and an internet connection.

Develop an application that runs the login flow using Limited Input method on the device.

  1. The app sends a request to ARTIK cloud services to get a user code.
  2. The device shows a URL and the user token to the user.
  3. The user loads the URL in a web browser (on desktop computer or mobile phone) and enters the user code to authorize the device.
  4. The app keeps pulling ARTIK cloud services until it receives a user token. This happens only after the user finishes the above operation.
  5. The app creates a device token.

The device can now communicate with ARTIK cloud services using the device token.

Examples

My device does not have a UI, but has an internet connection.

Develop a mobile application that the device owner can use to connect the device to his/her ARTIK Cloud account. The app does the following programmatically:

  1. Display the login UI and obtain the user token after login.
  2. Connect a device on ARTIK cloud services using the user token.
  3. Create a device token.
  4. Pass the device ID and device token to the physical device (for example, via Bluetooth or LAN connection).

The device can now communicate with ARTIK cloud services using the device token.

My device only has local network connection (e.g. Bluetooth, ZigBee, etc.) and cannot access the internet directly.

Develop a proxy application running on a mobile phone or a hub to onboard the device. The proxy app communicates to ARTIK cloud services via internet and communicates to the device via the local network. The app does the following programmatically:

  1. Display the login UI and obtain the user token after login.
  2. Connect a device on ARTIK cloud services using the user token.
  3. Send the device data to ARTIK cloud services and send device Actions from ARTIK cloud services to the device. You might use a user token for this. However, a device token is our recommendation if the app is only used as a proxy. Read about the token types.

The device can now communicate with ARTIK cloud services via the proxy app.

Examples

My device uses its own cloud which exposes public APIs.

Build a Cloud Connector for your device type. ARTIK cloud services will treat the Cloud Connector as a device.

The device owner can then onboard the device manually using My ARTIK Cloud. The device can also be onboarded programmatically.

The device can now communicate with ARTIK cloud services with the Cloud Connector serving as the data source.