Skip to content

Latest commit

 

History

History
97 lines (72 loc) · 5.05 KB

README.md

File metadata and controls

97 lines (72 loc) · 5.05 KB
Raw

face4motion - ☺face listening for 🎬motion

Provides face detection s micro-service listening for MQTT messages. This service is built from the face service. This container may be run locally using Docker, pushed to a Docker registry, and published to any Open Horizon exchange.

Status

Supports amd64 Architecture Docker Pulls

Supports arm Architecture Docker Pulls

Supports arm64 Architecture Docker Pulls

Service discovery

  • org - [email protected]
  • url - com.github.dcmartin.open-horizon.face4motion
  • version - 0.0.1

Service variables

  • FACE_THRESHOLD - minimum confidence percent; default 1; range 1 to 99
  • MQTT_HOST - hostname or IP address of MQTT broker; defaults to mqtt
  • MQTT_PORT - port for MQTT; defaults to 1883
  • MQTT_USERNAME - username for MQTT access; default "" (empty string)
  • MQTT_PASSWORD - password for MQTT access; default "" (empty string)
  • FACE4MOTION_GROUP - topic group; default + (all)
  • FACE4MOTION_DEVICE - topic device; default + (all)
  • FACE4MOTION_CAMERA - topic camera; default + (all)
  • FACE4MOTION_TOPIC_EVENT - topic event; default event/end
  • FACE4MOTION_TOO_OLD - events older in seconds are ignored; default 300
  • FACE4MOTION_USE_MOCK - generate mock events for testing
  • LOG_LEVEL - specify level of logging; default info; options include (debug and none)

How To Use

Copy this repository, change to the face4motion directory, then use the make command; see below:

% mkdir ~/gitdir
% cd ~/gitdir
% git clone http://github.com/dcmartin/open-horizon
% cd open-horizon/face4motion
% make
...

Sample

Changelog & Releases

Releases are based on Semantic Versioning, and use the format of MAJOR.MINOR.PATCH. In a nutshell, the version will be incremented based on the following:

  • MAJOR: Incompatible or major changes.
  • MINOR: Backwards-compatible new features and enhancements.
  • PATCH: Backwards-compatible bugfixes and package updates.

Authors & contributors

David C Martin ([email protected])