Device Management

<?php
/*
File: firmware_appl_get.php

This example shows how to get a list of available application firmwares.

The returned JSON data is parsed and the firmware name and version is printed.

Usage:

    php firmware_appl_get.php LOGINFILE

Example:

    php firmware_appl_get.php mylogin.json
*/

require_once __DIR__ . "/../../tools/lib/rest_api_lib.php";

// Read config file with user credentials
if ($argc == 2)
{
  $login_config_file = $argv[1];

  // Read login file
  $config_path = get_absolute_path($login_config_file);
  rest_api_read_login_config($config_path);
}
else
{
  echo "USAGE" . PHP_EOL;
  echo "php firmware_appl_get.php LOGINFILE" . PHP_EOL;
  echo "EXAMPLE:" . PHP_EOL;
  echo "php firmware_appl_get.php mylogin.json" . PHP_EOL;
  die();
}

// Get a list of firmware objects
$tenant_id = rest_api_tenant_get_id();
$response_json = rest_api_get_expand("/tenant/{$tenant_id}/firmware_appl");
$firmware_array = json_decode($response_json);

// Print firmwares
echo "AVAILABLE APPLICATION FIRMWARES:\n";
foreach ($firmware_array as $firmware)
{
  echo "{$firmware->name} {$firmware->info->version} {$firmware->info->microcontroller}" . PHP_EOL;
}

<?php
/*
File: firmware_appl_create.php

This example uses the library file device_lib.php to create a new
application firmware asset.

Usage:

    php firmware_appl_create.php LOGINFILE FIRMWARENAME MICROCONTROLLER VERSION DESCRIPTION FIRMWAREPATH

Example:

    php firmware_appl_create.php mylogin.json BlinkTest ATmega328P "100.0.0.1" "LED Blink Test" Blink.ino.hex
*/

require_once __DIR__ . "/../../tools/lib/rest_api_lib.php";
require_once __DIR__ . "/../../tools/lib/device_lib.php";

// Set command params and read login config file
if ($argc == 7)
{
  $login_config_file        = $argv[1]; // absolute or relative path to config file
  $firmware_name            = $argv[2]; // firmware name
  $firmware_microcontroller = $argv[3]; // microcontroller name
  $firmware_version         = $argv[4]; // firmware version
  $firmware_description     = $argv[5]; // firmware description
  $firmware_file            = $argv[6]; // absolute or relative path of firmware file

  // Read login file
  $config_path = get_absolute_path($login_config_file);
  rest_api_read_login_config($config_path);
}
else
{
  echo "USAGE:" . PHP_EOL;
  echo "php firmware_appl_create.php LOGINFILE FIRMWARENAME MICROCONTROLLER VERSION DESCRIPTION FIRMWAREPATH" . PHP_EOL;
  echo "EXAMPLE:" . PHP_EOL;
  echo "php firmware_appl_create.php mylogin.json \"BlinkTest\" \"ATmega328P\" \"100.0.0.1\" \"LED Blink Test\" Blink.ino.hex" . PHP_EOL;
  die();
}

// Get tenant id
$tenant_id = rest_api_tenant_get_id();

// Get absolute path to application firmware file
$firmware_absolute_path = get_absolute_path($firmware_file);

$response = firmware_appl_create(
  $tenant_id,
  $firmware_name,
  $firmware_microcontroller,
  $firmware_version,
  $firmware_description,
  $firmware_absolute_path);

// Check response
if (201 === rest_api_get_http_response_code())
{
  $firmware_name = $response;
  echo "FIRMWARE CREATED: {$firmware_name}" . PHP_EOL;
}
else
{
  echo "ERROR: COULD NOT CREATE FIRMWARE" . PHP_EOL;
  if ($response)
  {
    echo $response . PHP_EOL;
  }
  if (rest_api_get_curl_errno() > 0)
  {
    echo "CURL ERROR: " . rest_api_get_curl_error() . " " . rest_api_get_curl_errno() . PHP_EOL;
  }
}

<?php
/*
File: firmware_appl_delete.php

This example shows how to delete an application firmware entry
using the library file device_lib.php.

Usage:

    php firmware_appl_delete.php LOGINFILE FIRMWARENAME

Example:

  php firmware_appl_delete.php mylogin.json BlinkTest
*/

require_once __DIR__ . "/../../tools/lib/rest_api_lib.php";
require_once __DIR__ . "/../../tools/lib/device_lib.php";

