Create/Update/Delete Device Type

Navigate to the sidebar menu on the Device Management screen and choose Device Type.

Device Type initial screen enables you to see detailed information about types such as:

  • Name
  • Description
  • Published
  • In use

Note: On Actions that appear in Row actions button: Acces list and Duplicate, please refer to Manage Device Type for more details.

/uploads/device

To successfully create device, you need to clearly define its Type. Type is a mould based on which devices can be provisioned on the platform. It contains all the necessary metadata to fully create a device.

It helps you create a number of identical devices which contain the same type of data.

Create Type

Click Add and a new dialog will appear requiring you to enter:

  • Device type name - a unique name that distinguishes and describes device
  • Description (optional) - tells you what kind of device it is, e.g. temperature
  • Provisioning flow - choose between Standard and WolkSensor - for WolkSensor device
  • Connectivity type - type of connectivity the Platform uses to communicate with your device (HTTP, MQTT)
  • Protocol - format of the message; the available exchange protocols at the moment are: Cayenne, JSONsingle, JSONmulti, JSON and WolkSensor

/uploads/create

Each device can include sensor, actuator and alarm.

The next step is to add a specific description of sensors, actuators or alarms in accordance with the device you are adding.

Note: All sensors, actuators or alarms created can be deleted later in the process.

Add Sensors

Click Add and within drop-down menu select Sensor

/uploads/add

Enter the following:

  • Sensor name - descriptive sensor name, e.g. Temperature sensor 1
  • Sensor reference - unique identifier of a sensor on a device used as a contract with the Platform when collecting sensor data, meaning that device has to be configured to send the data to the Platform with the same sensor reference, e.g. T
  • Reading type - represents sensor’s physical property type. You can select reading type from a drop-down list, previously created in the Settings module
  • Unit - defines a unit for selected reading type e.g. °C, mbar, %

For more information on the Reading type feature, please refer to Reading Types/Measurement Units/Unit Conversions section of this user guide.

/uploads/add

  • Click Save to finalise the process

Add Actuators

Actuator allows user to switch devices on and off, set up a value of a feed, or send an actuation value to a device.

Click Add and within drop-down menu select Actuator.

Enter the following:

  • Actuator name - descriptive actuator name, e.g. Air Condition Switch
  • Actuator reference - unique ID of an actuator, used as a contract with the Platform when sending commands back to the device, meaning that the physical actuator has to be configured to use the same actuator reference, e.g. SW
  • Reading type - e.g. switch/count for different types of actuators, (for example, an ON/OFF switch that may control A/C)

Note: Reading type for actuator is marked

/uploads/add

  • Click Save to finalise the process

Note: It is possible to add all the actuators that are already on a device.

Add Alarms

Alarm represents an occurrence of an event detected by a device. This way, device alerts the Platform of some alarming situation (problem or specific device condition).

For example, smoke detection device will send smoke detected alarm when a certain level of smoke is detected, suggesting the possibility of fire.
This means that the device is responsible for detecting such events and signalling it to the Platform.
The Platform will perform actions, upon receiving an alarming event, such as sending notifications to users or performing custom business rules.

Follow the same procedure as described above and enter the following:

  • Name - descriptive, recognisable name, e.g. High Temperature
  • Reference - unique identifier of an alarm on a device, e.g. HT
  • Message - short notification of a problem that occurred, e.g. Temperature is above 10°C

/uploads/add

After clicking the Save button you will finalise the process, and the type will be listed on the Device type screen.

/uploads/create

Add Configuration

Apart from adding all the sensors, actuators, and alarms, you can remotely configure the device by following the same procedure.
Configurations consist of set of commands sent to the embedded software e.g. changing heartbeat or WiFi credentials.
A device has to support the use of commands for specific parameters, otherwise, this feature cannot be used.

Click Add and within drop-down menu select Configuration. Start adding configuration parameters:

  • Parameter name
  • Reference - unique parameter identifier for a device used as a contract with the Platform when exchanging data, meaning that the device has to be configured to send the data with the same parameter reference, e.g. T
  • Data type - defines the type of data coming from the device; select one of the following: BOOLEAN, NUMERIC and STRING depending on the type of data
  • Data size - represents the number of separated data values packed together and coming from the device in one message; if data size is more than 1, delimiter is used (a symbol used to separate reading values, e.g. comma (,))
  • Minimum - value used for numeric data type validation only; defines minimum valid value
  • Maximum - value used for numeric data type validation only; defines maximum valid value

/uploads/configuration-2.png

  • Click Save to finalise the process and your device configuration is created

Add Attributes

Attribute provides additional information about device (e.g. serial number of device, MAC address)

  • Click Add and within drop-down menu select Attribute

Enter the following:

  • Attribute name
  • Choose type - String, Numeric or Boolean

For String type, you can provide Regex - a sequence of characters that define a search pattern.

If you check Required box, an attribute will be added in the process of creating a device template

  • Click Save to finalise the process

/uploads/add

Now you have created your device type.

Edit/Update Type

Updating device type means you can update: name, description, device type and protocol.

Device type can be updated only if there are no devices that are associated with it (If created device is based on that type).

  • Select and click one of the existing device types
  • Edit device type will appear
  • Update the type
  • Click the Update button

/uploads/update

Note: You can update device type only if it’s not in use.

Delete Type

  • Select one of the existing types
  • Click Delete

/uploads/delete

  • Confirm the action to finalise the process