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
documentation:recsdaemon [2016/09/28 13:49] – krudocumentation:recsdaemon [2021/06/08 14:12] (current) – Adding SensorProviderJetson info vor
Line 3: Line 3:
 ===== Introduction ===== ===== Introduction =====
  
-The RECSDaemon is a small program that can be installed on compute modules in a RECS<sup>(r)</sup>%%|%%Box system to be able to forward OS-level moinitoring data to the integrated anagement system of the RECS<sup>(r)</sup>%%|%%Box. It is written to be cross-platform, running on Microsoft Windows as well as Linux and on x86, x64 and ARM systems.+The RECSDaemon is a small program that can be installed on compute modules in a RECS<sup>(r)</sup>%%|%%Box system to be able to forward OS-level monitoring data to the integrated management system of the RECS<sup>(r)</sup>%%|%%Box. It is written to be cross-platform, running on Microsoft Windows as well as Linux and on x86, x64 and ARM systems.
 To be able to adapt to different platforms, the RECSDaemon uses plugins for different purposes. To configure these plugins and other settings an .ini file is used. To be able to adapt to different platforms, the RECSDaemon uses plugins for different purposes. To configure these plugins and other settings an .ini file is used.
 The RECSDaemon is also able to execute commands sent by the management system to the node (e.g. for shutting down the OS gracefully). The RECSDaemon is also able to execute commands sent by the management system to the node (e.g. for shutting down the OS gracefully).
Line 9: Line 9:
 ===== Installation ===== ===== Installation =====
  
-The RECSDaemon is currently available as a Debian packet (.deb) that can simply be installed using the distribution's packet manager. Packets are provided for x86, x64 and ARM hardfloat setups. +The RECSDaemon is open source and available as [[https://github.com/christmann/RECSDaemon|source code on github]], including a documentation how to compile and install it from source. Pre-packed Linux packages (rpm and deb) are under construction and will follow shortly. 
- +
-After downloading the file you can install it e.g. on Ubuntu using the following command: +
- +
-      dpkg --install RECSDaemon_3.5.0.deb+
  
 The installation script will try to auto-detect some of the configuration parameters, but as platforms supported by the daemon are very diverse, manual configuration of remaining parameters most probably will be necessary. The installation script will try to auto-detect some of the configuration parameters, but as platforms supported by the daemon are very diverse, manual configuration of remaining parameters most probably will be necessary.
  
-RECSDaemon comes with both systemd and classical init scripts to allow autostart of the daemon during system boot. Depending on your distribution, use either+RECSDaemon comes with both systemd and classical init scripts to allow automatically starting the daemon during system boot. Depending on your distribution, use either
  
- systemctl enable RECSDaemon +<code bash> 
 +systemctl enable RECSDaemon  
 +</code>
  
 or or
-  + 
- update-rc.d RECSDaemon defaults+<code bash> 
 +update-rc.d RECSDaemon defaults 
 +</code>
  
 ===== Configuration ===== ===== Configuration =====
Line 32: Line 32:
       /opt/RECSDaemon/conf/recsdaemon.ini       /opt/RECSDaemon/conf/recsdaemon.ini
  
-As this is a standard INI file, it is devided into different sections (denoted by square brackets) with parameters that are set to a certain value (e.g. updateInterval=1000). You can edit this file using a text editor, e.g. nano or vi. However, you probably will need root privileges to do so.+As this is a standard INI file, it is divided into different sections (denoted by square brackets) with parameters that are set to a certain value (e.g. updateInterval=1000). You can edit this file using a text editor, e.g. nano or vi. However, you probably will need root privileges to do so.
  
 The different aspects that need to be configured will be described in the following chapters. The different aspects that need to be configured will be described in the following chapters.
  
 ==== Communication ==== ==== Communication ====
 +
 To be able to send sensor values and to receive commands, the RECSDaemon has to communicate with the management system of the RECS<sup>(r)</sup>%%|%%Box. To be able to send sensor values and to receive commands, the RECSDaemon has to communicate with the management system of the RECS<sup>(r)</sup>%%|%%Box.
 This can happen via one of two different communication channels: On the one hand it is possible to use the internal management bus (I2C) of the RECS<sup>(r)</sup>%%|%%Box. On the other hand, regular TCP/IP is also supported when an external connection between the node the RECSDaemon is running on and the management Ethernet port of the RECS<sup>(r)</sup>%%|%%Box is made. Without this external connection, only I2C can be used. This can happen via one of two different communication channels: On the one hand it is possible to use the internal management bus (I2C) of the RECS<sup>(r)</sup>%%|%%Box. On the other hand, regular TCP/IP is also supported when an external connection between the node the RECSDaemon is running on and the management Ethernet port of the RECS<sup>(r)</sup>%%|%%Box is made. Without this external connection, only I2C can be used.
