--- name: "ModuleSiteStatus.conf" section: "5" platform: "linux" package: "svxlink-server" version: "24.02-5" release: "Debian 13 (Trixie)" platforms: ["linux"] url: "https://new.carta.tech/ModuleSiteStatus.conf" --- # ModuleSiteStatus.conf(5) Configuration file for the SvxLink server Site status module ## NAME ModuleSiteStatus.conf - Configuration file for the SvxLink server Site status module ## DESCRIPTION **svxlink** is a general purpose voice service system for ham radio use. This man-page describe the SvxLink server configuration for the SiteStatus module. The SiteStatus module is used to monitor auxiliary sensors that are triggered by either a GPIO event (digital type sensors) or crossing a threshold outside the hysteresis (analog type sensors) ## CONFIGURATION VARIABLES There are a couple of configuration variables that are common to all modules. The documentation for these can be found in the [**svxlink.conf**(5)](/svxlink.conf/5.md) manual page. Here is the description of all module specific configuration variables that the SvxLink SiteStatus module understands. ### ModuleSiteStatus - **DIGITAL\_GPIO\_PATH** The absolute path to the digital gpio pins stopping before the actual pin number. Typically "/sys/class/gpio/gpio" for a raspberry pi, but may vary. - **DIGITAL\_SENSORS\_COUNT** The DIGITAL\_SENSORS\_COUNT tells the module how many digital type sensors are connected to the system that are to be monitored. - **DIGITAL\_#** The sensor number (increments from 0 by 1), value corresponds to the digital gpio pin number. Example "DIGITAL\_0=496". corresponds to sensor 0, which uses GPIO496 as the input pin to monitor. - **DIGITAL\_TYPE\_#** The DIGITAL\_TYPE\_# number (increments from 0 by 1), value corresponds to the type of sensor being monitored. Currently defined valid entries are: # DOOR\_ACTIVE\_HIGH - Announces a door is open (open = true, closed = false) # DOOR\_ACTIVE\_LOW - Announces a door is open (open = false, closed = true) # FUEL\_ACTIVE\_HIGH - Announces a low fuel sensor is activated (active signal = true) # FUEL\_ACTIVE\_LOW - Announces a low fuel sensor is activated (active signal = false) # WATER - Not implemented yet # FIRE - Not implemented yet # SOLAR\_ACTIVE\_HIGH - Announces a Solar Charger state (active signal = true) # SOLAR\_ACTIVE\_LOW - Announces a Solar Charger state (active signal = false) # BATTERY - not implemented yet as an example: DIGITAL\_TYPE\_0=DOOR\_ACTIVE\_HIGH means the sensor that is attached to the pin defined by DIGITAL\_0 is a door sensor that when the value toggle from logic low to logic high indicates the door has been opened. - **ANALOG\_SENSORS\_COUNT** The ANALOG\_SENSORS\_COUNT tells the module how many analog type sensors are connected to the system that are to be monitored. - **ANALOG\_GPIO\_PATH** The absolute path to the analog sensor pins stopping before the actual pin number. The functional tcl file may need manipulated if the following structure does not reflect the final location of the raw data values in the system. /sys/bus/iio/devices/iio:device0/in\_voltage\\_raw - **ANALOG\_#** The sensor number (increments from 0 by 1), value corresponds to the analog channel number. Example "ANALOG\_0=0". corresponds to sensor channel 0 - **ANALOG\_TYPE\_#** The ANALOG\_TYPE\_# number (increments from 0 by 1), value corresponds to the type of sensor being monitored. Currently defined valid entries are: TEMPERATURE - Placeholder only, user to configure based on scaling factors BATTERY\_VOLTAGE - Placeholder only, user to configure based on scaling factors as an example: # ANALOG\_TYPE\_0=TEMPERATURE - **ANALOG\_HYSTERISIS\_#** The amount of signal "noise" that should be tolerated before an alarm is triggered. For example, during development, an open analog pin had noise of +/- 35 counts from the mean value. Setting the ANALOG\_HYSTERISIS\_#=40 would suppress the alarms from being triggered every second for in-range/out-of-range.... It is best to understand the expected behavior of the circuit in the environment before locking down this value or the hysteresis may be too low or to high causing false alarms or missed alarms. - ## FILES - */etc/svxlink/svxlink.conf* (or deprecated */etc/svxlink.conf*) The system wide configuration file. - *~/.svxlink/svxlink.conf* Per user configuration file. - */etc/svxlink/svxlink.d/ModuleSiteStatus.conf* Global modularized configuration file. Depends on the CFG\_DIR configuration variable setting. - *~/.svxlink/svxlink.d/ModuleSiteStatus.conf* Per user modularized configuration file. Depends on the CFG\_DIR configuration variable setting. ## AUTHOR Dan Loranger (KG7PAR) \ ## SEE ALSO [**svxlink.conf**(5)](/svxlink.conf/5.md)