- Getting Started
- Hardware
- Software
- Kits
- Embedded Boards
- Specifications
Extended Nagios Example¶
This example is an extended version of the Nagios/Icinga project. It is extended by the usage of a Motion Detector Bricklet and a Segment Display 4x7 Bricklet.
With the extended script you can display if there is an error occurred and can detect motion in the server room. The script can be used as a starting point for your own projects.
Extended Script¶
The small script, called check_tf_temp_ext.py, uses the following interface:
usage: check_tf_temp_ext.py [-h] -u UID
-t {temp,ptc,humidity,motion_detector,segment_display_4x7}
[-H HOST] [-P PORT] [-m {none,high,low,range}]
[-w WARNING] [-c CRITICAL] [-w2 WARNING2]
[-c2 CRITICAL2] [-e {true,false}]
optional arguments:
-h, --help show this help message and exit
-u UID, --uid UID UID from Bricklet
-t {temp,ptc,humidity,motion_detector,segment_display_4x7},
--type {temp,ptc,humidity,motion_detector,segment_display_4x7,humidity}
Choose fitting type for your Bricklet
-H HOST, --host HOST Host Server (default=localhost)
-P PORT, --port PORT Port (default=4223)
-m {none,high,low,range}, --modus {none,high,low,range}
Modus: none (default, only print temperature), high,
low or range
-w WARNING, --warning WARNING
Warning temperature level (temperatures above this
level will trigger a warning message in high mode,
temperature below this level will trigger a warning
message in low mode)
-c CRITICAL, --critical CRITICAL
Critical temperature level (temperatures above this
level will trigger a critical message in high mode,
temperature below this level will trigger a critical
message in low mode)
-w2 WARNING2, --warning2 WARNING2
Warning temperature level (temperatures below this
level will trigger a warning message in range mode)
-c2 CRITICAL2, --critical2 CRITICAL2
Critical temperature level (temperatures below this
level will trigger a critical message in range mode)
-e {true,false}, --error {true,false}
Set Error Message on 4x7 Segment On/Off
The interface is extended in comparison to the check_tf_temp.py script.
You can write "Err" on the Segment Display 4x7 Bricklet by
python check_tf_temp_ext.py -u 9VU -H ServerMonitoring -t segment_display_4x7 -e true
and disable it with
python check_tf_temp_ext.py -u 9VU -H ServerMonitoring -t segment_display_4x7 -e false
With the Motion Detector Bricklet you can get information if motion was detected by running
python check_tf_temp_ext.py -H ServerMonitoring -u abc -t motion_detector
The full script looks like this (download):
#!/usr/bin/env python
# -*- coding: utf8 -*-
'''
Based on Wiki project:
http://www.tinkerunity.org/wiki/index.php/EN/Projects/IT_Infrastructure_Monitoring_-_Nagios_Plugin
'''
import sys
import argparse
from tinkerforge.bricklet_ptc import PTC
from tinkerforge.bricklet_ptc_v2 import PTCV2
from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_humidity import Humidity
from tinkerforge.bricklet_humidity_v2 import HumidityV2
from tinkerforge.bricklet_temperature import Temperature
from tinkerforge.bricklet_ambient_light import AmbientLight
from tinkerforge.bricklet_temperature_v2 import TemperatureV2
from tinkerforge.bricklet_motion_detector import MotionDetector
from tinkerforge.bricklet_ambient_light_v2 import AmbientLightV2
from tinkerforge.bricklet_ambient_light_v3 import AmbientLightV3
from tinkerforge.bricklet_motion_detector_v2 import MotionDetectorV2
from tinkerforge.bricklet_segment_display_4x7 import SegmentDisplay4x7
OK = 0
WARNING = 1
CRITICAL = 2
UNKNOWN = 3
MOTION_DETECTED = 1
NO_MOTION_DETECTED = 0
TYPE_PTC = 'ptc'
TYPE_TEMPERATURE = 'temp'
TYPE_HUMIDITY = 'humidity'
TYPE_AMBIENT_LIGHT = 'ambient_light'
TYPE_MOTION_DETECTOR = 'motion_detector'
TYPE_SEGMENT_DISPLAY_4X7 = 'segment_display_4x7'
class CheckTFTemperature(object):
def __init__(self, host = 'localhost', port = 4223):
self.host = host
self.port = port
self.ipcon = IPConnection()
self.name = 'unknown'
self.unit = 'unknown'
self.is_humidity_v2 = False
def connect(self, type, uid):
self.ipcon.connect(self.host, self.port)
self.connected_type = type
if self.connected_type == TYPE_PTC:
ptc = PTC(uid, self.ipcon)
if ptc.get_identity().device_identifier == PTCV2.DEVICE_IDENTIFIER:
ptc = PTCV2(uid, self.ipcon)
self.func = ptc.get_temperature
self.name = 'temperature'
self.unit = '°C'
elif self.connected_type == TYPE_TEMPERATURE:
temperature = Temperature(uid, self.ipcon)
if temperature.get_identity().device_identifier == TemperatureV2.DEVICE_IDENTIFIER:
temperature = TemperatureV2(uid, self.ipcon)
self.func = temperature.get_temperature
self.name = 'temperature'
self.unit = '°C'
elif self.connected_type == TYPE_HUMIDITY:
humidity = Humidity(uid, self.ipcon)
if humidity.get_identity().device_identifier == HumidityV2.DEVICE_IDENTIFIER:
humidity = HumidityV2(uid, self.ipcon)
self.is_humidity_v2 = True
else:
self.is_humidity_v2 = False
self.func = humidity.get_humidity
self.name = 'humidity'
self.unit = '%RH'
elif self.connected_type == TYPE_MOTION_DETECTOR:
md = MotionDetector(uid, self.ipcon)
if md.get_identity().device_identifier == MotionDetectorV2.DEVICE_IDENTIFIER:
md = MotionDetectorV2(uid, self.ipcon)
self.func = md.get_motion_detected
elif self.connected_type == TYPE_AMBIENT_LIGHT:
al = AmbientLight(uid, self.ipcon)
if al.get_identity().device_identifier == AmbientLightV2.DEVICE_IDENTIFIER:
al = AmbientLightV2(uid, self.ipcon)
elif al.get_identity().device_identifier == AmbientLightV3.DEVICE_IDENTIFIER:
al = AmbientLightV3(uid, self.ipcon)
self.func = al.get_illuminance
self.name = 'Illuminance'
self.unit = 'lux'
elif self.connected_type == TYPE_SEGMENT_DISPLAY_4X7:
display = SegmentDisplay4x7(uid, self.ipcon)
self.func = display.set_segments
def disconnect(self):
self.ipcon.disconnect()
def error(self, e):
if e == 'true':
self.func((0, 80, 80, 121), 8, False)
else:
self.func((0, 0, 0, 0), 8, False)
def read_sensor(self):
if self.connected_type == TYPE_HUMIDITY:
if not self.self.is_humidity_v2:
return self.func()/10.0
else:
return self.func()/100.0
elif self.connected_type == TYPE_MOTION_DETECTOR:
return self.func()
else: # Temperature, PTC, Ambient Light.
return self.func()/100.0
def read(self, warning, critical, mode = 'none', warning2 = 0, critical2 = 0):
val = self.read_sensor()
if self.connected_type == TYPE_MOTION_DETECTOR:
if val == 1:
print 'motion detected'
return MOTION_DETECTED
else:
print 'no motion detected'
return NO_MOTION_DETECTED
else:
if mode == 'none':
print "%s %s %s" % (self.name, val, self.unit)
else:
if mode == 'low':
warning2 = warning
critical2 = critical
if val >= critical and (mode == 'high' or mode == 'range'):
print "CRITICAL : %s too high %s %s" % (self.name, val, self.unit)
return CRITICAL
elif val >= warning and (mode == 'high' or mode == 'range'):
print "WARNING : %s is high %s %s" % (self.name, val, self.unit)
return WARNING
elif val <= critical2 and (mode == 'low' or mode == 'range'):
print "CRITICAL : %s too low %s %s" % (self.name, val, self.unit)
return CRITICALs
elif val <= warning2 and (mode == 'low' or mode == 'range'):
print "WARNING : %s is low %s %s" % (self.name, val, self.unit)
return WARNING
elif (val < warning and mode == 'high') or \
(val > warning2 and mode == 'low') or \
(val < warning and val > warning2 and mode == 'range'):
print "OK : %s %s" % (val, self.unit)
return OK
else:
print "UNKNOWN : can't read %s" % self.name
return UNKNOWN
if __name__ == '__main__':
parse = argparse.ArgumentParser()
parse.add_argument(
'-u',
'--uid',
help = 'UID of the Bricklet',
required = True)
parse.add_argument(
'-t',
'--type',
help = 'Choose fitting type for your Bricklet',
type = str,
choices = [
TYPE_PTC,
TYPE_HUMIDITY,
TYPE_TEMPERATURE,
TYPE_AMBIENT_LIGHT,
TYPE_MOTION_DETECTOR,
TYPE_SEGMENT_DISPLAY_4X7],
required = True)
parse.add_argument(
'-H',
'--host',
help = 'Host Server (default=localhost)',
default = 'localhost')
parse.add_argument(
'-P',
'--port',
help = 'Port (default=4223)',
type = int,
default = 4223)
parse.add_argument(
'-m',
'--modus',
help = 'Modus: none (default, only print value), high, low or range',
type = str,
choices = ['none', 'high','low','range'],
default = 'none')
parse.add_argument(
'-w',
'--warning',
help = 'Warning value level (values above this level will trigger a warning message in high mode, values below this level will trigger a warning message in low mode)',
required = False,
type = float)
parse.add_argument(
'-c',
'--critical',
help = 'Critical value level (values above this level will trigger a critical message in high mode, values below this level will trigger a critical message in low mode)',
required = False,
type = float)
parse.add_argument(
'-w2',
'--warning2',
help = 'Warning value level (values below this level will trigger a warning message in range mode)',
type = float)
parse.add_argument(
'-c2',
'--critical2',
help = 'Critical value level (values below this level will trigger a critical message in range mode)',
type = float)
parse.add_argument(
'-e',
'--error',
help = 'Set Error Message on 4x7 Segment On/Off',
choices = ['true', 'false'],
type = str,
default = 'true')
args = parse.parse_args()
tf = CheckTFTemperature(args.host, args.port)
tf.connect(args.type, args.uid)
if args.type == TYPE_SEGMENT_DISPLAY_4X7:
tf.error(args.error)
exit_code = 0
else:
exit_code = tf.read(
args.warning,
args.critical,
args.modus,
args.warning2,
args.critical2)
tf.disconnect()
sys.exit(exit_code)