Line 52: Line 53:
  
 === LinuxCommunicatorDev === === LinuxCommunicatorDev ===
-If neccessary, the I2C bus to be used can be changed. This is done by setting the ''i2cBus'' property. The value is used to determine the device path by appending it to the base path "/dev/i2c-".+ 
 +If necessary, the I2C bus to be used can be changed. This is done by setting the ''i2cBus'' property. The value is used to determine the device path by appending it to the base path "/dev/i2c-".
  
 Example configuration: Example configuration:
-<code>[Comm]+ 
 +<code ini> 
 +[Comm]
 PluginName=LinuxCommunicatorDev PluginName=LinuxCommunicatorDev
-i2cBus=0</code>+i2cBus=0 
 +</code>
  
 === CommunicatorTCP configuration === === CommunicatorTCP configuration ===
-When utilizing I2C as the communication channel, the RECSDaemon automatically can determine on which baseboard in the RECS<sup>(r)</sup>%%|%%Box it is running. However, when using TCP/IP this information has to be supplied in the configuration. This is done by setting the ''baseboard'' parameter to the number of the baseboard this module is currently plugged into. Please remember to update this value when you move the module to another baseboard.+When utilizing I2C as the communication channel, the RECSDaemon automatically can determine on which baseboard in the RECS<sup>(r)</sup>%%|%%Box it is running. However, when using TCP/IP, this information has to be supplied in the configuration file. This is done by setting the ''baseboard'' parameter to the number of the baseboard this module is currently plugged into. Please remember to update this value when you move the module to another baseboard.
  
-Also neccessary is the IP addess of the RECS<sup>(r)</sup>%%|%%Box management system, which is set by the ''controller'' property. Set this value to the IP of the RCU the module is contained in.+Also necessary is the IP address of the RECS<sup>(r)</sup>%%|%%Box management system, which is set by the ''controller'' property. Set this value to the IP of the RCU the module is contained in.
  
 Example configuration: Example configuration:
-<code>[Comm]+ 
 +<code ini> 
 +[Comm]
 PluginName=CommunicatorTCP PluginName=CommunicatorTCP
 baseboard=2 baseboard=2
-controller=192.168.13.56</code>+controller=192.168.13.56 
 +</code>
  
 ==== Slot detection ==== ==== Slot detection ====
 +
 Because some of the RECS<sup>(r)</sup>%%|%%Box baseboards support multiple modules, nodes need to know in which slot of the baseboard they are located. This is done by pins on the module connector that are tied to different logic levels depending on the slot position. These values can be read by the RECSDaemon using a SlotDetector plugin. Because some of the RECS<sup>(r)</sup>%%|%%Box baseboards support multiple modules, nodes need to know in which slot of the baseboard they are located. This is done by pins on the module connector that are tied to different logic levels depending on the slot position. These values can be read by the RECSDaemon using a SlotDetector plugin.
  
Line 79: Line 88:
  
 === LinuxSlotDetectorGPIO configuration === === LinuxSlotDetectorGPIO configuration ===
 +
 This plugin needs the numbers of the GPIO pins used to sense the slot position as used by the running kernel. These are set with the ''Bit0GPIO'' and ''Bit1GPIO'' settings. This plugin needs the numbers of the GPIO pins used to sense the slot position as used by the running kernel. These are set with the ''Bit0GPIO'' and ''Bit1GPIO'' settings.
  
 Example configuration: Example configuration:
-<code>[Slot]+<code ini> 
 +[Slot]
 slotPluginName=LinuxSlotDetectorGPIO slotPluginName=LinuxSlotDetectorGPIO
 Bit0GPIO=133 Bit0GPIO=133
-Bit1GPIO=134</code>+Bit1GPIO=134 
 +</code> 
 ==== Sensor providers ==== ==== Sensor providers ====
 +
 Sensor providers, as the name implies, add one or more sensors to the RECSDaemon's sensor list. This is in contrast to normal sensors that are manually configured (see chapter "Sensors"). Sensor providers can have two different internal designs: They either can directly provide and update sensor objects or they can use JSON as the interface to the RECSDaemon. Depending on the type, the plugins are enabled by adding them to either the ''SensorProviders'' or ''SensorProvidersJSON'' properties in the ''[Plugins]'' section. Sensor providers, as the name implies, add one or more sensors to the RECSDaemon's sensor list. This is in contrast to normal sensors that are manually configured (see chapter "Sensors"). Sensor providers can have two different internal designs: They either can directly provide and update sensor objects or they can use JSON as the interface to the RECSDaemon. Depending on the type, the plugins are enabled by adding them to either the ''SensorProviders'' or ''SensorProvidersJSON'' properties in the ''[Plugins]'' section.
  