// Set command params and read login config file
if ($argc == 3)
{
  $login_config_file = $argv[1]; // absolute or relative path to config file
  $firmware_name     = $argv[2]; // firmware name is the id of the firmware

  // Read login file
  $config_path = get_absolute_path($login_config_file);
  rest_api_read_login_config($config_path);
}
else
{
  echo "USAGE:" . PHP_EOL;
  echo "php firmware_appl_delete.php LOGINFILE FIRMWARENAME" . PHP_EOL;
  echo "EXAMPLE:" . PHP_EOL;
  echo "php firmware_appl_delete.php mylogin.json \"BlinkTest\"" . PHP_EOL;
  die();
}

// Get tenant id
$tenant_id = rest_api_tenant_get_id();

// Make request to delete the firmware object
$response = firmware_appl_delete($tenant_id, $firmware_name);

// Check response
if (204 === rest_api_get_http_response_code())
{
  echo "FIRMWARE DELETED: {$firmware_name}" . PHP_EOL;
}
else
{
  echo "ERROR: COULD NOT DELETE FIRMWARE" . PHP_EOL;
  echo $response . PHP_EOL;
}

<?php
/*
File: firmware_core_get.php

This example shows how to request a list available core firmwares.

Returned JSON data is printed in raw unparsed format.

Usage:

    php firmware_core_get.php LOGINFILE

Example:

    php firmware_core_get.php mylogin.json
*/

require_once __DIR__ . "/../../tools/lib/rest_api_lib.php";

// Read config file with user credentials
if ($argc == 2)
{
  $login_config_file = $argv[1];

  // Read login file
  $config_path = get_absolute_path($login_config_file);
  rest_api_read_login_config($config_path);
}
else
{
  echo "USAGE:" . PHP_EOL;
  echo "php firmware_core_get.php LOGINFILE" . PHP_EOL;
  echo "EXAMPLE:" . PHP_EOL;
  echo "php firmware_core_get.php mylogin.json" . PHP_EOL;
  die();
}

// Get a list of core firmwares
$response = rest_api_get("/firmware_core");

// Also try:
//$response = rest_api_get_expand("/firmware_core");

echo $response . PHP_EOL;

<?php
/*
File: device_get.php

This example uses a GET request to obtain info about the
first available device.

The returned JSON data is parsed and printed.

Usage:

    php device_get.php LOGINFILE

Example:

    php device_get.php mylogin.json
*/

require_once __DIR__ . "/../../tools/lib/rest_api_lib.php";

// Read config file with user credentials
if ($argc == 2)
{
  $login_config_file = $argv[1];
  $config_path = get_absolute_path($login_config_file);
  rest_api_read_login_config($config_path);
}
else
{
  echo "USAGE:" . PHP_EOL;
  echo "php device_get.php LOGINFILE" . PHP_EOL;
  echo "EXAMPLE:" . PHP_EOL;
  echo "php device_get.php mylogin.json" . PHP_EOL;
  die();
}

// Get id:s of all devices (returns JSON array of ids)
$tenant_id = rest_api_tenant_get_id();
$response = rest_api_get("/tenant/{$tenant_id}/device");

// Convert JSON to PHP array
$device_array = json_decode($response);

// Print device info for each device
foreach ($device_array as $device_id)
{
  // Get device data (returns JSON object)
  $response = rest_api_get_expand("/tenant/{$tenant_id}/device/{$device_id}");

  // Convert JSON to PHP object
  $device_obj = json_decode($response);

  // Print selected device data
  $date = (null != $device_obj->info->ts_comms)
    ? (DateTime::createFromFormat('U', $device_obj->info->ts_comms))->format("Y-m-d H:i:s")
    : "Unknown";

  echo "-----------------------------------" . PHP_EOL;
  echo "DEVICE ID       : {$device_obj->id}" . PHP_EOL;
  echo "DEVICE NAME     : {$device_obj->keys->name}" . PHP_EOL;
  echo "LAST SEEN       : {$date}" . PHP_EOL;

  // Print data about first microcontroller
  if (null != $device_obj->keys->microcontroller)
  {
    $microcontroller = $device_obj->keys->microcontroller[0];
    echo "MICROCONTROLLER =>" . PHP_EOL;
    echo "  NAME          : {$microcontroller->name}" . PHP_EOL;
    echo "  IDENTIFIER    : {$microcontroller->identifier}" . PHP_EOL;
    echo "  FIRMWARE_APPL : {$microcontroller->firmware_appl}" . PHP_EOL;
  }
}

