Configuration Cheat Sheet

On this page you can find a handy cheat sheet with examples of usable settings for the config.txt file. In case the line is emphasized it means the setting is optional, so you only have to use it if you want to change the setting to a non-default value. If applicable the given values represent the default value for that setting.

To get you started we have provided an example config.txt file. Use this file as your base config.txt and start editing!

Click to download config.txt

Use this example recovery.txt if you lost yours. Dont forget to fill in the sim settings and have the webserver generate a unique hash! We recommend not to change anything except for the transmit_interval. By our default the logger attempts to connect to the server every 5 minutes.

Click to download recovery.txt

System

# ----System---- #
Omc048:
  usb_mode: debug                   #debug / storage / repl
  system_id: Example
  application: Example
  file_log_level: info              #debug / info / warn / error / fatal
  repl_log_level: info              #debug / info / warn / error / fatal
  utc_time_offset_hours: 0
  utc_time_offset_minutes: 0
  sensor_data_print: False
  self_test: True

Modem-Settings

# ----Modem-Settings---- #
Modem:
  id: onboard_modem
  port: modem
  sim_username: KPN
  sim_password: gprs
  apn: internet
  network_technology: GSM + LTE     #GSM + LTE / GSM / LTE

Iridium_modem:
  id: iridium_modem
  port: serial1
  supply_port: 1

External-Connection-Settings

# ---- External-Connection-Settings ---- #
Connection_settings:
  cellular_diagnostics: False
  webserver_access: True
  data_protocol: None               #None / SSL / FTP
  webserver_url: blue2cast.com
  webserver_port: 5000
  webserver_password: <OBSERVATOR GENERATED HASH>
  ftp_url: ftp.omc-data-online.com
  ftp_port: 21
  ftp_username: OMC-test
  ftp_password: omc-test
  utc_time_sync: False
  utc_time_server: europe.pool.ntp.org
  utc_time_server_port: 123
  transmit_interval: "0 0,5,10,15,20,25,30,35,40,45,50,55 * * *"
  cron_offset: False                #HH:MM:SS (example: 00:00:00 / 00:01:00 / 00:00:10)

Iridium-Settings

# ----Iridium-Settings---- #
Iridium:
- id: data_iridium
  system_id: ZZ
  transmit_interval: "0 0 * * *"
  add_timeout_field: False

Output-settings

# ----Output-settings---- #
Data_file:
- id: data
  create_interval: "0 * * * *"

Iridium_file:
- id: iridium
  create_interval: "55 59 * * *"

Data_serial_out:
- id: data_serial
  create_interval: "0 * * * *"
  port: serial1
  baudrate: 115200
  mode: RS232

Power-Monitor

# ----Power-Monitor---- #
Input_power_monitor:
- id: power_mon
  hysteresis_high: 12
  hysteresis_low: 11.5
  sample_interval: "0,10,20,30,40,50 * * * *"

Sensor-Settings

# ----Sensor-Settings---- #
driver_name:
- id: chosen_name
  port: serial1             #serial1 / serial2 / serial3 / serial4 / nmea / sdi12 / modem
  baudrate: 9600
  mode: RS232               #RS232 / RS485 / RS422
  bits: 8
  parity: None
  stop: 1
  flow: 0
  timeout: 10
  timeout_char: 3
  rxbuf: 128
  txbuf: 128
  sample_interval: "0 * * * *"

  supply_port: 1
  supply_port_always_on: False
  response_timeout: 120
  startup_time: 0
  cooldown_time: 0

  average_interval: "30 * * * *"
  minimum_required_samples: 30

  cron_offset: False        #HH:MM:SS (example: 00:00:00 / 00:01:00 / 00:00:10)

Additional settings for specific drivers:

EXO:
  wiper_interval: "0 * * * *"
  delay_after_wipe: 0

manta:
  wiper_interval: "0 * * * *"
  delay_after_wipe: 0

navilock_md6:
  utc_time_sync: False

gmx_501:
  utc_time_sync: False

Onboard:
- id: board_sensors0
  sample_interval: "0,20,40 * * * *"

rain_pulse:
- id: rain_pulse0
  port: None                #1 / 2
  mm_per_pulse: 0.02
  reset_interval: None
  sample_interval: "0,20,40 * * * *"

Analog-Settings

Analog_voltage:
- id: analog_voltage1
  port: 1
  sample_interval: "0,10,20,30,40,50 * * * *"
  min_in: 0
  max_in: 24000
  min_out: 0
  max_out: 24
  log_name: Voltage1
  log_unit: V
  log_tag: VOLT1

Analog_current:
- id: analog_current1
  port: 1
  sample_interval: "0,10,20,30,40,50 * * * *"
  min_in: 0
  max_in: 24
  min_out: 0
  max_out: 100
  log_name: Current1
  log_unit: '%'
  log_tag: CURR1

Generic-Drivers

# ----Generic-Drivers---- #
generic_serial_input:
- id: serial_gen0
  port: serial1
  reference_table: gmx500
  sample_interval: "0,10,20,30,40,50 * * * *"
  response_timeout: 60

generic_nmea:
- id: nmea_gen0
  port: serial1
  reference_table: VTG
  sample_interval: "0,10,20,30,40,50 * * * *"
  response_timeout: 60

generic_sdi12:
- id: sdi12_gen0
  port: sdi12
  baudrate: 1200
  bits: 7
  parity: 0
  reference_table: pt12,pt2x
  sample_interval: "0,10,20,30,40,50 * * * *"

modbus:
- id: modbus_1
  port: serial1
  mode: RS485
  rxbuf: 1024
  baudrate: 9600
  protocol: RTU
  reference_table: modbus_table_1,modbus_table_2
  register_print: True
  sample_interval: "0,10,20,30,40,50 * * * *"

Output-Settings

# ----Output-Settings---- #
generic_serial_output:
- id: output_1
  port: serial1                 #serial1 / serial2 / serial3 / serial4 / nmea / sdi12 / modem
  reference_table: OMC2900
  baudrate: 9600
  mode: RS232                   #RS232 / RS485 / RS422
  bits: 8
  parity: None
  stop: 1
  flow: 0
  timeout: 10
  timeout_char: 3
  rxbuf: 128
  txbuf: 128

Excluded-Data

In the example below refer to the ‘gps0’ id of a navilock_md6 sensor. The given parameters are the parameters we want to include in the logs, all other parameters from this sensor are excluded.

# ----Excluded-Data---- #
Log_parameters:
  gps0:
  - Latitude
  - Longitude
  - Course true
  - Course magnetic
  - Satellites