You can find the download in Web Portal.
- Code: Select all
GOverlay Desktop CLI nx*1.0
Configuration file: /xxxx/.config/goverlay/config.json
host: The GOverlay socket host, by default its the default GOverlay server
goverlay_key: Your GOverlay key, that can be found in the GOverlay Portal under setttings.
lan_interface: The selected interface for the LAN server to run, that allows sensors to be sent directly to your GOverlay display instead of going thru internet
lan_ip: The IP address to use, by default, its auto-selected from the lan_interface setting
lan_enabled: If you want to enable the LAN server
lan_port: The port for the LAN server
sensors: The list of sensors to report
sensors.sources: Sensor sources that would fetch once per run, for example, if multiple sensors use the data from "cat /proc/cpuinfo",
its best to define a source with a CMD of "cat /proc/cpuinfo" and then each sensor to use this source, this way, the command will
execute once per sensors request and pass this data to the pipleine of each sensor with this source
sensors.single: Custom sensors that provide a single sensor value per sensor
"cpu_temp": { //The sensor tag name, must only contain a-zA-Z0-9_
"group": "CPU", //The sensor group, to group the "names" under
"name": "Load", //The sensor actual name
"type": "CPU", //The sensor type
"unit": "LOAD_PERC", //The sensor unit type
"cmd": "awk '{print $1}' /proc/loadavg", //The cmd to obtain the sensor value, if you use a source, the source data will be appended before this command
"trim": 1, //Trim the sensor result to remove whitespaces at the begining/end
"remove_newlines": 1 //Remove newlines from the sensor result
},
For sensors using a source
"source": "<source_name>", ini and json are reserved source names
sensors.multi: Sensors that obtain multiple sensors, either of an INI file or a JSON data
For INI files
"type": "ini"
"section": "<the section of the ini file>"
"cmd": "<the command that outputs the ini file contents>"
An ini demo would be:
[<section_name>]
sensor_name1=sensor_value1
sensor_name2=sensor_value2
For JSON files
"type": "json"
"cmd": "<the command that outputs the JSON file contents>"
The JSON data MUST BE in the following format:
[
["<sensor_tag_name>","<sensor_group>","<sensor_name>", <value>, "<sensor_type>", "<sensor_unit_type>"],
["<sensor_tag_name>","<sensor_group>","<sensor_name>", <value>, "<sensor_type>", "<sensor_unit_type>"]
]
The sensor types available are:
CPU, GPU, STORAGE, IO, MEMORY, MOTHERBOARD, POWER
The sensor units available are:
TEMP, AMPERS, RPM, VOLTAGE, MEGAHERTZ, WATTS, SPEED_PERC, LEVEL_PERC, LOAD_PERC, Bytes
Kilobytes, Megabytes, Gigabytes, Terabytes
