ecowitt2mqtt 2022.9.4

A small web server to send data from Ecowitt devices to an MQTT Broker

ecowitt2mqtt is a small CLI/web server that allows Ecowitt device data to be sent to an MQTT broker.

• Installation
• Python Versions
• Disclaimer
• Quick Start
• Configuration
  • Command Line Options
  • Environment Variables
  • Configuration File
  • Merging Configuration Options
• Advanced Usage
  • Calculated Sensors
  • Battery Configurations
  • Unit Systems
  • Raw Data
  • Home Assistant
  • Running in the Background
  • Docker
• Diagnostics
• Contributing

Installation

pip install ecowitt2mqtt

Python Versions

ecowitt2mqtt is currently supported on:

• Python 3.8
• Python 3.9
• Python 3.10

Disclaimer

The datapoints within this library and documentation constitute estimates and are intended to help informed decision making. They should not replace analysis, advice, or diagnosis from trained professionals. Use this data at your own discretion.

Quick Start

Note that this README assumes that:

• you have access to an MQTT broker.
• you have already paired your Ecowitt device with the WS View Android/iOS app from Ecowitt.

First, install ecowitt2mqtt via pip:

$ pip install ecowitt2mqtt

Then, shift over to the WS View app on your Android/iOS device. While viewing your device in the app, select Weather Services:

Press Next until you reach the Customized screen:

Fill out the form with these values and tap Save:

• Protocol Type Same As: Ecowitt
• Server IP / Hostname: the IP address/hostname of the device running ecowitt2mqtt
• Path: /data/report/
• Port: 8080 (the default port on which ecowitt2mqtt is served)
• Upload Interval: 60 (change this to alter the frequency with which data is published)

Then, on the machine where you installed ecowitt2mqtt, run it:

$ ecowitt2mqtt \
    --mqtt-broker=192.168.1.101 \
    --mqtt-username=user \
    --mqtt-password=password \
    --mqtt-topic=ecowitt2mqtt/device_1

Within the Upload Interval, data should begin to appear in the MQTT broker.

Configuration

ecowitt2mqtt can be configured via command line options, environment variables, or a (YAML or JSON) config file.

Command Line Options

usage: ecowitt2mqtt [-h] [--version] [--battery-override BATTERY_OVERRIDE] [-c config]
                    [--default-battery-strategy default_battery_strategy] [--diagnostics]
                    [--disable-calculated-data] [-e endpoint] [--hass-discovery]
                    [--hass-discovery-prefix hass_discovery_prefix]
                    [--hass-entity-id-prefix hass_entity_id_prefix]
                    [--input-unit-system input_unit_system] [-b mqtt_broker]
                    [-p mqtt_password] [--mqtt-port mqtt_port] [--mqtt-retain] [--mqtt-tls]
                    [-t mqtt_topic] [-u mqtt_username]
                    [--output-unit-system output_unit_system] [--port port] [--raw-data] [-v]

Send data from an Ecowitt gateway to an MQTT broker