Line 94: Line 108:
 |LinuxSensorProviderEth | Direct | Ethernet link status/speed, bytes/sec RX/TX | |LinuxSensorProviderEth | Direct | Ethernet link status/speed, bytes/sec RX/TX |
 |SensorProviderSystem | Direct | CPU utilization, RAM free, System disk free | |SensorProviderSystem | Direct | CPU utilization, RAM free, System disk free |
-|SensorProviderZynq | Direct | Serial transceiver link, utilization, bandwitdh, frame errors, soft errors |+|SensorProviderZynq | Direct | Serial transceiver link, utilization, bandwidth, frame errors, soft errors |
 |SensorProviderZynqModule | JSON | Sensors provided by the module’s microcontroller: 10 voltage rails, 5 power measurements, 7 temperatures | |SensorProviderZynqModule | JSON | Sensors provided by the module’s microcontroller: 10 voltage rails, 5 power measurements, 7 temperatures |
 +|SensorProviderJetson | Direct | Nvidia Jetson Xavier AGX SoC temperature and various power measurements |
  
 Example configuration: Example configuration:
 <code>[Plugins] <code>[Plugins]
-SensorProviders=SensorProviderZynq,LinuxSensorProviderEth,SensorProviderSystem+SensorProviders=SensorProviderZynq,LinuxSensorProviderEth,SensorProviderSystem,SensorProviderJetson
 JSONSensorProviders=SensorProviderZynqModule</code> JSONSensorProviders=SensorProviderZynqModule</code>
  
Line 107: Line 122:
  
 === SensorProviderZynq === === SensorProviderZynq ===
 +
 This plugin needs the base address of the monitoring peripheral it should read in the Zynq's memory space. Configure it with the ''auroraMonitorBaseAddress'' property in the ''Plugins'' section. This plugin needs the base address of the monitoring peripheral it should read in the Zynq's memory space. Configure it with the ''auroraMonitorBaseAddress'' property in the ''Plugins'' section.
  
 === SensorProviderZynqModule === === SensorProviderZynqModule ===
 +
 This plugin needs the name of the serial port of the management microcontroller on the Zynq module. Configure it with the ''zynqSerialPort'' property in the ''Plugins'' section. On Linux, it typically would be "/dev/ttyUSB0". This plugin needs the name of the serial port of the management microcontroller on the Zynq module. Configure it with the ''zynqSerialPort'' property in the ''Plugins'' section. On Linux, it typically would be "/dev/ttyUSB0".
 +
 ==== Sensors ==== ==== Sensors ====
 +
 +Besides SensorProviders that automatically add a set of sensors when enabled, the RECSDaemon also allows manual configuration of additional sensors.
 +
 +Currently, the following plugins can be used to instantiate sensors manually:
 +
 +^ Plugin ^ Use for ^
 +|SensorFileReader | Value read from arbitrary file|
 +
 +Sensors are instantiated in the ''[Sensors]'' section of the configuration file. The value ''count'' gives the total number of configured sensors. For each sensor (counting from 1 to count) three properties are read: ''pluginNameX'', ''sensorNameX'' and ''optionsX'', where ''X'' is replaced with the current count (e.g. ''pluginName1'', ''pluginName2'', etc.).
 +
 +''pluginName'' gives the name of the plugin to be used for this sensor, ''sensorName'' the name of the sensor (max. 29 characters) as shown in e.g. the WebGUI of the RECS<sup>(r)</sup>%%|%%Box. The value of the ''options'' property is given to the plugin and is used for further configuration. It is usually a space-separated list of "option=value" pairs.
 +
 +An example configuration for one manual sensor could be:
 +<code ini>
 +[Sensors]
 +count=1
 +
 +pluginName1=SensorFileReader
 +sensorName1=Test
 +options1=path=test.txt type=U8
 +</code>
 +
 +=== SensorFileReader configuration ===
 +
 +This plugin reads and parses the first line of a given file each time it is requested to update the sensor value. It recognizes the following options:
 +
 +^ Option ^ Possible values ^ Required ^ Description ^
 +|path | String | Yes | Path of the file to be read |
 +|type | U8, U16, double | Yes | Data type of the sensor. U8 and U16 mean unsigned integers of the given width. |
 +|multiplier| Double | No | When type is "double", the read value can be multiplied with the value in this option (e.g. to calculate a temperature from a raw sensor reading) |
 +|unit | °C | No | Unit of the sensor value |
 +|lowerCriticalThreshold | Double | No | Lower critical threshold as double |
 +|lowerWarningThreshold | Double | No | Lower warning threshold as double |
 +|upperWarningThreshold | Double | No | Upper warning threshold as double |
 +|upperCriticalThreshold | Double | No | Upper critical threshold as double |
  
 ==== Other settings ==== ==== Other settings ====
