Creating a device

There are some ways to create a device, you can create using our public API, which is documented here, or using the platform.

Organizations

Under de organization page, you have to first select an organization, than an application, once you are on the application screen, you have the device button on the middle right, and then you can click on the "+ Device" button.

Devices

Under device page it has only a single "+ Device" button on top right

Device builder

At first you have to select Private or Public LoRaWAN.

caution

Each device connectivity has it's own configuration, you can find out the shortcut for the configuration at the bottom of the page

The device model is a preset for a already known device, it can help you to fullfil some fields, decode uplink and encode downlink.

Right below "Device info", is the application where the device gonna be created, the builder select the last application where you were, but you can change it if needed

For any device, is required to fill the name, label and eui, description is not required but may help you to known what that device does

Description eg. "This a thermometer placed on the entrance hall, it control the air conditioner"

All the rest depends on what connectivity you has selected before. you can find out the shortcut for the configuration at the bottom of the page

Bulk file import

• We support json and csv files to import devices.
• It's important to fill all required fields for each device connectivity.
• You can import Private LoRaWAN and Public LoRaWAN at the same file, just pay attention for which fields are required for each connectivity.
• It's also important to follow all format rules, for specifications of json and csv.
• Do not use double or single quote for csv.
• Notice that tags are separated by | at the csv file.
• For csv, header matters, make sure you header match values

Specifications of device fields

field	type	required	default	description
device_name	string	required
device_label	string	required
description	string	required
protocol	LORA | EVERYNET	required		LORA is for Private and EVERYNET for Public
tags	string | Array<string>		[] | ""	The type of tags are string for CSV separated by |
location_lat	float64		0
location_lng	float64		0
location_mode	string		auto
block_downlink	boolean		true	If true, device downlink is disconnected
block_uplink	boolean		true	If true, device uplink is disconnected
counter_up	uint32		0
nwk_counter_down	uint32		0
app_counter_down	uint32		0
activation	OTAA | ABP		OTAA
encryption	NS | APP		NS
dev_class	A | C		A
strict_counter	boolean		false
band	string	required		Check for each band for Private LoraWAN and Public LoRaWAN
band_config	string		empty	Only on Private LoRaWAN
counters_size	2 | 4		2	Only on Public LoRaWAN
devEUI	hex16	required*		Device EUI
appKey	hex32	required*		For Private Application key is required when using activation OTAA mac version 1.1x; For Public is required when using activation OTAA and encryption NS
nwk_key	hex32	required*		Network key is required when using activation OTAA
devAddr	hex8	required*		Device address is required when using activation ABP
appSKey	hex32	required*		For Private Application session key is required when using activation ABP; For Public is required when using activation ABP and encryption NS
nwkSEncKey	hex32	required*		Network session encryption key is required when using activation ABP
serving_nwk_session_int_key	hex32	required*		Serving network session integrity key is required when using activation ABP mac version 1.1x
fwd_nwk_session_int_key	hex32	required*		Forwarding network session integrity key is required when using activation ABP mac version 1.1x
app_eui	hex32	required*		Only on Public LoRaWAN
adr_mode	on | off | static		on	Only on Public LoRaWAN
adr_tx_power	uint32		0	Only on Public LoRaWAN
adr_datarate	uint32		0	Only on Public LoRaWAN
rx2_force	boolean		false	Only on Public LoRaWAN
mac_version	string	required*	1.0.3	Only on Private LoRaWAN: 1.0.1, 1.0.2, 1.0.3 , 1.0.4, 1.1.0
regional_parameters_revision	string		A	Only on Private LoRaWAN: A, B, RP002-1.0.0, RP002-1.0.1, RP002-1.0.2
max_eirp	uint32		0	Only on Private LoRaWAN
downlink_timeout	uint32		0	Only on Private LoRaWAN
rx1_delay	uint32		0	Only on Private LoRaWAN
rx1_data_rate_offset	uint32		0	Only on Private LoRaWAN
rx2_data_rate	uint32		0	Only on Private LoRaWAN
rx2_frequency	uint32		0	Only on Private LoRaWAN

The example above is for OTAA, Private LoRaWAN, mac version 1.0.3

JSON example

[
  {
    "device_name": "Sensor name",
    "device_label": "sensor-label",
    "description": "Any description",
    "protocol": "LORA",
    "devEUI": "d27cb0495aac2e1f",
    "tags": ["tag-1", "tag-2"],
    "location_lat": -23.987665,
    "location_lng": -46.598345,
    "location_mode": "manual",
    "block_downlink": false,
    "block_uplink": false,
    "counter_up": 0,
    "nwk_counter_down": 0,
    "app_counter_down": 0,
    "activation": "OTAA",
    "encryption": "NS",
    "dev_class": "A",
    "strict_counter": false,
    "band": "",
    "band_config": "",
    "mac_version": "1.0.3",
    "regional_parameters_revision": "A",
    "max_eirp": 0,
    "downlink_timeout": 5,
    "rx1_delay": 0,
    "rx1_data_rate_offset": 0,
    "rx2_data_rate": 0,
    "rx2_frequency": 0,
    "nwk_key": "e8a9caa94c4e56d6d895cbc98a09518e"
  }
]

CSV example

device_name,device_label,description,protocol,devEUI,tags,location_lat,location_lng,location_mode,block_downlink,block_uplink,counter_up,nwk_counter_down,app_counter_down,activation,encryption,dev_class,strict_counter,band,band_config,mac_version,regional_parameters_revision,max_eirp,downlink_timeout,rx1_delay,rx1_data_rate_offset,rx2_data_rate,rx2_frequency,nwk_key
Sensor name,sensor-label,any description,LORA,d27cb0495aac2e1f,tag-1|tag-2,-23.987665,-46.598345,manual,false,false,0,0,0,OTAA,NS,A,false,AU915,la915-1,1.0.3,A,0,5,0,0,0,0,e8a9caa94c4e56d6d895cbc98a09518e

CSV File as table:

device_name	device_label	description	protocol	devEUI	tags	location_lat	location_lng	location_mode	block_downlink	block_uplink	counter_up	nwk_counter_down	app_counter_down	activation	encryption	dev_class	strict_counter	band	band_config	mac_version	regional_parameters_revision	max_eirp	downlink_timeout	rx1_delay	rx1_data_rate_offset	rx2_data_rate	rx2_frequency	nwk_key
Sensor name	sensor-label	any description	LORA	d27cb0495aac2e1f	tag-1|tag-2	-23.987665	-46.598345	manual	false	false	0	0	0	OTAA	NS	A	false	AU915	la915-1	1.0.3	A	0	5	0	0	0	0	e8a9caa94c4e56d6d895cbc98a09518e

Next

If you already decided which kind of LoRaWAN you will use, you can go to the configuration page

→ Private LoRaWAN

→ Public LoRaWAN