Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
andylockran committed Jan 28, 2024
1 parent bcc8c91 commit 5ab6535
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
#heatmiserv3
# heatmiserv3

[![Build Status](https://github.com/andylockran/heatmiserv3/actions/workflows/python-package.yml/badge.svg)](https://github.com/andylockran/heatmiserv3/actions/workflows/python-package.yml)

This library has been created from the work carried out by
Neil Trimboy in 2011 here:
[https://code.google.com/p/heatmiser-monitor-control/]

The library uses the Heatmiser V3 Protocol to communicate
with a number of thermostats.
with a number of thermostats

As the DCB Structures are different on each thermostat, this
module doesn't yet cover all their intricacies, but with the
Expand Down Expand Up @@ -35,4 +36,15 @@ you get something working.

# Requirements

Python needs to be version 3.
Python needs to be version 3.

# Packaging and publishing

This library fell out of a little bit of love as I moved out of
the home that had the thermostats. However, it appears to have
quite a significant following on home-assistant, with a number
of users wanting to benefit from it. I've therefore tried to
improve the resilience by upgrading the packaging, building and
publishing process to poetry. This should make the project
easier to contribute to, and align with the latest standards in
the python ecosystem.

0 comments on commit 5ab6535

Please sign in to comment.