https://github.com/aneisch/thermostat_api_server_docker

Python API server for Observer Communicating Thermostat local control
https://github.com/aneisch/thermostat_api_server_docker

api docker observer thermostat tstat0201cw

Last synced: about 2 months ago
JSON representation

Python API server for Observer Communicating Thermostat local control

• Host: GitHub
• URL: https://github.com/aneisch/thermostat_api_server_docker
• Owner: aneisch
• Created: 2020-09-15T06:43:21.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-07-30T04:04:09.000Z (5 months ago)
• Last Synced: 2024-07-30T07:51:54.614Z (5 months ago)
• Topics: api, docker, observer, thermostat, tstat0201cw
• Language: Python
• Homepage:
• Size: 285 KB
• Stars: 5
• Watchers: 5
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Thermostat MQTT container




Acts as API server for Observer Communicating HVAC controller (TSTAT0201CW). Bridges MQTT and thermostat for control through applications such as Home Assistant. You'll need to point your thermostat at this application by modifying the observer server address on the thermostat. Depending on your thermostat's firmware version, certain functionaly may or may not be supported. 

## Usage

### Example docker-compose

```yaml

version: '3.2'

services:

    thermostat_api_server:

        container_name: thermostat_api_server

        image: ghcr.io/aneisch/thermostat_api_server:latest # amd64, or latest-arm64 for ARM devices

        ports:

            - '8080:8080'

        environment:

            # Name for Device in HA

            - THERMOSTAT_NAME=Upstairs

            - THERMOSTAT_SERIAL=5687J272316

            - MQTT_SERVER=10.0.1.22 # This can be an internal docker IP or an IP on your "real" network that exposes the MQTT service

            # Optional MQTT_PORT - defaults to 1883

            #- MQTT_PORT=1883

            # Optional username/password

            #- MQTT_USERNAME=username

            #- MQTT_PASSWORD=password

            # Used in reply to thermostat

            - API_SERVER_ADDRESS=10.0.1.22 # This should be the IP where a wifi client can access this container port 8080, NOT an internal docker IP

            - LOG_LEVEL=DEBUG # DEBUG INFO

        restart: always

```

### Home Assistant Configuration

Uses [MQTT Discovery](https://www.home-assistant.io/docs/mqtt/discovery/) to add climate device and associated sensors. If MQTT discovery is enabled, no configuration should be necessary aside from setting container environment variables.  

![Home Assistant Entities](entities.png)