Device Management

Controlling & Managing Devices

neqto: Cloud allows customers to remotely control and manage IoT devices and deployments. Through neqto: Console's streamlined UI, from any computer, tablet, or smartphone's browsers users can access these cloud features and do things like see real-time data or send commands to their devices.

Managing Devices & Licenses

From the Console, you can control and manage what devices are linked to a license and usable in neqto:.

Licenses

All devices connected to neqto: Cloud require an appropriate license. To manage licenses, click on the user icon and select "Manage Licenses" in the drop-down menu.

Licenses contain the following user-input information.

Item	Description
Device Type	Choose the supported device you wish to use the license with.
License Type (Required)	Select the license type you would like to use for the device.

Add a License

1. In the upper-right hand corner click the "Add License" button.
2. Choose the appropriate device type and which license you would like to apply.
3. Hit 'save'.

• Unused licenses still incur cost- be sure to remove unused licenses.

Delete a License

1. Next to the license, click the "X" icon to open the deletion confirmation dialogue.
2. Enter in the license id of the license to confirm, then click the delete button.

• If a license is being used by a device, the device must be removed before a license can be deleted.

Devices

To manage devices, click on the user icon and select "Manage devices" in the drop-down menu.

Devices contain the following user-input information.

Item	Description
Note	Since devices use alphanumeric ID's, set a note to help your organization identify and search for your device.
Device Type (Required)	Select the type of neqto: device you are using.
License*	Search using License ID and select the license you wish to link to the device. * This field is only required when using an existing license.
License Type*	Select the license type you would like to use for the device. * This field is only required for when registering a new license with the device.
Serial ID*	The serial ID associated with your neqto: Bridge. * This field is only required for neqto: Bridge Device Type.
Product Key*	The Product Key for your neqto: Bridge. * This field is only required for neqto: Bridge Device Type.

Add a Device

To perform batch registration of devices, refer to Batch registration of devices on the Batch registration method page of nodes/devices.

1. In the upper-right hand corner click the "Add Device" button.
2. Write a note to help identify your device within your organization.
3. Choose the appropriate device type and which license you would like to apply or create a new license and choose the license type.
4. Hit 'save'.

QR Code Scanner (neqto: Bridge)

The supplementary QR Scanner feature is provided to add a device through the neqto: Console by scanning the QR Code of the device. The Serial ID and Product Key will be registered automatically upon a successful scan of the neqto: Bridge device.

• On iOS 11, QR scanner is only supported on Safari.
• If scanning the QR code is difficult through webcam, consider using a mobile phone camera or an additional clip-type macro lens.

View a device's details

1. At the Devices page, locate the device you wish to confirm in the list.
2. Click the "Details" button.

• Spresense devices can see their current challenge code or regenerate a new challenge code.
• Remember to keep details like serial IDs and challenge codes a secret!

Edit or Delete a Device

1. Go to the device list and reference the above picture.
2. Click the pencil icon in the row of the device you wish to edit.

To Edit

1. Change as desired.
2. Hit "Save" to commit the changes or "X" to cancel this operation.

To delete

1. In the lower-left corner of the dialogue click the "delete" button.
2. Enter in the serial id of the device to confirm, then click the delete button.

Groups

"Groups" are exactly as the name suggests. It defines an organizational unit and grouping of resources in neqto: Cloud. Devices are registered to groups as nodes, along with firmware and other resources.

The following information is needed to add a group.

Item	Description
Name (Required)	Enter the name for the Group.
Note	Any description that may help your organization identify this group.
Infinitypool	Check to opt-in to this optional service.
Insights	Check to opt-in to this optional service.
Custodia	Check to opt-in to this optional service.

Add a Group

1. At the Groups page, click the "Add Group" button in the upper-right hand corner.
2. Enter the necessary information.
3. Click the "save" button.

Edit or Delete a Group

1. Go to the Groups page.
2. Click the pencil icon in the row of the Group you wish to edit.

To Edit

1. Change as desired.
2. Hit "Save" to commit the changes or "X" to cancel this operation.

To delete

1. In the lower-left corner of the dialogue click the "delete" button.
2. Enter in the name of the group to confirm, then click the delete button.

