Skip to content

Latest commit

 

History

History
172 lines (142 loc) · 6.5 KB

README.md

File metadata and controls

172 lines (142 loc) · 6.5 KB
Raw

🎙 noize - detect sound and send to MQTT

Monitors attached microphone and provides sox functionality as micro-service, transmitting WAV data and spectrogram visualization (PNG) a designated MQTT host. 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 - github@dcmartin.com
  • url - com.github.dcmartin.open-horizon.noize
  • version - 0.0.1

Service variables

  • NOIZE_GROUP - group name (aka top-level topic); defaults to noize
  • NOIZE_CLIENT - client name; defaults to HZN_DEVICE_ID or hostname
  • NOIZE_DEVICE - device to record sound; default: system default device
  • NOIZE_START_LEVEL - default: 1 percent
  • NOIZE_START_SECONDS - default: 0.1 seconds
  • NOIZE_TRIM_DURATION - default: 5 seconds
  • NOIZE_THRESHOLD_TUNE - default: false
  • NOIZE_INCLUDE_WAV - include audio as base64 encoded WAV; default: true
  • NOIZE_INCLUDE_PNG - include spectrogram as base64 encoded PNG; default: true
  • NOIZE_THRESHOLD - default: none; specify KHz
  • NOIZE_LEVEL_TUNE - default: false
  • LOGTO - specify place to log; default: "/dev/stderr"; use "" for ${TMPDIR}/${0##*/}.log
  • LOG_LEVEL - specify level of logging; default info; options include (debug and none; currently ignored)
  • DEBUG - default: false

Required Services

mqtt

  • MQTT_PORT - port number; defaults to 1883
  • MQTT_USERNAME - MQTT username; defaults to ""
  • MQTT_PASSWORD - MQTT password; defaults to ""

How To Use

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

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

The noize value will initially be incomplete until the service completes its initial execution. Subsequent tests should return a completed payload, see below:

% make check

should result in a partial service payload:

{
  "mqtt": null,
  "noize": {
    "date": 1555859075,
    "client": "b95ffa22f971",
    "mock": "square",
    "noise": "<base64 encoded WAV>",
    "spectrogram": "<base64 encoded PNG>"
  },
  "date": 1555859040,
  "hzn": {
    "agreementid": "",
    "arch": "",
    "cpus": 0,
    "device_id": "",
    "exchange_url": "",
    "host_ips": [
      ""
    ],
    "organization": "",
    "ram": 0,
    "pattern": null
  },
  "config": {
    "tmpdir": "/tmpfs",
    "logto": "/dev/stderr",
    "log_level": "info",
    "debug": true,
    "group": "noize",
    "client": "b95ffa22f971",
    "start": {
      "level": 1,
      "seconds": 0.1
    },
    "trim": {
      "duration": 5
    },
    "sample_rate": "19200",
    "threshold": "none",
    "threshold_tune": false,
    "level_tune": false,
    "services": [
      {
        "name": "mqtt",
        "url": "http://mqtt"
      }
    ]
  },
  "service": {
    "label": "noize",
    "version": "0.0.1"
  }
}

EXAMPLE

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 (github@dcmartin.com)