Private GIT

Skip to content
Snippets Groups Projects
Select Git revision
0 results

prometheus-dyson

  • Clone with SSH
  • Clone with HTTPS
    • user avatar
    Bump cryptography from 39.0.1 to 41.0.2 (#27)
    dependabot[bot] authored 
    Bumps [cryptography](https://github.com/pyca/cryptography) from 39.0.1 to 41.0.2.
- [Changelog](https://github.com/pyca/cryptography/blob/main/CHANGELOG.rst)
- [Commits](https://github.com/pyca/cryptography/compare/39.0.1...41.0.2

)

---
updated-dependencies:
- dependency-name: cryptography
  dependency-type: direct:production
...

Signed-off-by: default avatardependabot[bot] <support@github.com>
Co-authored-by: default avatardependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    cd14ec05
    History
    user avatar cd14ec05
    History
    Name Last commit Last update
    .github/workflows
    .vscode
    debian
    misc
    .bazelrc
    .gitignore
    BUILD
    LICENSE
    README.md
    WORKSPACE
    config-sample.ini
    config.py
    config_builder.py
    config_test.py
    connect.py
    grafana.json
    main.py
    metrics.py
    metrics_test.py
    mypy.ini
    requirements.txt
    README.md

    build and tests

    prometheus_dyson

    Prometheus client for DysonLink fans (e.g; Pure Hot+Cool and Pure Cool).

    This code supports Dyson Pure Cool and Pure Hot+Cool fans. This supports both the V1 model (reports VOC and Dust) and the V2 models (those that report PM2.5, PM10, NOx, and VOC). Other Dyson fans may work out of the box or with minor modifications.

    Updating instructions from 0.1.x (to 0.2.x or beyond)

    Due to changes in Dyson's Cloud API, automatic device detection based on your Dyson login/password no longer works reliably.

    This means you need to take a one-time manual step to upgrade. The upside to this is that it removes the runtime dependency on the Dyson API, because it will cache the device information locally.

    Please see the Usage > Configuration > Automatic Setup section below for instructions.

    Build

    % bazel build :main

    If you'd like a Debian package:

    % bazel build :main-deb

    Without Bazel

    Tip: a Python virtual environment is a very useful tool for keeping dependencies local to the project (rather than system-wide or in your home directory). This is optional and not required.

    You'll need these dependencies:

    % pip install libdyson
% pip install prometheus_client

    Metrics

    Environmental

    Name Type Availability Description
    dyson_humidity_percent gauge all relative humidity percentage
    dyson_temperature_celsius gauge all ambient temperature in celsius
    dyson_volatile_organic_compounds_units gauge all volatile organic compounds (range 0-10)
    dyson_dust_units gauge V1 fans only dust level (range 0-10)
    dyson_pm25_units gauge V2 fans only PM2.5 units (µg/m^3 ?)
    dyson_pm10_units gauge V2 fans only PM10 units (µg/m^3 ?)
    dyson_formaldehyde_units gauge Formaldehyde units only Formaldehyde/H-CHO units
    dyson_nitrogen_oxide_units gauge V2 fans only Nitrogen Oxide (NOx) levels (range 0-10)

    Operational

    Name Type Availability Description
    dyson_fan_mode enum all AUTO, FAN, OFF (what the fan is set to)
    dyson_fan_power enum all ON if the fan is powered on, OFF otherwise
    dyson_auto_mode enum all ON if the fan is in auto mode, OFF otherwise
    dyson_fan_state enum all FAN, OFF (what the fan is actually doing)
    dyson_fan_speed_units gauge all 0-10 (or -1 if on AUTO)
    dyson_oscillation_mode enum all ON if the fan in oscillation mode, OFF otherwise
    dyson_oscillation_state enum all ON, OFF, IDLE. ON means the fan is currently oscillating, IDLE means the fan is in auto mode and the fan is paused
    dyson_oscillation_angle_low_degrees gauge V2 fans only low angle of oscillation in degrees
    dyson_oscillation_angle_high_degrees gauge V2 fans only high angle of oscillation in degrees
    dyson_night_mode enum all ON if the fan is in night mode, OFF otherwise
    dyson_night_mode_speed gauge V2 fans only maximum speed of the fan in night mode
    dyson_heat_mode enum all heating fans HEAT, OFF (OFF means "in cooling mode")
    dyson_heat_state enum all heating fans only HEAT, OFF (what the fan is actually doing)
    dyson_heat_target_celsius gauge all heating fans target temperature (celsius)
    dyson_focus_mode enum V1 heating only ON if the fan is providing a focused stream, OFF otherwise
    dyson_quality_target_units gauge V1 fans only air quality target (1, 3, 5?)
    dyson_filter_life_seconds gauge V1 fans only seconds of filter life remaining
    dyson_carbon_filter_life_percent gauge V2 fans only percent remaining of the carbon filter
    dyson_hepa_filter_life_percent gauge V2 fans only percent remaining of the HEPA filter
    dyson_continuous_monitoring_mode gauge V2 fans only continuous monitoring of air quality (ON, OFF)

    Usage

    Configuration

    This script reads config.ini (or another file, specified with --config) for your DysonLink login credentials.

    Automatic Setup

    TIP: you must do this if you're upgrading from 0.1.x (to 0.2.x or beyond)

    prometheus-dyson requires a configuration file to operate. In the Debian-based installation, this lives in /etc/prometheus-dyson/config.ini.

    To generate this configuration, run the config builder, like this:

    % /opt/prometheus-dyson/bin/config_builder

    You will need to run this as root (or a user with write permissions to /etc/prometheus-dyson).

    Device Configuration

    A device entry looks like this:

    [XX1-ZZ-ABC1234A]
name = My Fan
serial = XX1-ZZ-ABC1234A
localcredentials = a_random_looking_string==
producttype = 455

    The localcredentials field is provided by the Dyson Cloud API, please see the Automatic Setup section.

    Manual IP Overrides

    By default, fans are auto-detected with Zeroconf. It is possible to provide manual IP overrides in the configuraton however in the Hosts section.

    [Hosts]
XX1-ZZ-ABC1234A = 10.10.100.55

    Args

    % ./prometheus_dyson.py --help
usage: ./prometheus_dyson.py [-h] [--port PORT] [--config CONFIG] [--log_level LOG_LEVEL]

optional arguments:
  -h, --help            show this help message and exit
  --port PORT           HTTP server port
  --config CONFIG       Configuration file (INI file)
  --log_level LOG_LEVEL
                        Logging level (DEBUG, INFO, WARNING, ERROR)

    Scrape Frequency

    Environmental metrics are updated at approximately 30 second intervals. Fan state changes (e.g; FAN -> HEAT) are published ~immediately on change.

    Dashboard

    I've provided a sample Grafana dashboard in grafana.json.

    Another place to be (or not)