• When editing a group, you may notice the "optional services" category. Optional services all you to opt-in to neqto: Apps. They are opt-out by default.

Templates

Templates are virtual "models" of devices. They define physical hardware configurations and allow nodes of the same type of device to be easily created, updated, and operated on.

A Template defines the following aspects of a device:

Field	Detail
Name	Enter a name.
Device Type	Select device type.
Device Firmware	Select device firmware. It is recommended to select the latest version.
Machine Driver Package	Set the Machine Driver Package. You can specify the firmware of instruments connected to the device.
Script	Set the script and business logic to run on the device.
Environment Variables	Enter the Environment Variables for the template. See here for usage in scripts.

• Components are instruments such as sensors or other MCUs that are connected to a neqto: Device. They are set on a per template basis.
• Available device firmware changes based on the selected device type. Please confirm the correct device type before saving to prevent harm to devices.

• The order of precedence for Environment Variables from highest to lowest is as follows: Nodes, Templates, Scripts.

Add a Template

1. Go to the "Templates" resource page.
2. In the upper right-hand corner, click the "Add Template" button.
3. Enter in the details of your device.
4. Click "save" at the bottom of the dialogue.

Edit or Delete a Template

1. Go to the "Templates" resource page.
2. Find the template you wish to edit or delete and click the gear icon.

To Edit

1. Edit the necessary details.
2. Click "save" at the bottom of the dialogue.

To Delete

1. Click the "Delete" button in the left-hand bottom corner of the dialogue.
2. Enter the templates name to confirm, then click the "Delete" button.

Trigger Commands on a Template

Via the "Control Center Menu" accessible from the list of Templates, you can quickly send commands to all nodes that belong to a template.

The following commands are supported:

Command	Detail
Custom Message	Send a custom MQTT message to the device.
Reboot	Reboot the device. Rebooting the device will also reload the script.
Reload Script	Download the newest version of the neqto.js script from the cloud and begin executing it.
neqto: Firmware Update	Executes FOTA on the actual neqto: device. The device firmware set in the template will be used. Only official neqto: Firmware can be used.
Machine Driver Update	Executes FOTA on connected sub-devices. Uses the Machine Driver set in the template. Customers can register their own firmwares to set as a Machine Driver. See Machine Driver for more information.
neqto: Firmware Update on Boot	On the device's next boot, the firmware will be downloaded and FOTA will be triggered on the actual neqto: device. The device firmware set in the template will be used.
Machine Driver Update on Boot	On the device's next boot, the firmware will be downloaded and FOTA will be triggered on the connected sub-devices. The Machine Driver set in the template will be used.

Components

Templates also contain components, which define the instruments connected to a device.

Components are defined using the LwM2M Standards.

When registering a component, the following options are available:

The following options apply to the Device Information tab:

Field	Detail
Name	Enter a name.
Note	Enter a description.
Resource	Set a resource. (Type of data)
Object	Set an object. (Type of sensor)
Instance	Set an instance number.（0-9999999999） When a sensor (Object and Resource) are the same, change and set the instance number.
Privacy Mode	Use this if sending personal information.

The below options apply to the Graph Settings tab (Infinitypool customers only):

Field	Detail
Unit	Set the unit of data that will be sent.
Minimum	Specify lower limit to be displayed by graph.
Maximum	Specify upper limit to be displayed by graph.

To add a component

1. Select the desired Template from the Templates list.
2. On that template's dashboard, in the upper-right hand corner of the "Components" section, click "Add Component".
3. Enter the correct settings.
4. Click the "save" button at the bottom of the dialogue.

To edit or delete component

1. From the list of components, click the pencil icon in the row of the component you wish to edit.

To Edit

1. Edit the necessary details.
2. Click "save" at the bottom of the dialogue.

To Delete

1. Click the "Delete" button in the left-hand bottom corner of the dialogue.
2. Enter the components name to confirm, then click the "Delete" button.

Event Notifications

Templates also contain Notifications that can be set when certain events related to a device occur.

To use notifications, you will need an Action.

Based on the event and the level, the action will be triggered.

When registering a notification the following options are available:

Event Type

Type	Detail
User	User messages (From user script)
Engine	neqto: Engine event messages
Battery	Battery status event messages
Custodia	neqto: Custodia notification messages

