sburke781 / ecowitt

Hubitat Ecowitt Gateway Integration
Apache License 2.0
16 stars 4 forks source link

Ecowitt WiFi Gateway

Ecowitt WiFi Gateway driver for Hubitat Elevation

Features

Installation Instructions

Ecowitt WS View Mobile App:

  1. Make sure all your sensors are properly registered:

  2. Setup a local/customized weather service, a scheduled push of data from the Gateway to the Hubitat Elevation Hub. To access this:

    In the WS View App tap "Menu", "Device List" and select (tap) your EcoWitt Gateway device.

    Tap "More", "Weather Services" and keep tapping "Next" until you see a tab titled "Customized"

    Configure the data push with the following settings:

    • Protocol Type is EcoWitt,
    • Server IP / Hostname is the address of your HE Hub,
    • Path is /data,
    • Port is 39501,
    • Set the Upload Interval as you wish, 60 seconds or above is recommended

Hubitat:

  1. If the Ecowitt Gateway has been setup correctly, every time the scheduled data push occurs, you should see the following warning in the Hubitat system log:

    That's because this driver has not been installed yet and the hub has nowhere to forward the gateway data to.

  2. There are two options for installing the EcoWitt Gateway and RF Sensor drivers:

  3. With the drivers installed, navigate to the "Devices" page on the Hubitat Hub, add a new "Virtual" device, referencing the "Ecowitt WiFi Gateway" driver, then click "Save Device":

  4. Enter the EcoWitt Gateway MAC or IP address, in any legal form (MAC addresses are safer because they never change, but they don't work across VLANs) and whether you want to combine outdoor sensors into a PWS (which will allow you to create HTML weather tiles combining attributes from all sensor members). Finally "Save Preferences":

  5. Wait for the next push of data from the EcoWitt Gateway, configured earlier in the WS View Mobile App. When this occurs, the driver will automatically create child devices for all the present (and supported) sensors (depending on the frequency you setup for your Gateway to send data, this may take a few minutes):

HTML Templates

HTML templates are a powerful way to present multiple Ecowitt sensor attributes in a single Hubitat dashboard tile. The following are some basic examples of what you can achieve with a simple HTML template:

Each sensor device can specify up to 5 templates which will allow the creation of 5 customized dashboard tiles.

HTML Templates Quick Start

  1. In "Hubitat -> Devices" select an Ecowitt sensor (not the gateway) you'd like to "templetize".

    Then In "Preferences -> HTML Tile Template" enter up to five (comma separated) pre-made template IDs which the driver will automatically retrieve from the template repository.

    Finally click "Save Preferences".

    Note, whenever you click Save Preferences, whether to update the list of Template Id's or any other settings, the html attributes will temporarily disappear until the next feed of data is received from the EcoWitt Gateway. This will cause existing dashboard tiles to stop displaying the EcoWitt weather readings during this time.

  2. In the Hubitat dashboard you intend to use to create HTML template tiles, click "Cog icon -> Advanced -> CSS" and add the following line to the beginning of the CSS file:

    @import url("https://sburke781.github.io/ecowitt/html/ecowitt.css");

    Click "Save CSS"

  3. Now, in the same dashboard, add a new tile, on the left select the Ecowitt sensor, in the center select "Attribute" and on the right select the "html" attribute

    Tip: you can remove the tile "html" title by entering the following in the dashboard CSS (assuming the tile ID is 66):

    #tile-66 .tile-secondary { visibility: hidden; }

HTML Template Icons

Using a small true-type font with only specific weather icons, it is possible to add dynamic icons to the Ecowitt dashboard tiles.

For example, using the driver windCompass attribute, the following is the syntax to obtain a 360� wind icon which always points to the current wind direction as reported by the Ecowitt gateway:

  <i class="ewi-wind${windCompass}"></i>

These icons are in reality text, so of course all the standard CSS font styling, shuch as size, color etc. applies as well.

This is a complete list of all the icons available. Just access the page source html to see all the defined icon classes, and how to use them.

HTML Template Repository

To facilitate reusing and sharing templates, the Ecowitt driver uses a central JSON repository where all the templates can be accessed by ID. This is a complete up-to-date list of all the templates available in the repository.

Templates in the repository are measurement system agnostic and will display the correct unit system based on the parent selection.


Disclaimer

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, TITLE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.