Skip to main content

Prometheus exporter for the SparkFun SEN-14348 Environmental Combo Breakout

Project description

sen14348_exporter

Python Prometheus exporter for the SparkFun Environmental Combo Breakout (SEN-14348)

Requirements

Installation

pip install sen14348_exporter

Usage

$ sen14348_exporter -h
usage: sen14348_exporter [-h] [-v] [-p PORT] [-ba BME_ADDRESS]
                         [-ca CCS_ADDRESS] [-l LABELS] [-i INTERVAL]
                         [-bf FILTER] [-bho BHO] [-bpo BPO] [-bto BTO]
                         [-cto CTO]

optional arguments:
  -h, --help            show this help message and exit
  -v, --verbose         increase output verbosity
  -p PORT, --port PORT  exporter port (default: 9502)
  -ba BME_ADDRESS, --bme-address BME_ADDRESS
                        BME280 I2C address (default: 0x77)
  -ca CCS_ADDRESS, --ccs-address CCS_ADDRESS
                        CCS811 I2C address (default: 0x5b)
  -l LABELS, --labels LABELS
                        JSON object of Prometheus labels to apply
  -i INTERVAL, --interval INTERVAL
                        measurement sample interval (default: 2)
  -bf FILTER, --filter FILTER
                        BME280 filter value to apply (0-4, default: 0)
  -bho BHO              BME280 humidity oversampling value (1-5, default: 4)
  -bpo BPO              BME280 pressure oversampling value (1-5, default: 4)
  -bto BTO              BME280 temperature oversampling value (1-5, default:
                        4)
  -cto CTO              CCS811 temperature offset (default: -25.0)

Docker

docker pull ashtreefarms/sen14348-exporter-rpi
docker run -p 9502:9502 --device /dev/i2c-1 ashtreefarms/sen14348-exporter-rpi \
           --labels '{"zone": "bedroom"}'

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sen14348_exporter-0.1.0.tar.gz (4.8 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page