gobot-pir

README

This project uses the Gobot Framework in combination with a PIR sensor to work as a configurable motion detection bot, being able to send simple events via MQTT and exposing machine readable metrics in the Open Metrics Format.

MQTT Payloads

Motion detected event

"ON"

Motion stopped event

"OFF"

Configuration

Via Env Variables

ENV	Default	Description
GOBOT_MOTION_DETECTION_PLACEMENT	-	Location short name of this motion detection bot
GOBOT_MOTION_DETECTION_LOG_MOTIONS	false	Write a log message for every motion event
GOBOT_MOTION_DETECTION_GPIO_PIN	7	GPIO pin to poll
GOBOT_MOTION_DETECTION_GPIO_POLLING_MS	75	GPIO polling frequency in milliseconds
GOBOT_MOTION_DETECTION_MQTT_HOST	gobot_motion_detection-$PLACEMENT	MQTT connection broker
GOBOT_MOTION_DETECTION_MQTT_CLIENT_ID	gobot_motion_detection-$PLACEMENT	Client ID for the MQTT connection
GOBOT_MOTION_DETECTION_MQTT_TOPIC	gobot_motion_detection/$PLACEMENT	Topic to publish messages into
GOBOT_MOTION_DETECTION_METRICS_ADDR	:9400	Prometheus http handler listen address

Via Config File

{
  "placement": "location of this sensor",
  "metrics_addr": ":1234",
  "gpio_pin": "7",
  "polling_interval_ms": 50,
  "log_motions": false,
  "mqtt_host": "tcp://broker:1883",
  "mqtt_client_id": "client-id",
  "mqtt_topic": "mytopic/foo"
}

Metrics

This project exposes the following metrics in Open Metrics format.

Namespace	Subsystem	Name	Type	Labels	Help
gobot_motion_detection	sensor	motions_detected_total	counter	placement	Total amount of detected motions
gobot_motion_detection	sensor	motions_detected_timestamp_seconds	gauge	placement	Timestamp of the last detected motion
gobot_motion_detection	mqtt	messages_published_total	counter	placement	The amount of published MQTT messages
gobot_motion_detection	mqtt	message_publish_errors_total	counter	placement	Total amount of errors while trying to publish messages over MQTT