meta data for this page
  •  

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
doc_urecs:software_interface [2023/12/04 09:58] – [LoRa Message] fundoc_urecs:software_interface [2024/06/06 13:04] (current) – vor
Line 53: Line 53:
   <node maxPowerUsage="26" baseboardPosition="0" architecture="unknown (SMARC)" baseboardId="RCU_0_BB_1" voltage="5.64"    <node maxPowerUsage="26" baseboardPosition="0" architecture="unknown (SMARC)" baseboardId="RCU_0_BB_1" voltage="5.64" 
     actualNodePowerUsage="2.8" actualPowerUsage="2.8" state="0" lastPowerState="0" defaultPowerState="0"      actualNodePowerUsage="2.8" actualPowerUsage="2.8" state="0" lastPowerState="0" defaultPowerState="0" 
-    rcuId="RCU_0" health="OK" lastSensorUpdate="1369" id="RCU_0_BB_1_0" present="true" bootDevice="0"/>+    rcuId="RCU_0" health="OK" lastSensorUpdate="1369" id="RCU_0_BB_1_0" present="true" bootDevice="0" uartPort="0" forceRecovery="false"/>
   <node maxPowerUsage="27" baseboardPosition="1" architecture="ARM + iGPU" baseboardId="RCU_0_BB_1" voltage="5.64"    <node maxPowerUsage="27" baseboardPosition="1" architecture="ARM + iGPU" baseboardId="RCU_0_BB_1" voltage="5.64" 
     actualNodePowerUsage="2.8" actualPowerUsage="2.8" state="0" lastPowerState="0" defaultPowerState="0"      actualNodePowerUsage="2.8" actualPowerUsage="2.8" state="0" lastPowerState="0" defaultPowerState="0" 
Line 80: Line 80:
 |''mpciePresent'' |mPCIe card is plugged in and detected|-|Boolean| |''mpciePresent'' |mPCIe card is plugged in and detected|-|Boolean|
 |''forceRecovery'' |Force Recovery pin is pulled high (only for Nvidia Jetson)|-|Boolean| |''forceRecovery'' |Force Recovery pin is pulled high (only for Nvidia Jetson)|-|Boolean|
 +|''uartPort'' |Number of the UART port which is connected to the USB-C Serial Port|-|Integer|
  
 In accordance to the component node the API offers nodeList which returns multiple instances of node. In accordance to the component node the API offers nodeList which returns multiple instances of node.
Line 156: Line 157:
     <node maxPowerUsage="26" baseboardPosition="0" architecture="unknown (SMARC)" baseboardId="RCU_0_BB_1" voltage="5.64"      <node maxPowerUsage="26" baseboardPosition="0" architecture="unknown (SMARC)" baseboardId="RCU_0_BB_1" voltage="5.64" 
       actualNodePowerUsage="2.8" actualPowerUsage="2.8" state="0" lastPowerState="0" defaultPowerState="0" rcuId="RCU_0"        actualNodePowerUsage="2.8" actualPowerUsage="2.8" state="0" lastPowerState="0" defaultPowerState="0" rcuId="RCU_0" 
-      health="OK" lastSensorUpdate="1403" id="RCU_0_BB_1_0" present="true" bootDevice="0"/>+      health="OK" lastSensorUpdate="1403" id="RCU_0_BB_1_0" present="true" bootDevice="0" forceRecovery="false"/>
     <node maxPowerUsage="27" baseboardPosition="1" architecture="ARM + iGPU" baseboardId="RCU_0_BB_1" voltage="5.64"      <node maxPowerUsage="27" baseboardPosition="1" architecture="ARM + iGPU" baseboardId="RCU_0_BB_1" voltage="5.64" 
       actualNodePowerUsage="2.8" actualPowerUsage="2.8" state="0" lastPowerState="0" defaultPowerState="0" rcuId="RCU_0"        actualNodePowerUsage="2.8" actualPowerUsage="2.8" state="0" lastPowerState="0" defaultPowerState="0" rcuId="RCU_0" 
Line 187: Line 188:
 |''/node/{node_id}/manage/select_kvm'' |Switches the KVM port of the RECS<sup>(r)</sup>%%|%%Box Computing Unit containing the node to the node with the given ID and returns updated node XML|PUT| | |''/node/{node_id}/manage/select_kvm'' |Switches the KVM port of the RECS<sup>(r)</sup>%%|%%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}| |''/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}|
 +|''/node/RCU_0_BB_1_0/manage/set_uart_port'' |Set the debug UART of the SMARC Module to a given port|PUT|port={value} (0..3 integer value)|
 +rest_node_smarc_debug_uart_uri
  
 === LoRaWAN API === === LoRaWAN API ===
Line 194: Line 197:
  
 ^ Attribute ^ Description ^ HTTP method ^ ^ Attribute ^ Description ^ HTTP method ^
-|''/lorawan/uplink'' |Schedules uplink packet to the application endpoint defined in the management interface|POST|+|''/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| |''/lorawan/downlink/{fport}'' |Responds with incoming downlink LoRaWAN messages for the specified fport|GET|
  
 Example HTTP Body on GET request: Example HTTP Body on GET request:
  
-<code xml><lorawan fport="...">+<code xml><lorawan>
   <payload>{custom lorawan payload}</payload>   <payload>{custom lorawan payload}</payload>
   <time>{timestamp}</time>   <time>{timestamp}</time>
Line 206: Line 209:
 Example HTTP Body on POST request: Example HTTP Body on POST request:
  
-<code xml><lorawan fport="...">+<code xml><lorawan>
   <payload>{custom lorawan payload}</payload>   <payload>{custom lorawan payload}</payload>
 </lorawan></code> </lorawan></code>
Line 253: Line 256:
 ^ Byte(s) ^ Description ^ Unit ^ Data type ^ ^ Byte(s) ^ Description ^ Unit ^ Data type ^
 |0   | Lora Message-Version | - | Byte | |0   | Lora Message-Version | - | Byte |
-|1   | RCU ID | - | Byte | +|1   | Node ID | - | Byte | 
-|2   | Baseboard ID | - | Byte | +|2   | LoRa Command (0x01 = ON, 0x02 = OFF, 0x03 = RESET) | - | Byte |
-|3   | Node ID | - | Byte | +
-|4   | Power State (0=Off, 1=On, 2=Soft-off, 3=Standby, 4=Hibernate) | - | 3 Bits |+