Managing custom drivers

A custom driver is an editable driver that decodes payloads, created by the user in the ThingPark X IoT Flow interface. The custom driver is opposed to the built-in system drivers which are directly imported from the catalog of drivers.

For more information about built-in drivers, see Managing catalogs.

Creating a custom driver

1. In the left menu, click Drivers.

   -> You are redirected to ThingPark X IoT Flow interface.

2. Click ADD DRIVER.

3. In the JS editor, implement the following methods:

   1. decodeUplink.

   2. encodeDownlink.

   3. decodeDownlink.

4. Enter the required information as follow:

   

5. Click Create.

   -> Your custom driver has been successfully created. The driver information window opens.

Viewing custom driver details

You can view custom driver details by searching drivers or by listing drivers.

Searching custom drivers

1. In Drivers, type the driver's name.

2. Click the driver you searched.

   -> The driver information window opens.

Listing custom drivers

1. In Drivers, click Custom to list all custom drivers.

   -> All custom drivers are listed.

2. Click any custom driver.

   -> The driver information window opens.

Duplicating a custom driver

1. In the driver information window, click ..., then Duplicate.

2. The JS code implemented in the custom driver used for duplicating is automatically implemented in the duplicated driver.

3. Enter the required information as in Creating a custom driver.

4. Click Create.

   -> Your duplicated driver has been successfully created.

Updating a custom driver

You can update the version of your custom driver.

1. In the driver information window, click ..., then Edit.

2. Modify the JS code to add a feature or fix a bug.

3. Select the purpose of your modification by following this table:

   Purpose of the modification	Older version	New version
   Fix a bug	1.0.0	1.0.1
   Add a feature without breaking changes	1.0.0	1.1.0
   Add a feature with breaking changes	1.0.0	2.0.0

4. Click Update.

   -> A warning window appears

5. Click Confirm.

   -> Your custom driver has been successfully updated.

Deleting a custom driver

1. In the driver information window, click ..., then Remove.

2. Click Delete.

   -> A deletion note appears. Your custom driver has been successfully deleted.