Event Level

Level	Detail
info	Debug Information etc.
warn	Minor error (Can continue operation)
error	Major error (Cannot continue operation)
fatal	Fatal error

To add a Notification

1. Select the desired Template from the Templates list.
2. On that template's dashboard, in the upper-right hand corner of the "Notification" section, click "Add Notification".
3. Enter the correct settings.
4. Click the "save" button at the bottom of the dialogue.

To edit or delete a Notification

1. From the list of Notifications, click the pencil icon in the row of the component you wish to edit.

To Edit

1. Edit the necessary details.
2. Click "save" at the bottom of the dialogue.

To Delete

1. Click the "Delete" button in the left-hand bottom corner of the dialogue.
2. Enter the Notification's name to confirm, then click the "Delete" button.

• Actions triggered by an event also have access to the following dynamic information as variables.

Variable	Value
{event_type}	Event Type name
{event_level }	Event Level
{event_message}	Event Message

Nodes

Nodes represent your neqto: Engine device in the neqto: Cloud.

Nodes inherit many of their settings through Templates and other features.

Before registering a Node you will need 1 Template and at least 1 Device

Field	Detail
Name	Enter a name.
Note	Enter a description.
Template	Set a template.
Serial ID	Enter the serial ID of the neqto: Bridge.
Environment Variables	Enter the Environment Variables for the node. See here for usage in scripts.

• The order of precedence for Environment Variables from highest to lowest is as follows: Nodes, Templates, Scripts.

Add a Node

To perform batch registration of nodes, refer to Batch registration of nodes on the Batch registration method page of nodes/devices.

1. Go to the "Nodes" resource page.
2. In the upper right-hand corner, click the "Add Node" button.
3. Enter in the details of your node.
4. Click "save" at the bottom of the dialogue.

Edit or Delete a Node

1. Go to the "Nodes" resource page.
2. Find the node you wish to edit or delete and click the gear icon.

To edit

1. Edit the necessary details.
2. Click "save" at the bottom of the dialogue.

To Delete

1. Click the "Delete" button in the left-hand bottom corner of the dialogue.
2. Enter the Nodes name to confirm, then click the "Delete" button.

Trigger Commands on a Node

Via the "Control Center Menu" accessible from the list of Nodes, you can quickly trigger commands on a single node.

The following commands are supported:

Command	Detail
Refresh Node Status	Request device to update its current configuration information to the Node.
Reload Script	Download the newest version of the neqto.js script from the cloud and begin executing it.
Custom Message	Send a custom MQTT message to the device.
Reboot	Reboot the device. Rebooting the device will also reload the script.
neqto: Firmware Update	Executes FOTA on the actual neqto: device. The device firmware set in the template will be used.
Machine Driver Update	Executes FOTA on the connected sub-devices. Uses the Machine Driver set in the template.
neqto: Firmware Update on Boot	On the script's next boot (script download), execute FOTA on the neqto: device. The device firmware set in the template will be used.
Machine Driver Update on Boot	On the script's next boot (script download), execute FOTA on the connected sub-devices. The Machine Driver set in the template will be used.
Get Debug Log	Upload the logs stored on the device to the cloud. The uploaded logs will be displayed in the debug logs area of each node's page. Uploaded logs are stored for 30 days.
Renew Client Certificate	Replace the device's client-side SSL certificate.
Factory Reset	Resets the device to its factory conditions. This will erase all changes made to the device, so remote operation will become impossible. The initial setup procedure must be repeated before it can be used again.

Check the MQTT status of a Node

The MQTT Status icon can be found in the Node Status of a Node and on each Node in the Node list of a Group. The MQTT status of the Node can be determined by the color of the MQTT Status icon, or by hovering over the icon for more details.

Icon	Status	Detail
	disconnected	The device was disconnected normally from neqto: Cloud. Nodes with devices which have not yet connected to the neqto: Cloud also display this status.
	connected	The device is connected normally via MQTT to neqto: Cloud.
	ungraceful	The device disconnected inadvertently from neqto: Cloud. For example, the power supply of the device may have depleted or a network malfunction occurred.

---

Updated: 2021-01-15