Documentation

Teeken.ini, the full reference

This chapter contains a fully commented Teeken.ini.

coupler;runmode;cycle
# 'cycle': run continuously, 
# 'trigger': run until a node is triggered
# 'single': run only once
#
coupler;rehashtime;60
# interval in seconds to check for a new configuration
#
coupler;readinterval;2
# interval in seconds to wait for the next read cycle (global)
#
coupler;loglevel:0
# verbosity of logging information (to console)
# 0 = almost nothing, 9 = everything
#
uplink;smtp;"smtps://smtp.gmail.com";"john.doe";"mymailpassword";"john.doe@gmail.com"
# "john.doe": SMTP username
# "mymailpassword": SMTP password
# "john.doe@gmail.com": From address
#
source;"theMachine"
# a connection to a PLC or other device. 
# always followed by an "adr;" line to specify the type of connection
#
adr;simatic;tcp:192.168.0.1
# connect to a Siemens S300 or S400 through TCP
#
adr;simatic;usb
# connect to a Siemens PLC through USB MPI cable
#
adr;modbus;tcp:192.168.0.1
# connect to a Modbus-TCP device through TCP/IP
#
set;readinterval;2
# when used after 'source': interval in seconds to wait for the next read cycle (all nodes from this source)
#
node;a;"e0.1";"Fuse Fail";"/machine";Z
# define a data point for the above source
# "e0.1": the address, compatible with the connection type
# "Fuse Fail": the text message that will be send
# "/machine": directory of this node
# Z: trigger condition
# 
set;readinterval;2
# when used after 'node': interval in seconds to wait for the next read cycle (this node)
#
receiver;"someHuman"
# starts the definition of a receiver
# always followed by a "adr;" line to specify the connection
#
adr;mail;"the.man@example.com"
# send the messages via e-mail to "the.man@example.com"
#
adr;file;"c:/data/data_%Y%m%d.log"
# write the messages to (daily) log files
#
adr;twitter;"@watcher"
# send the messages as Twitter direct messages to "@watcher"
#
dir;"/machine"
# select all nodes with directory "/machine" for this receiver

Hints

  • Use whitespace after ";" and empty lines to make teeken.ini more readable