-In the ''Update'' section the rate with which the RECSDaemon updates it's virtual sensors and sends them to the management system can be configured with the ''updateInterval'' property. The value is in milliseconds and gives the time between two updates. Beware that this only changes the update rate of the daemon. The RECS<sup>(r)</sup>%%|%%Box management system has it's own update rate with which it collects sensor values. Thus, if you set this value smaller than the update rate of the management system, the effective update rate will still be that of the management system.+ 
 +In the ''Update'' section the rate with which the RECSDaemon updates its virtual sensors and sends them to the management system can be configured with the ''updateInterval'' property. The value is in milliseconds and gives the time between two updates. Beware that this only changes the update rate of the daemon. The RECS<sup>(r)</sup>%%|%%Box management system has its own update rate with which it collects sensor values. Thus, if you set this value smaller than the update rate of the management system, the effective update rate will still be that of the management system. 
 ===== TCP/IP server ===== ===== TCP/IP server =====
 +
 The RECSDaemon provides a simple TCP/IP server (by default on port 2023) that can be used by external programs to gain information or provide additional sensors. The RECSDaemon provides a simple TCP/IP server (by default on port 2023) that can be used by external programs to gain information or provide additional sensors.
  
-The following commands are currenty supported:+The following commands are currently supported:
  
 ^ Command ^ Action ^ ^ Command ^ Action ^
Line 128: Line 184:
  
 ==== Getting monitoring data ==== ==== Getting monitoring data ====
-Using the ''monitor'' command, the RECSDaemon can be utilized to obtain measurements with a faster update rate than via the regular RECS<sup>(r)</sup>%%|%%Box management system. Each time the daemon receives the command, it causes the baseboard to sample it's local sensors and reads the results. Because this uses the module's I2C connection, it will not work when the CommunicatorTCP plugin is used.+ 
 +Using the ''monitor'' command, the RECSDaemon can be utilized to obtain measurements with a faster update rate than via the regular RECS<sup>(r)</sup>%%|%%Box management system. Each time the daemon receives the command, it causes the baseboard to sample its local sensors and reads the results. Because this uses the module's I2C connection, it will not work when the CommunicatorTCP plugin is used.
  
 The returned JSON string has the following format: The returned JSON string has the following format:
  
-<code>[ +<code javascript> 
-{"name": "nodeCurrent", "value": 0.0, "unit": "A"} +[ 
-{"name": "pegCurrent", "value": 0.0, "unit": "A"} +{"name": "nodeCurrent", "value": 0.0, "unit": "A"}, 
-{"name": "12vSupply", "value": 12.0, "unit": "V"}+{"name": "pegCurrent", "value": 0.0, "unit": "A"}, 
 +{"name": "12vSupply", "value": 12.0, "unit": "V"},
 {"name": "temperatures", "values": [0.0, 0.0, 0.0, 0.0, 0.0], "unit": "°C"} {"name": "temperatures", "values": [0.0, 0.0, 0.0, 0.0, 0.0], "unit": "°C"}
-]</code>+] 
 +</code>
  
 The ''pegCurrent'' entry is optional and only available on COM Express baseboards. The ''pegCurrent'' entry is optional and only available on COM Express baseboards.
 +
 ==== Adding and updating sensors ==== ==== Adding and updating sensors ====
  
Line 163: Line 223:
  
 Example: Example:
-<code>[ +<code javascript> 
- { +[ 
- "name": "1.0 V", +  { 
- "dataType": "double", +    "name": "1.0 V", 
- "unit": "V", +    "dataType": "double", 
- "lowerThresholds": [0.5, 0.8], +    "unit": "V", 
- "upperThresholds": [1.2, 1.5] +    "lowerThresholds": [0.5, 0.8], 
- }, +    "upperThresholds": [1.2, 1.5] 
- { +  }, 
- "name": "Temp. Heatsink", +  { 
- "dataType": "double", +    "name": "Temp. Heatsink", 
- "unit": "°C" +    "dataType": "double", 
- } +    "unit": "°C" 
-]</code>+  } 
 +] 
 +</code>