Configurator APIs

The device information and the Test Bench configuration are stored in two database tables: the device table and the test case table.

Device Configurations

• URL: /device
• Adding devices: POST method

Request body: list of dictionaries of devices to be added.

Each dictionary must contain these keywords: DevEUI, AppKey, NwkKey, and Region.

Note: AppKey and NwkKey refer to the same value. The name AppKey is used for the LoRaWAN v. 1.0.x specification, and the name NwkKey is used in LoRaWAN v. 1.1.x.

Request body example: 

Adding duplicate devices removes the previous device. Only one DevEui should appear in the database.

• Listing devices: GET method
• Deleting devices: DELETE method

Request body: List of dictionaries of rowid. The rowid can be obtained from the list method.

Request body example: 

[

  {

    "rowid": 2

  }, 

  {

    "rowid": 3

  }

]

If passing all as the body in the DELETE method, all device information will be deleted. For example:

all

Test Case Configurations

Like the device configurations, POST, GET and DELETE are supported.

• URL: /schedule
• Adding a test case: POST method

Request body: List of dictionaries of devices to add.

Each dictionary must have the keywords: DevEui, Cat, SubCat, Criteria, and Parameter. Optional keyword: Config.

Request body example: 

[  

   {  

      "DevEui":"D92426DBD92426DB",

      "Cat":"downlink",

      "SubCat":"timing",

      "Criteria":"count",

      "Parameter":22,

      "Config":{  

         "Step":3,

         "Datr":3

      }

   }

]

• DevEui: the device EUI of the DUT.
• Cat: the category of the test case.
• SubCat: the sub-category of the test case.
• Criteria: Test case termination criteria. All tests support count, some support time. If a test supports the count criterion, it runs for a certain number of uplink packets defined by Parameter. If a test supports the time criterion, the test runs for a certain amount of time defined by Parameter in seconds.
• Parameter: the number of packets with a duration in seconds.
• Config: the optional configuration field. It is only applicable to selected test cases.

• Listing test cases: GET method.
• Deleting test cases: DELETE method.

Request body: List of dictionaries of rowid. The rowid can be obtained from the list method.

Request body example:

[

  {

    "rowid": 2

  }, 

  {

    "rowid": 3

  }

]

If passing all as the body in the DELETE method, all device information will be deleted. For example:

all