====== Software interface ====== There are several software interfaces available to monitor the status of the u.RECS system. These are the Management Web****GUI and a REST API providing XML based monitoring and management functionality. ===== Management WebGUI ===== The Management Web****GUI is established on every u.RECS unit. Accessible by any known browser on the assigned IP address and the default port 443. The following views are dependent on the device and assembly. In general these symbols have the following meaning on every page: \\ |{{ :documentation:statusok.png?nolink |}}|Everything is OK. Also indicated by a green line in a graph.| |{{ :documentation:statuswarning.png?nolink |}} |Warnung. Something is wrong, but the system is still fully functional. The system has to be checked so the problem doesn't get worse. Indicated by a yellow line in a graph.| |{{ :documentation:statuscritical.png?nolink |}} |Critical Error. The system must be checked immediately and maybe has to be shut down to prevent hardware damage. indicated by a red line in a graph.| ==== Management ==== {{ :doc_urecs:u.recs_home.png?direct&500 |u.RECS Management Overview}} ==== Settings ==== {{ :doc_urecs:u.recs_settings.png?direct&500 |u.RECS Settings}} ===== REST API ===== ==== Access ==== The u.RECS Management API is accessible via the IP-Address or the hostname of the u.RECS. The basic URL of the API has the format ''https://[ip-address]/REST/[system/baseboard/node]'' with ''http'' or ''https'', depending on your configuration. Therefore, please check the following URL as an example: https://192.168.0.50/REST/system Accessing the REST API requires HTTP Basic authentication. The password of the admin account can be changed in the Settings page. ==== Components ==== The u.RECS Management API makes all hardware components available as XML trees. The following components are supported by the API: \\ ^ Attribute ^ Description ^ |''node'' | A single node | |''baseboard'' | Overview about the baseboard that can be equipped with 1 or 2 nodes | |''system'' | Overview of the whole system (baseboard + node) | |''lorawan'' | Enables communication to LoRaWAN application servers | Many resources also return lists of components. These are named according to the scheme List (e.g. nodeList) and contain the elements of the list. === Node === Example XML:



  RCU_0_BB_1_0
  RCU_0_BB_1_1



  
    RCU_0_BB_1_0
    RCU_0_BB_1_1

==== Resources ==== The resources are split into monitoring resources (for pure information gathering) and management resources (for changing the system configuration or state). === Monitoring === For monitoring the following resources are available: \\ ^ Attribute ^ Description ^ HTTP Method ^ |''/node'' |Returns a nodeList with all nodes of the system|GET| |''/baseboard'' |Returns an overview of the baseboard including the installed nodes|GET| |''/system'' |Returns an overview of the baseboard and all nodes. It includes all information of /baseboard and /node which makes it easy to get the whole system status with one REST call.|GET| === Management === The management of individual components can be found under the "manage" path of the component. \\ ^ Attribute ^ Description ^ HTTP method ^ Parameter ^ |''/node/{node_id}/manage/power_on'' |Turns on the node with the given ID and returns updated node XML|POST| | |''/node/{node_id}/manage/power_off'' |Turns off the node with the given ID and returns updated node XML|POST| | |''/node/{node_id}/manage/reset'' |Resets the node with the given ID and returns updated node XML|POST| | |''/node/{node_id}/manage/select_kvm'' |Switches the KVM port of the RECS^(r)%%|%%Box Computing Unit containing the node to the node with the given ID and returns updated node XML|PUT| | |''/rcu/{rcu_id}/manage/set_fans'' |Sets the overall fan speed of the RCU with the given ID and returns the curent status of the RCU|PUT|percent={value}| === LoRaWAN API === The LoRaWAN interface allows up and downlink connections to an application server. Payload can be scheduled and collected by interfacing the Management REST API. ^ Attribute ^ Description ^ HTTP method ^ |''/lorawan/uplink/{fport}'' |Schedules uplink packet to the application endpoint for the specified fport|POST| |''/lorawan/downlink/{fport}'' |Responds with incoming downlink LoRaWAN messages for the specified fport|GET| Example HTTP Body on GET request:


  {custom lorawan payload}
  {timestamp}