// It is considered best practice to not close the <?php tag
// in a PHP-only file.

<?php
/*
File: device_create.php

This script is an example of how to automate device creation.

The script takes the device name as input and creates a device
with that name.

Usage:

    php device_create.php LOGINFILE DEVICENAME

Example:

    php device_create.php mylogin.json "TEST DEVICE"

Note that all device properties execpt for the device name are
hard-coded into the script. An alternative solution is to provide
a JSON config file with the device data.

You can use this example as an inspiration for production scripts.
*/

require_once __DIR__ . "/../../tools/lib/rest_api_lib.php";
require_once __DIR__ . "/../../tools/lib/device_lib.php";

// Read config file with user credentials
if ($argc == 3)
{
  $login_config_file = $argv[1];
  $device_name       = $argv[2];

  // Read login file
  $config_path = get_absolute_path($login_config_file);
  rest_api_read_login_config($config_path);
}
else
{
  echo "USAGE:" . PHP_EOL;
  echo "php device_create.php LOGINFILE DEVICENAME" . PHP_EOL;
  echo "EXAMPLE:" . PHP_EOL;
  echo "php device_create.php mylogin.json \"Test Device\"" . PHP_EOL;
  die();
}

// Get tenant id
$tenant_id = rest_api_tenant_get_id();

// TODO: Change the device settings below as needed,
// or add command-line paramemters to the script.

// Device settings

// Network settings
$network_settings           = new stdClass();
$network_settings->SSID     = "MY WIFI NAME";
$network_settings->username = ""; // Must be set even if empty
$network_settings->password = "MY PASSWORD";

// Static GPS position (may be set to null)
$gps_settings               = new stdClass();
$gps_settings->latitude     = "59.916675";
$gps_settings->longitude    = "18.950068";

// Alternatively, static GPS position may be set to null
//$gps_settings = null;

$response = device_create(
  $tenant_id,
  $device_name,                       // device_name,
  "MKR WiFi 1010",                    // modem_name,
  "RIoT Fusion Shield - Arduino UNO", // hardware_interface_name,
  "1_0_0_16-riot-MKRWIFI1010",        // firmware_core_name,
  "WiFi",                             // network_type,
  $network_settings,                  // network_settings
  $gps_settings                       // gps_settings
);

if (201 !== rest_api_get_http_response_code())
{
  echo "ERROR: COULD NOT CREATE DEVICE" . PHP_EOL;
  echo $response . PHP_EOL;
}
else
{
  echo "SUCCESS: DEVICE CREATED WITH ID: {$response}" . PHP_EOL;
}

<?php
/*
File: device_delete.php

This script shows an example of how to delete a device.

Usage:

    php device_delete.php LOGINFILE DEVICENAME

Example:

    php device_delete.php mylogin.json "Test Device"

The script could easily be modified to take a device id as
parameter instead of the device name.
*/

require_once __DIR__ . "/../../tools/lib/rest_api_lib.php";
require_once __DIR__ . "/../../tools/lib/device_lib.php";

// Set command params and read login config file
if ($argc == 3)
{
  $login_config_file = $argv[1]; // absolute or relative path to config file
  $device_name       = $argv[2]; // name of device to delete

  // Read login file
  $config_path = get_absolute_path($login_config_file);
  rest_api_read_login_config($config_path);
}
else
{
  echo "USAGE:" . PHP_EOL;
  echo "php device_delete.php LOGINFILE DEVICENAME" . PHP_EOL;
  echo "EXAMPLE:" . PHP_EOL;
  echo "php device_delete.php mylogin.json \"Test Device\"" . PHP_EOL;
  die();
}

// Get tenant id
$tenant_id = rest_api_tenant_get_id();

// Get the device with trhe given name
$device = device_find($tenant_id, $device_name);
if (false === $device)
{
  echo "ERROR: COULD NOT FIND DEVICE WITH NAME: " . $device_name . PHP_EOL;
  die();
}

// Delete the device
$response = device_delete($tenant_id, $device->id);

// Check response
if (204 === rest_api_get_http_response_code())
{
  echo "DEVICE DELETED: {$device_name}" . PHP_EOL;
}
else
{
  echo "ERROR: COULD NOT DELETE DEVICE" . PHP_EOL;
  echo $response . PHP_EOL;
}