Telem-app configuration: Difference between revisions
No edit summary |
No edit summary |
||
Line 9: | Line 9: | ||
! Description | ! Description | ||
|- | |- | ||
| help | | help | ||
| | | N/A | ||
| Show help message | | Show help message | ||
|- | |- | ||
| conf-path | | conf-path | ||
| /etc/telem-gw.conf | | /etc/telem-gw.conf | ||
| Configuration file | | Configuration file | ||
|- | |- | ||
| no-watchdog | | no-watchdog | ||
| | | N/A | ||
| Disable watchdog | | Disable watchdog | ||
|- | |- | ||
| conf.xml.path | | conf.xml.path | ||
| /usr/local/etc/telem/config.xml | | /usr/local/etc/telem/config.xml | ||
| Path to XML setup file | | Path to XML setup file | ||
|- | |- | ||
| hw-conf | | hw-conf | ||
| | | path | ||
| | | Hardware configuration file | ||
|- | |- | ||
| conf.bin.path | | conf.bin.path | ||
| /usr/local/etc/telem/gwSetup.bin | | /usr/local/etc/telem/gwSetup.bin | ||
| Binary setup file | | Binary setup file | ||
|- | |- | ||
| conf.log.path | | conf.log.path | ||
| /usr/local/etc/telem/log-conf.xml | | /usr/local/etc/telem/log-conf.xml | ||
| Logging configuration file | | Logging configuration file | ||
|- | |- | ||
| path.root | | path.root | ||
| / | | / | ||
| Path to virtual system / | | Path to virtual system / | ||
|- | |- | ||
| path.sys.bus. | | path.sys.bus.w | ||
| /sys/bus/w1/devices | | /sys/bus/w1/devices | ||
| Path to /sys/bus/w1/devices | | Path to /sys/bus/w1/devices | ||
|- | |- | ||
| www.path | | www.path | ||
| /var/www | | /var/www | ||
| Path to WWW dir | | Path to WWW dir | ||
|- | |- | ||
| svg.screens.path | | svg.screens.path | ||
| /var/www/svg/screens | | /var/www/svg/screens | ||
| Path to SVG screens dir | | Path to SVG screens dir | ||
|- | |- | ||
| db.backup.path | | db.backup.path | ||
| /var/local/telem/object_backup.xml | | /var/local/telem/object_backup.xml | ||
| Path to object backup XML file | | Path to object backup XML file | ||
|- | |- | ||
| db.sync.interval | | db.sync.interval | ||
| 00:01:00 | | 00:01:00 | ||
| Database sync interval | | Database sync interval | ||
|- | |- | ||
| conf.user.path | | conf.user.path | ||
| /etc/telem-gw.user.conf | | /etc/telem-gw.user.conf | ||
| Configuration file provided by user | | Configuration file provided by user | ||
|- | |- | ||
| dsp.timesync.receiving | | dsp.timesync.receiving | ||
| | | bool | ||
| | | Allow receiving of timesync from DSP | ||
|- | |- | ||
| ssl.server.keys.path | | ssl.server.keys.path | ||
| /etc/ssl/private | | /etc/ssl/private | ||
| Path to SSL server key directory | | Path to SSL server key directory | ||
|- | |- | ||
| ssl.server.cert.path | | ssl.server.cert.path | ||
| /etc/ssl/certs | | /etc/ssl/certs | ||
| Path to SSL server directory | | Path to SSL server directory | ||
|- | |- | ||
| ssl.bin | | ssl.bin | ||
| /usr/bin/openssl | | /usr/bin/openssl | ||
| Path to openssl binary | | Path to openssl binary | ||
|- | |- | ||
| log.var.path | | log.var.path | ||
| /var/log | | /var/log | ||
| Path to var log | | Path to var log | ||
|- | |- | ||
| log.telem.path | | log.telem.path | ||
| /var/local/telem/log | | /var/local/telem/log | ||
| Path to log telem | | Path to log telem | ||
|- | |- | ||
| sms.local.path | | sms.local.path | ||
| /var/local/telem/sms | | /var/local/telem/sms | ||
| Path to local sms directory | | Path to local sms directory | ||
|- | |- | ||
| var.telem.path | | var.telem.path | ||
| /var/local/telem | | /var/local/telem | ||
| Path to temporary /var/local/telem directory | | Path to temporary /var/local/telem directory | ||
|- | |- | ||
| sms.temp.path | | sms.temp.path | ||
| /tmp/sms | | /tmp/sms | ||
| Path to temporary sms directory | | Path to temporary sms directory | ||
|- | |- | ||
| cmd.path | | cmd.path | ||
| /var/local/telem | | /var/local/telem | ||
| Path to cmd file directory | | Path to cmd file directory | ||
|- | |- | ||
| log.root | | log.root | ||
| Gateway | | Gateway | ||
| Root logger name | | Root logger name | ||
|- | |- | ||
| conf.xml.custom.path | | conf.xml.custom.path | ||
| /usr/local/etc/telem/custom.xml | | /usr/local/etc/telem/custom.xml | ||
| Path to custom XML setup file | | Path to custom XML setup file | ||
|- | |- | ||
| www.custom.path | | timezone.default | ||
| | | EET+2EEST+1,M3.5.0/03:00:00,M10.5.0/04:00:00 | ||
| | | Default timezone for application | ||
|- | |||
| www.custom.path | |||
| path | |||
| Path to XML setup file | |||
|- | |- | ||
| www.port.debug.path | | www.port.debug.path | ||
| | | path | ||
| | | Path to file where webserver port number will be put | ||
|- | |- | ||
| thread.count | | thread.count | ||
| 2 | | 2 | ||
| Thread count for io-service thread group | | Thread count for io-service thread group | ||
|- | |- | ||
| feature.list.path | | feature.list.path | ||
| /var/local/telem/enabled_features | | /var/local/telem/enabled_features | ||
| GWS check for available features via this file | | GWS check for available features via this file | ||
|- | |- | ||
| channel.sleepms.default | | channel.sleepms.default | ||
| 1 | | 1 | ||
| Default channel sleep in milliseconds (1..20) | | Default channel sleep in milliseconds (1..20) | ||
|- | |- | ||
| portio.sleepms | | portio.sleepms | ||
| 1 | | 1 | ||
| Portio sleep in milliseconds (1..20) | | Portio sleep in milliseconds (1..20) | ||
|- | |- | ||
| nice | | nice | ||
| 0 | | 0 | ||
| Default nice value (0..19) | | Default nice value (0..19) | ||
|- | |- | ||
| watchdog | | latitude | ||
| true | | 59.411780 | ||
| Device latitude | |||
|- | |||
| longitude | |||
| 24.684477 | |||
| Device longitude | |||
|- | |||
| watchdog | |||
| true | |||
| Is Watchdog enabled | | Is Watchdog enabled | ||
|- | |- | ||
| watchdog.util | | watchdog.util | ||
| true | | true | ||
| (deprecated) Use external watchdog utility | | (deprecated) Use external watchdog utility | ||
|- | |- | ||
| watchdog.interval | | watchdog.interval | ||
| 00:00:45 | | 00:00:45 | ||
| System watchdog kick interval | | System watchdog kick interval | ||
|- | |- | ||
| watchdog.vpath | | watchdog.vpath | ||
| /tmp/.telem_watchdog | | /tmp/.telem_watchdog | ||
| Virtual watchdog path | | Virtual watchdog path | ||
|- | |- | ||
| watchdog.dev | | watchdog.dev | ||
| /dev/watchdog | | /dev/watchdog | ||
| (deprecated) Watchdog device path | | (deprecated) Watchdog device path | ||
|- | |- | ||
| protocol.icmp.config-path | | protocol.icmp.config-path | ||
| /etc/pinger/ | | /etc/pinger/ | ||
| Pinger configuration path | | Pinger configuration path | ||
|- | |- | ||
| protocol.icmp.procfs | | protocol.icmp.procfs | ||
| /tmp/pingers | | /tmp/pingers | ||
| procfs directory for pingers | | procfs directory for pingers | ||
|- | |- | ||
| ordercode.batterypowered.path | | ordercode.batterypowered.path | ||
| /var/local/telem/ordercode/battery_powered | | /var/local/telem/ordercode/battery_powered | ||
| If file exists | | If file exists, device will be in battery powered mode | ||
|- | |- | ||
| protocol.session.max-length | | protocol.session.max-length | ||
| 00:30:00 | | 00:30:00 | ||
| Maximum session length | | Maximum session length | ||
|- | |- | ||
| protocol.session.retry-period | | protocol.session.retry-period | ||
| 00:15:00 | | 00:15:00 | ||
| Session retry period | | Session retry period | ||
|- | |- | ||
| protocol.session.keep-alive | | protocol.session.keep-alive | ||
| 00:00:30 | | 00:00:30 | ||
| Session keep-alive | | Session keep-alive | ||
|- | |- | ||
| protocol.session.connect-timeout | | protocol.session.connect-timeout | ||
| 00:05:00 | | 00:05:00 | ||
| Connect timeout | | Connect timeout | ||
|- | |- | ||
| protocol.session.period | | protocol.session.period | ||
| 24:00:00 | | 24:00:00 | ||
| Next retry after successful session | | Next retry after successful session | ||
|- | |- | ||
| protocol. | | protocol.iec | ||
| true | | true | ||
| IEC101-balanced TDC workaround | | IEC101-balanced TDC workaround | ||
|- | |- | ||
| protocol. | | protocol.iec | ||
| 0 | | 0 | ||
| IEC101-balanced DataFlowControl delay | | IEC101-balanced DataFlowControl delay | ||
|- | |- | ||
| protocol.periodical-gi.offset | | protocol.periodical-gi.offset | ||
| 00:05:00 | | 00:05:00 | ||
| GI offset every hour or interval if protocol.periodical-gi.use-interval is true | | GI offset every hour or interval if protocol.periodical-gi.use-interval is true | ||
|- | |- | ||
| protocol.periodical-gi.use-interval | | protocol.periodical-gi.use-interval | ||
| false | | false | ||
| Use interval value for GI instead of offset | | Use interval value for GI instead of offset | ||
|- | |- | ||
| xml | | xml | ||
| | | N/A | ||
| XML enabled | | XML enabled | ||
|- | |- | ||
| new-setup | | new-setup | ||
| | | N/A | ||
| Use new setup | | Use new setup | ||
|} | |} | ||
Revision as of 18:13, 6 September 2017
Feature
telem-app functionality can be tweaked via command line arguments and config files
All arguments
Argument | Default value | Description |
---|---|---|
help | N/A | Show help message |
conf-path | /etc/telem-gw.conf | Configuration file |
no-watchdog | N/A | Disable watchdog |
conf.xml.path | /usr/local/etc/telem/config.xml | Path to XML setup file |
hw-conf | path | Hardware configuration file |
conf.bin.path | /usr/local/etc/telem/gwSetup.bin | Binary setup file |
conf.log.path | /usr/local/etc/telem/log-conf.xml | Logging configuration file |
path.root | / | Path to virtual system / |
path.sys.bus.w | /sys/bus/w1/devices | Path to /sys/bus/w1/devices |
www.path | /var/www | Path to WWW dir |
svg.screens.path | /var/www/svg/screens | Path to SVG screens dir |
db.backup.path | /var/local/telem/object_backup.xml | Path to object backup XML file |
db.sync.interval | 00:01:00 | Database sync interval |
conf.user.path | /etc/telem-gw.user.conf | Configuration file provided by user |
dsp.timesync.receiving | bool | Allow receiving of timesync from DSP |
ssl.server.keys.path | /etc/ssl/private | Path to SSL server key directory |
ssl.server.cert.path | /etc/ssl/certs | Path to SSL server directory |
ssl.bin | /usr/bin/openssl | Path to openssl binary |
log.var.path | /var/log | Path to var log |
log.telem.path | /var/local/telem/log | Path to log telem |
sms.local.path | /var/local/telem/sms | Path to local sms directory |
var.telem.path | /var/local/telem | Path to temporary /var/local/telem directory |
sms.temp.path | /tmp/sms | Path to temporary sms directory |
cmd.path | /var/local/telem | Path to cmd file directory |
log.root | Gateway | Root logger name |
conf.xml.custom.path | /usr/local/etc/telem/custom.xml | Path to custom XML setup file |
timezone.default | EET+2EEST+1,M3.5.0/03:00:00,M10.5.0/04:00:00 | Default timezone for application |
www.custom.path | path | Path to XML setup file |
www.port.debug.path | path | Path to file where webserver port number will be put |
thread.count | 2 | Thread count for io-service thread group |
feature.list.path | /var/local/telem/enabled_features | GWS check for available features via this file |
channel.sleepms.default | 1 | Default channel sleep in milliseconds (1..20) |
portio.sleepms | 1 | Portio sleep in milliseconds (1..20) |
nice | 0 | Default nice value (0..19) |
latitude | 59.411780 | Device latitude |
longitude | 24.684477 | Device longitude |
watchdog | true | Is Watchdog enabled |
watchdog.util | true | (deprecated) Use external watchdog utility |
watchdog.interval | 00:00:45 | System watchdog kick interval |
watchdog.vpath | /tmp/.telem_watchdog | Virtual watchdog path |
watchdog.dev | /dev/watchdog | (deprecated) Watchdog device path |
protocol.icmp.config-path | /etc/pinger/ | Pinger configuration path |
protocol.icmp.procfs | /tmp/pingers | procfs directory for pingers |
ordercode.batterypowered.path | /var/local/telem/ordercode/battery_powered | If file exists, device will be in battery powered mode |
protocol.session.max-length | 00:30:00 | Maximum session length |
protocol.session.retry-period | 00:15:00 | Session retry period |
protocol.session.keep-alive | 00:00:30 | Session keep-alive |
protocol.session.connect-timeout | 00:05:00 | Connect timeout |
protocol.session.period | 24:00:00 | Next retry after successful session |
protocol.iec | true | IEC101-balanced TDC workaround |
protocol.iec | 0 | IEC101-balanced DataFlowControl delay |
protocol.periodical-gi.offset | 00:05:00 | GI offset every hour or interval if protocol.periodical-gi.use-interval is true |
protocol.periodical-gi.use-interval | false | Use interval value for GI instead of offset |
xml | N/A | XML enabled |
new-setup | N/A | Use new setup |
Config file
The easiest way to add/override configuration options is to modify the /etc/telem-gw.user.conf file
This config file is checked by telem-app by default without any additional command line arguments
Enable Periodical GI with predefined time interval
Add the follown lines to /etc/telem-gw.user.conf:
protocol.periodical-gi.use-interval=1 protocol.periodical-gi.offset=00:02:00
This will indicate to telem-app that it should do a Periodical GI every 2 minutes instead of every hour at 00:05:00.
If protocol.periodical-gi.offset
is left out, then the default value of 00:05:00 is used.
If protocol.periodical-gi.use-interval
is not set, then Periodical GI is done every hour at value assigned to protocol.periodical-gi.offset
. E.g. in case of default 00:05:00 Periodical GI will be issued every hour at xx:05:00.
NB! This feature is available in firmware starting from 2017.09.05