Example HTTP Body on POST request:


  {custom lorawan payload}

==== FPort ==== The Frame Port (fport) separates different communication parties on the API, and functions as an identifyer for the message sender / reciever. When using the REST API, you are free to choose a value between 2 - 223. FPort 1 is reserved for the management controller. === Errors === Information about the success or failure of management requests are returned via HTTP status codes. Please have a look at [[http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html|RFC2616]] for an overview about the defined HTTP status codes. ==== LoRa Message ==== The u.RECS supports upstream and downstream LoRa messages to [[https://www.thethingsnetwork.org/|The Things Network (TTN)]]. The following table gives the LoRa message meaning of version 0. All system related management communication (excluding the REST API) uses **FPort 1**. Upstream message payload layout: ^ Byte(s) ^ Description ^ Unit ^ Data type ^ |0 | u.RECS Lora Message-Version | - | Byte | |1 | Node Info Smarc/Jetson, Bits: present_smarc / present_jetson / on_smarc / on_jetson | - | 2 x 2 Bits | |2 | Regulators temperature: | °C | Byte (-127..+127) | |3 | Ambient temperature: | °C | Byte (-127..+127) | |4-5 | System fan 1: | RPM | Unsigned Short (0..65535) | |6-7 | System fan 2: | RPM | Unsigned Short (0..65535) | |8-9 | Smarc Power Usage: | mW | Unsigned Short (0..65535) | |10-11 | Jetson Power Usage: | mW | Unsigned Short (0..65535) | |12-13 | u.RECS Power Usage: | mW | Unsigned Short (0..65535) | |14-15 | USB Power Usage: | mW | Unsigned Short (0..65535) | |16-17 | mPCIe Power Usage: | mW | Unsigned Short (0..65535) | |18-19 | M.2 Power Usage: | mW | Unsigned Short (0..65535) | |20-21 | Ethernet Switch Power Usage: | mW | Unsigned Short (0..65535) | |22-23 | PoE Eth Port 1 Power Usage: | mW | Unsigned Short (0..65535) | |24-25 | PoE Eth Port 2 Power Usage: | mW | Unsigned Short (0..65535) | |26 | PoE Status Port 1 | - (see below) | Byte | |27 | PoE Status Port 2 | - (see below) | Byte | The u.RECS supports basic control functions over LoRaWAN. Downstream message payloads: **Change power state for node:** ^ Byte(s) ^ Description ^ Unit ^ Data type ^ |0 | Lora Message-Version | - | Byte | |1 | Node ID | - | Byte | |2 | LoRa Command (0x01 = ON, 0x02 = OFF, 0x03 = RESET) | - | Byte | ==== PoE status decoder ==== Here is some C-Code to decode the PoE Status:


PoE Status Bytes:
switch (status & 0xF) {
  case 0: ret = "Detection unknown"; break;
  case 1: ret = "Short circuit"; break;
  case 2: ret = "Capacitive"; break;
  case 3: ret = "RLOW"; break;
  case 4: ret = "RGOOD"; break;
  case 5: ret = "RHIGH"; break;
  case 6: ret = "Open circuit"; break;
  case 7: ret = "PSE to PSE"; break;
  case 15: ret = "MOSFET fault"; break;
}

if ((status & 0xF) == 4) { // RGOOD
  switch ((status >> 4) & 0xF) {
    case 0: ret += ", class unknown"; break;
    case 1: ret += ", class 1"; break;
    case 2: ret += ", class 2"; break;
    case 3: ret += ", class 3"; break;
    case 4: ret += ", class 4"; break;
    case 6: ret += ", class 0"; break;
    case 7: ret += ", overcurrent"; break;
    case 8: ret += ", class 5 4P single signature"; break;
    case 12: ret += ", class 4 type 1 limited"; break;
    case 13: ret += ", class 5 legacy"; break;
    case 15: ret += ", class mismatch"; break;
}