options:
  -h, --help            show this help message and exit
  --version             show program's version number and exit
  --battery-override BATTERY_OVERRIDE
                        A battery configuration override (format: key,value)
  -c config, --config config
                        A path to a YAML or JSON config file
  --default-battery-strategy default_battery_strategy
                        The default battery config strategy to use (default: boolean)
  --diagnostics         Output diagnostics
  --disable-calculated-data
                        Disable the output of calculated sensors
  -e endpoint, --endpoint endpoint
                        The relative endpoint/path to serve ecowitt2mqtt on (default:
                        /data/report)
  --hass-discovery      Publish data in the Home Assistant MQTT Discovery format
  --hass-discovery-prefix hass_discovery_prefix
                        The Home Assistant MQTT Discovery topic prefix to use (default:
                        homeassistant)
  --hass-entity-id-prefix hass_entity_id_prefix
                        The prefix to use for Home Assistant entity IDs
  --input-unit-system input_unit_system
                        The input unit system used by the gateway (default: imperial)
  -b mqtt_broker, --mqtt-broker mqtt_broker
                        The hostname or IP address of an MQTT broker
  -p mqtt_password, --mqtt-password mqtt_password
                        A valid password for the MQTT broker
  --mqtt-port mqtt_port
                        The listenting port of the MQTT broker (default: 1883)
  --mqtt-retain         Instruct the MQTT broker to retain messages
  --mqtt-tls            Enable MQTT over TLS
  -t mqtt_topic, --mqtt-topic mqtt_topic
                        The MQTT topic to publish device data to
  -u mqtt_username, --mqtt-username mqtt_username
                        A valid username for the MQTT broker
  --output-unit-system output_unit_system
                        The output unit system used by the gateway (default: imperial)
  --port port           The port to serve ecowitt2mqtt on (default: 8080)
  --raw-data            Return raw data (don't attempt to translate any values)
  -v, --verbose         Increase verbosity of logged output

Environment Variables

• ECOWITT2MQTT_BATTERY_OVERRIDE: a semicolon-delimited list of key=value battery overrides (default: numeric)
• ECOWITT2MQTT_CONFIG: a path to a YAML or JSON config file (default: None)
• ECOWITT2MQTT_DEFAULT_BATTERY_STRATEGY: the default battery config strategy to use (default: boolean)
• ECOWITT2MQTT_DIAGNOSTICS: whether to output diagnostics (default: false)
• ECOWITT2MQTT_DISABLE_CALCULATED_DATA: whether to disable the output of calculated sensors (default: false)
• ECOWITT2MQTT_ENDPOINT: the relative endpoint/path to serve ecowitt2mqtt on (default: /data/report)
• ECOWITT2MQTT_HASS_DISCOVERY_PREFIX: the Home Assistant discovery prefix to use (default: homeassistant)
• ECOWITT2MQTT_HASS_DISCOVERY: publish data in the Home Assistant MQTT Discovery format Idefault: false)
• ECOWITT2MQTT_HASS_ENTITY_ID_PREFIX: the prefix to use for Home Assistant entity IDs (default: "")
• ECOWITT2MQTT_INPUT_UNIT_SYSTEM: the input unit system used by the device (default: imperial)
• ECOWITT2MQTT_MQTT_BROKER: the hostname or IP address of an MQTT broker
• ECOWITT2MQTT_MQTT_PASSWORD: a valid password for the MQTT broker
• ECOWITT2MQTT_MQTT_PORT: the listenting port of the MQTT broker (default: 1883)
• ECOWITT2MQTT_MQTT_RETAIN: whether to instruct the MQTT broker to retain messages (default: false)
• ECOWITT2MQTT_MQTT_TLS: publish data via MQTT over TLS (default: false)
• ECOWITT2MQTT_MQTT_TOPIC: the MQTT topic to publish device data to
• ECOWITT2MQTT_MQTT_USERNAME: a valid username for the MQTT broker
• ECOWITT2MQTT_OUTPUT_UNIT_SYSTEM: the unit system to use in output (default: imperial)
• ECOWITT2MQTT_PORT: the port to serve ecowitt2mqtt on (default: 8080)
• ECOWITT2MQTT_RAW_DATA: return raw data (don't attempt to translate any values) (default: false)
• ECOWITT2MQTT_VERBOSE: increase verbosity of logged output (default: false)

Configuration File

The configuration file can be formatted as either YAML:

---
battery_override:
  battery_key1: boolean
default_battery_strategy: numeric
diagnostics: false
disable_calculated_data: false
endpoint: /data/report
hass_discovery: false
hass_discovery_prefix: homeassistant
hass_entity_id_prefix: test_prefix
input_unit_system: imperial
mqtt_broker: 127.0.0.1
mqtt_password: password
mqtt_port: 1883
mqtt_retain: false
mqtt_tls: false
mqtt_topic: Test
mqtt_username: user
output_unit_system: imperial
port: 8080
raw_data: false
verbose: false

...or JSON

{
  "battery_override": {
    "battery_key1": "boolean"
  },
  "default_battery_strategy": "numeric",
  "diagnostics": false,
  "disable_calculated_data": false,
  "endpoint": "/data/report",
  "hass_discovery": false,
  "hass_discovery_prefix": "homeassistant",
  "hass_entity_id_prefix": "test_prefix"
  "input_unit_system": "imperial",
  "mqtt_broker": "127.0.0.1",
  "mqtt_password": "password",
  "mqtt_port": 1883,
  "mqtt_retain": true,
  "mqtt_tls": false,
  "mqtt_topic": "Test",
  "mqtt_username": "user",
  "output_unit_system": "imperial",
  "port": 8080,
  "raw_data": false,
  "verbose": false
}

Multiple Gateways

When using the configuration file, it is possible to define specific configuration parameters for multiple Ecowitt gateways. This is useful if different gateways should publish to different MQTT brokers, in different formats, etc.

First, you must determine the unique ID for each gateway. This can be observed in the logs when verbose is enabled – look for the PASSKEY value that the gateway has:

Received data from the Ecowitt device: {'PASSKEY': 'abcde12345', ...}

Then, in the configuration file, simply add a gateways key that contains a mapping of any of the existing configuration options. Options that remain at the root level of the file are treated as defaults.

For example, this YAML configuration file:

---
mqtt_broker: 127.0.0.1
mqtt_password: password
mqtt_topic: Test
mqtt_username: user

gateways:
  abcde12345:
    hass_discovery: true

...defines two gateway definitions:

• One that publishes to the Test topic on an MQTT broker at 127.0.0.1
• One (with a PASSKEY of abcde12345) that publishes to the same broker, but in Home Assistant MQTT Discovery format.

In another example, this JSON configuration file:

{
  "mqtt_broker": "127.0.0.1",
  "mqtt_password": "password",
  "mqtt_port": 1883,
  "mqtt_topic": "Test",
  "mqtt_username": "user",
  "gateways": {
    "abcde12345": {
      "mqtt_broker": "192.168.1.100",
      "mqtt_retain": true,
      "output_unit_system": "metric"
    }
  }
}

...defines two gateway definitions:

• One that publishes to the Test topic on an MQTT broker at 127.0.0.1
• One (with a PASSKEY of abcde12345) that publishes to a different broker (192.168.1.100), outputs the data in metric, and retains the data on the broker

Merging Configuration Options

When parsing configuration options, ecowitt2mqtt looks at the configuration sources in the following order:

1. Configuration File (Specific Gateway)
2. Configuration File (Defaults)
3. Environment Variables
4. CLI Options

This allows you to mix and match sources – for instance, you might have "defaults" in the configuration file and override them via environment variables.

Advanced Usage

Calculated Sensors

In addition to the data coming from a gateway, ecowitt2mqtt will automatically deduce and published several additional, calculated data points if the requisite underlying data exists:

• Absolute Humidity: the actual volume of water vapor in the air
• Beaufort Scale: the empirical measure that relates wind speed to observed conditions at sea or on land
• Dew Point: the temperature to which air must be cooled to become saturated with water vapor, assuming constant air pressure and water content
• Feels Like: how hot or how cold the air feels to the human body when factoring in variables such as relative humidity, wind speeds, the amount of sunshine, etc.
• Frost Point: the temperature below 32°F (0°C) at which moisture in the air will condense as a layer of frost on exposed surfaces that are also at a temperature below the frost point
• Frost Risk: how likely the formation of frost is (based on the frostpoint)
• Heat Index: how hot the air feels to the human body when factoring in relative humidity (applicable when the apparent temperature is higher than the air temperature)
• Safe Exposure Times: how long different skin types can be in the sun (unprotected) before burning begins according to the Fitzpatrick Scale
• Solar Radiation (lux): the detected solar radiation illuminance calculated in lux
• Solar Radiation (%): the percentage of detected solar radiation illuminance as perceived by the human eye
• Simmer Index: an alternative to heat index that describes how how the air feels to the human body in relatively dry environments
• Simmer Zone: a human-friendly interpretation of the Simmer Index
• Thermal Perception: a human-friendly interpretation of the Dew Point
• Wind Chill: how cold the air feels to the human body when factoring in relative humidity, wind speed, etc. (applicable when the apparent temperature is lower than the air temperature)

If you would prefer to not have these sensors calculated and published, you can utilize the --disable-calculated-data configuration option.

Battery Configurations

Ecowitt devices report battery levels in three different formats:

• boolean: 0 represents OFF (i.e., the battery is in normal condition) and 1 represents ON (i.e., the battery is low).
• numeric: the raw numeric value is interpreted as the number of volts remaining in the battery.
• percentage: the raw numeric value is interpreted as the percentage of voltage remaining the battery.

ecowitt2mqtt provides three mechanisms to handle this complexity:

1. A built-in mapping of all currently known battery types to their assumed strategy
2. A default battery strategy for unknown battery types
3. User-defined battery strategy overrides

Built-in Mapping

ecowitt2mqtt contains an internal mapping that should automatically transform all known battery types into their correct format.

Default Battery Strategy

By using the --default-battery-strategy configuration parameter, users can specify how unknown battery types should be treated by default.

Battery Overrides

Individual batteries can be overridden and given a new strategy. How this is accomplished differs slightly based on the configuration method used:

• Command Line Options: provide one or more --battery-override "batt1=boolean" options
• Environment Variables: provide a ECOWITT2MQTT_BATTERY_OVERRIDE variable that is a semicolon-delimited pair of "key=value" strings (e.g., ECOWITT2MQTT_BATTERY_OVERRIDE="batt1=boolean;batt2=numeric")
• Config File: include a dictionary of key/value pairs in either YAML or JSON format

These overrides work on both known and unknown battery types; that said, if you should find the need to override a known battery type because ecowitt2mqtt has an incorrect internal interpretation, submit an issue to get it corrected!

Example

In this example, a user mostly has batteries that should be treated as boolean, but also has one – wh60_batt1 – that should be treated as numeric.

Command Line Options

$ ecowitt2mqtt --default-battery-strategy boolean --battery-override="wh60_batt1=numeric"

Environment Variables

$ ECOWITT2MQTT_DEFAULT_BATTERY_STRATEGY=boolean \
  ECOWITT2MQTT_BATTERY_OVERRIDE="wh60_batt1=numeric" \
  ecowitt2mqtt

Config File

In YAML:

---
default_battery_strategy: boolean
battery_override:
  wh60_batt1: numeric

...or JSON

{
  "default_battery_strategy": "boolean",
  "battery_override": {
    "wh60_batt1": "numeric"
  }
}

Unit Systems

ecowitt2mqtt allows you to specify both the input and output unit systems for a device. This is fairly self-explanatory, but take care to use an --input-unit-system that is consistent with what your device provides (otherwise, your data will be very "off").

Raw Data

In some cases, it may be preferable to prevent ecowitt2mqtt from doing any data translation (converting values to a new unit system, changing binary values – such as might be used by a battery – into "friendly" values, etc.). Passing the --raw-data flag will accomplish this: data will flow directly from the Ecowitt device to the MQTT broker as-is.

Note that the --raw-data flag supersedes any that might cause data translation (such as --input-unit-system or --output-unit-system).

Home Assistant

MQTT Discovery

Home Assistant users can quickly add entities from an Ecowitt device by using MQTT Discovery.

Once Home Assistant is configured to accept MQTT Discovery, ecowitt2mqtt simply needs the --hass-discovery flag:

$ ecowitt2mqtt \
    --mqtt-broker=192.168.1.101 \
    --mqtt-username=user \
    --mqtt-password=password \
    --hass-discovery

Note that if both --hass-discovery and --mqtt-topic are provided, --hass-discovery will win out.

Custom Entity ID Prefix

You can provide a custom prefix for all Home Assistant entities via the --hass-entity-id-prefix config parameter.

Home Assistant OS Add-on

Home Assistant OS users can install the official ecowitt2mqtt add-on by clicking the link below:

Running in the Background

ecowitt2mqtt doesn't, itself, provide any sort of daemonization mechanism. The suggested route is to use a different application.

supervisord

An example supervisord configuration file might look like this:

[supervisord]
nodaemon=true
loglevel=info
user=root

[program:ecowitt2mqtt]
command=ecowitt2mqtt --mqtt-broker=192.168.1.101 --mqtt-username=user --mqtt-password=password
stdout_logfile=/dev/stdout
stdout_logfile_maxbytes=0
redirect_stderr=true

systemd

An example systemd service file in /etc/systemd/system might look like this:

[Unit]
Description=ECOWITT2MQTT daemon
After=network.target

[Service]
Type=simple
ExecStart=ecowitt2mqtt --mqtt-broker=192.168.1.101 --mqtt-username=user --mqtt-password=password
ExecReload=kill -HUP $MAINPID
KillMode=process
Restart=on-failure
RestartSec=5s

[Install]
WantedBy=multi-user.target

To enable the service:

$ systemctl enable ecowitt2mqtt

Docker

The library is available via a Docker image (bachya/ecowitt2mqtt). It is configured by using the same environment variables listed above.

Running the image is straightforward:

docker run -it \
    -e ECOWITT2MQTT_MQTT_BROKER=192.168.1.101 \
    -e ECOWITT2MQTT_MQTT_USERNAME=user \
    -e ECOWITT2MQTT_MQTT_PASSWORD=password \
    -p 8080:8080 \
    bachya/ecowitt2mqtt:latest

Note the value of the -p flag: you must expose the port defined by the PORT environment variable. In the example above, the default port (8080) is used and is exposed via the same port on the host.

docker-compose users can find an example configuration file at docker-compose.dev.yml. Note that this is intended to be a dev environment for quickly testing the repo itself; in production, you should refer to one of the Docker Hub images.

Diagnostics

You may run ecowitt2mqtt in diagnostics mode by providing the --diagnostics flag. In this mode, the app will wait until it receives and publishes a single payload, then exit. This allows users to collect a small-but-complete payload for use in testing, debugging, and issue reporting.

Contributing

1. Check for open features/bugs or initiate a discussion on one.
2. Fork the repository.
3. (optional, but highly recommended) Create a virtual environment: python3 -m venv .venv
4. (optional, but highly recommended) Enter the virtual environment: source ./.venv/bin/activate
5. Install the dev environment: script/setup
6. Code your new feature or bug fix.
7. Write tests that cover your new functionality.
8. Run tests and ensure 100% code coverage: nox -rs coverage
9. Update README.md with any new documentation.
10. Add yourself to AUTHORS.md.
11. Submit a pull request!