Devices

The Devices modules allows the configuration of all IOT devices connected to the IOT Platform. Features include: Device Configuration, Data transmission analysis, Analytics, but also downlink messages.

In general, it is not necessary to create new Devices from the Device module interface. When a Device Communication Channel (or more) is created in the Settings Module, devices will be automatically created and activated. But depending on the type of device, some additional configurations will be required.

Managing Device Status and Deletion

Device Status

• Active Devices
  • Payload Decoding and Storage: Only active devices will decode and store payload data exchanged with the IoT platform.
  • Measurement Updates: New measurements will be continuously added for active devices.

• New or Archived Devices
  • Availability: New or archived devices will remain available in your device list.
  • Measurement Updates: No new measurements will be added for these devices.
  • Reactivation: You can return new or archived devices to active status at any time to resume measurement updates.

Deleting a Device

• Deletion Process
  • Deprovisioning: When you delete a device, it will be deprovisioned from the network server.
  • Measurement Removal: All measurements associated with the device will be permanently removed.

Important Notes: - Ensure that you no longer need the device or its measurements before deleting it, as this action is irreversible. - Regularly review your device list to manage the status of your devices effectively.

By default, the list of devices is filtered to ‘active’ devices only. If you can't find your device, check the other states using the combo boxes available at the top/left of the list.

The concept of Device Type is the most important characteristic of a device. Device Type defines how to decode payloads received from Devices. The IOT Platform supports native more than 650 device types.

Once a device is created (usually automatically), you must go and define the right Device Type, as it is usually not possible to retrieve this information automatically.

If you device doesn't have a pre-defined Device Type, there are 2 options:

• Develop your own decode in the Device Type module, give it a name, then once it is ready, come back to the Devices module and set this device type for your device.
• Contact us: support@iotfactory.eu

Payload decoding will start from all payloads received after the Device Type is configured correctly. Previous payloads won't be decoded.

The Device Module provides a comprehensive list of all 'active' devices.

Search and Filters

Utilize the search and filter options to refine the device list according to your needs. You can filter the list by:

1. Status: New, Active, Archived, Sahared.
2. Device Type: vs121, am307, manual entry, etc.
3. Device State: Online, timed out, etc.

Enter specific keywords in the search field to find particular devices.

Additionally, you can switch to tree mode for a hierarchical representation of devices classified by type, status, and more.

Column Display

By default, a set of columns is displayed. To customize the visible columns, click on the ≡ icon. For example, you can choose to display the rssi, snr, battery level. It is useful for identifying devices whose batteries need replacing.

Export Options You can export the device list in PDF or CSV format for further analysis or record-keeping.

To edit a device and change its settings, follow these steps:

Access Edit Mode: Click on the “pen” icon located at the top-right corner of the Device Details window.

Editable Fields

1. Name: Enter any name you want to give to your device.
2. Type: Select the Device Type from the available options.
3. Status: Set the status to 'active' if you want to receive and decode payloads.
4. Timeout: Specify a value in minutes after which you want to trigger an alert. To enable alerts, create a “Timeout” rule. See Rules for details.
5. Spent Time: Define a measure, decoded from the payload, that indicates a state change between two values (e.g., 0 or 1). This measure will be used to track the time spent in each state. The spent time and state changes can be reported using the state widget in dashboards and are visible in the Timeline and States tabs of the MAP module.
6. Plan: Attach a plan to the device. This feature is in the roadmap.
7. Brand, Model, & Notes: Enter any relevant free text information.
8. Tags: Use tags to classify devices based on various categories. Tags can be utilized in:
   1. Tag-based dashboard device or asset selector
   2. Rules to trigger alerts for devices with specific tags
   3. Map: Search devices by tag

Device Status Indicators

Devices are listed with a color bullet indicating their state:

1. Blue: Data received within the timeout period (default is 24 hours if not set).
2. Yellow: No data received for more than 24 hours (or more than the configured timeout).
3. Black: No data ever received.
4. Green: Device is “Working/Running”.
5. Red: Device is “Idle/Stopped”.

Device Tabs

The Device Tabs provide a comprehensive overview and management interface for each device. Here's what each tab offers:

1. Info Tab
   • Device Settings: View and manage all settings related to the device.
   • Latest Measurement: Access the most recent integrated measurement, which is the result of decoding.
2. Data Tab
   • Measurement Access: View all measurements recorded by the device, organized by date.
3. Analytics Tab
   • Standard Charts: Visualize data through standard charts for better analysis and insights.
4. Map Tab
   • Current Location: View the current location of the device.
   • Position History: Track the history of positions for the device.
   • Static Location: Set a fixed location for the device if needed.
5. Journal Tab
   • Alerts and Notes: Access a list of all alerts and notes related to the device for better tracking and management.
6. CMD Tab
   • Send Commands: Send commands (downlink) to the device. This feature depends on the capabilities of the device.
7. Assets Tab
   • Associated Assets: View the list of assets to which the device is attached.
8. Shared Tab
   • Shared Solutions: List the solutions in which the device is shared, allowing for collaborative management.

Important Notes: - Ensure you have the necessary permissions to access and modify settings in each tab. - Regularly review the information in each tab to maintain optimal device performance and management.

Device Icon

It is possible to change the icon and the color of the icon. When editing a device, click on the existing icon. A form will allow you to change the icon and its color.

Only for manual entry device type. Click on the “data” icon located at the top-right corner of the Device Details window.

To add a new device, follow these steps to fill in the form with the required parameters:

1. Enter a Device ID: Provide the device identifier.
2. Enter a Name: Give a name to the device for easy identification.
3. Select a Device Type: Choose the device type from the available list of device types.
4. Select a Network Server: If the device communicates via a network server, select one of the network servers configured in your account settings.
5. Enter or Select Data According to the Selected Network Server: Fill in the necessary information based on the network server you selected.
6. Enter the Brand (Optional): Provide the brand of the device if available.
7. Enter the Model (Optional): Specify the model of the device if available.
8. Enter a Timeout: Set a timeout value. This value will be used to highlight the device when it is in timeout and will change its state.
9. Enter or Select Tags (Optional): Tags are useful as metadata. Add relevant tags to help with organization and filtering.

Important Notes: - Ensure all mandatory fields are filled accurately. - Optional fields can be left blank but are recommended for better device management. - Review all entered information before submitting the form to avoid errors.

A device that is created but not assigned to an account can be acquired by the owner of that account.

The Device Import Module is designed to streamline the creation of multiple devices of the same type by importing a CSV file. Follow these steps to successfully import your devices:

• Step 1: Define Import Parameters
  1. Select Device Type: Choose the type of device you want to import.
  2. Set Initial State: Set the initial state of the devices to either 'new' or 'active'.
  3. Select LoRa Network Server Type: Choose the type of LoRa network server.
  4. Select Network Server: Specify the network server to be used.
  5. Select Application Identifier: Choose the application identifier.
  6. Select Device Profile Identifier: Specify the device profile identifier.

• Step 2: Generate and Fill CSV Template
  1. Download CSV Template: Click to download the CSV template file.
  2. Fill in the CSV File: Populate the CSV file with the required device information.

• Step 3: Import Devices
  1. Select CSV File: Choose the filled CSV file from your computer.
  2. Import Devices: Click the 'Import' button to upload the file.

Important Note: When the file is imported, the module retains the parameters defined in Step 1. These parameters will be used to configure the devices. Please ensure that the entire process is completed in a single session to avoid any configuration issues.