Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Info

This article covers how to upload Devices. You may also wish to see our Gateway article for information on how to upload those.

Table of Contents
minLevel1
maxLevel7

Things you will need to get started

  • Your IoT Console credentials - You will use the IoT Console to upload Device IDs and to register devices into the LNSso that they are recognized within the dashboard app.

  • Your Chirpstack Login credentials - You will need to reference your Application ID and Device Profile IDs when registering hardware as found in use the Chirpstack console to register the device for use with the network.

Upload process for Chirpstack Devices

The following will show you how to upload devices so that they appear in the IoT Console (for app usage) and are registered in the Chirpstack LNS (for network connectivity).

Tip

We strongly recommend using the IoT Console to register devices on Chripstack. Not only does this save you a step, it is an easier and less trouble prone method than manually adding them from the Chirpstack console directly.

<video showing them how to do this, covering:

  1. Device Registry screen - upload device dialog

  2. How to Locate their Organizations ID and Device-Profile to specify in the dialog

How do I find my Application ID?

After logging into the Chirpstack console you can select Applications link and you will find your Application ID. You can reference the above video that demonstrates this.

Tip

You will use the numerical ID value during registration.

...

Where do I find the list of Device Profile IDs?

After logging into the Chirpstack console you can select the Device-profiles link and you will find a list of profiles for your use. You can reference the above video that demonstrates this.

...

From the Device-profiles screen, locate the correct profile for this hardware & deployment. If you need help identifying which Profile to use, please see our tips.

Tip

You will use the numerical ID value of the profile when registering it in the Console.

...

For example, in the below URL for a device-profile you will use the bolded ID portion.

...

How to add Devices

Devices need to be registered in both the IoT Console as well as in the Chirpstack console. This is necessary so that both the dashboard app and the network server recognize the hardware. For all the hardware sold and shipped my myDevices we do this for you, however if you want to bring your own hardware these steps are necessary.

Note

Currently, Devices can only be added individually in Chirpstack console. If you want them batch added you will need to submit a request for us to process the batch for you.

Coming soon: We are working on giving our partners the ability to batch add devices into both the Device Registry and into Chirpstack from a single step in the IoT Console Upload wizard! Stay tuned.

Anchor
singledevice
singledevice
Step 1: Add Devices to IoT Console

In this step you will add the Devices IDs to the IoT Console so that they are recognized by the dashboard app.

<QUICK VIDEO SHOWING THIS>

  1. Log into the IoT Console.

  2. Go to the Device Registry screen.

  3. Select Upload Devices.

  4. Complete adding the Devices through the Upload Devices dialog.

    1. For Device Type please select the correct Template for use with this device. If there is any doubt which to use please Contact Us.

    2. Select the Chirpstack network server you are using. Commonly this will be myDevices CSIO (US) for the US-based Chirpstack instance. Please reference the Chirpstack information you received from us if you forget which instance to use.

    3. Under Select an Upload Option specify the Device IDs. Manual Input will let you specify an individual sensors and CSV Upload will let you upload a batch of IDs.

Anchor
singlechirpstack
singlechirpstack
Step 2: Register Devices on Chirpstack

In this step you will register an individual device on Chirpstack so that it can be used with the network.

<QUICK VIDEO SHOWING THIS>

  1. Log into the Chirpstack console.

  2. Select Applications.

  3. In the list of Applications shown, click on the Application Name link.

    Image Added

  4. On the Applications> DEVICES screen that appears, select CREATE.

  5. Enter the General information on the device.

    1. For Device EUI specify the 16 digit DevEUI for the device.

    2. For Device-profile select the profile that corresponds with the gateway and hardware class for this device. See our tips below if you are ensure what to select here.

  6. Select CREATE DEVICE which will advance you to the next screen.

  7. Specify the Application Key and select SET DEVICE KEYS to finish setting up your device.

Tip

Your device is ready after adding your device to both the IoT Console and to Chirpstack. If you encounter any troubles with the device connecting, you can use the Chirpstack console to troubleshoot or change configuration settings as needed.

Anchor
batchdevices
batchdevices
Batch adding Devices for Chirpstack use

Currently, Devices can only be added individually within Chirpstack console. If registering individually is too large a task, you can contact us and we can batch register them to your Chirpstack instance for you.

To do so, Contact us with the details for your device registration.

Tip

Please be sure to provide all the information we need to register your hardware.

  • Include all the Hardware IDs

  • Include Device / Device Type & Model

  • Include your Organization information and Device-profile information (the same data you would require when registering hardware in the IoT Console and Chirpstack Console is the information we would need as well).

Anchor
tips
tips
Tips for selecting Device Profiles / which Device Class to use

Depending upon the complexity of your organization, you may see several Device-Profiles to choose from. You should select the profile which most closely matches with the hardware being added.

1: Match the sensor to the correct Frequency and Gateway

...

  • Class A for battery powered devices that wake up to communicate and have long battery life.

  • Class C for devices are often hardwired and stay awake so that they can react quickly to commands, such as actuators .

Device was already in Console but I still need to add it to Chirpstack

You can still use the IoT Console to register it! Simply follow the exact same process as if you were adding a new piece of hardware. During the registration step the dialog will indicate that it Skipped adding it into the Registry, but it will still proceed with registering the device on Chirpstack.

...

  • or valves.