{"id":15046052,"url":"https://github.com/leskoiam/kronoterm_cloud_relay","last_synced_at":"2025-10-11T00:41:47.140Z","repository":{"id":256152817,"uuid":"852761589","full_name":"LeskoIam/kronoterm_cloud_relay","owner":"LeskoIam","description":"REST server for forwarding data from cloud.kronoterm.com to local network","archived":false,"fork":false,"pushed_at":"2025-10-03T07:11:09.000Z","size":143,"stargazers_count":7,"open_issues_count":4,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-03T07:19:35.777Z","etag":null,"topics":["assistant","heat","heat-pump","home","home-assistant","kronoterm","local","local-control","prometheus-metrics","pump","smart","smart-home"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/LeskoIam.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-09-05T11:34:18.000Z","updated_at":"2025-10-03T07:08:04.000Z","dependencies_parsed_at":"2024-12-15T11:21:44.073Z","dependency_job_id":"cfc3b15d-e33d-4f8d-bbbd-eb023bd3e9e1","html_url":"https://github.com/LeskoIam/kronoterm_cloud_relay","commit_stats":{"total_commits":41,"total_committers":2,"mean_commits":20.5,"dds":0.4878048780487805,"last_synced_commit":"47931d57459f85560d31201c3c4fd953c4554b77"},"previous_names":["leskoiam/kronoterm_cloud_relay"],"tags_count":23,"template":false,"template_full_name":null,"purl":"pkg:github/LeskoIam/kronoterm_cloud_relay","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LeskoIam%2Fkronoterm_cloud_relay","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LeskoIam%2Fkronoterm_cloud_relay/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LeskoIam%2Fkronoterm_cloud_relay/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LeskoIam%2Fkronoterm_cloud_relay/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LeskoIam","download_url":"https://codeload.github.com/LeskoIam/kronoterm_cloud_relay/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LeskoIam%2Fkronoterm_cloud_relay/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279005650,"owners_count":26083942,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-10T02:00:06.843Z","response_time":62,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["assistant","heat","heat-pump","home","home-assistant","kronoterm","local","local-control","prometheus-metrics","pump","smart","smart-home"],"created_at":"2024-09-24T20:52:38.607Z","updated_at":"2025-10-11T00:41:47.134Z","avatar_url":"https://github.com/LeskoIam.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![ruff](https://github.com/LeskoIam/kronoterm_cloud_relay/actions/workflows/ruff.yml/badge.svg?branch=master)](https://github.com/LeskoIam/kronoterm_cloud_relay/actions/workflows/ruff.yml)\n[![tests](https://github.com/LeskoIam/kronoterm_cloud_relay/actions/workflows/tests.yml/badge.svg?branch=master)](https://github.com/LeskoIam/kronoterm_cloud_relay/actions/workflows/tests.yml)\n# Kronoterm cloud relay\n\nRelay server for [Kronoterm](https://kronoterm.com//) cloud. It gets data from cloud and exposes it through REST API to local network.\n\nAlso has [prometheus](#usage-with-prometheus) endpoint for heat pump data.\n\n## Install and run relay\n### Docker\nHost system must have [Docker](https://www.docker.com/) installed!\n\nPut both files (`docker-compose.yml` and `.env`) in the same directory and make sure they are named accordingly! \n\n####  docker-compose.yml file\nGet example here: [docker-compose.yml](./docker-compose.yml)\n\n```yaml\nservices:\n  kronoterm_cloud_relay:\n    image: leskoiam/kronoterm_cloud_relay:latest\n    container_name: kronoterm_cloud_relay\n    restart: unless-stopped\n    ports:\n      - \"8555:8555\"  # Adjust the port mappings as needed\n    ## If you are having problems with slow connection uncomment lines bellow.\n    ## GitHub issue reference [#26](https://github.com/LeskoIam/kronoterm_cloud_relay/issues/26)\n    # extra_hosts:\n    #   - \"cloud.kronoterm.com=145.14.48.71\"  # TODO: don't forget to periodically check the validity of IP\n    env_file: .env\n```\n\n####  .env file\nSets environment variables.\n\nGet example here: [.env](./.env_example)\n\u003e Set your Kronoterm cloud **username** and **password** here! File name **must** be `.env`!\n```dotenv\n# Kronoterm cloud user details\nKRONOTERM_CLOUD_USER=your-user\nKRONOTERM_CLOUD_PASSWORD=your-password\n\n# Set to your own timezone https://en.wikipedia.org/wiki/List_of_tz_database_time_zones\nTZ=Europe/Paris\n\n# Prometheus metrics update interval in seconds (if empty or missing defaults to 30, minimum is 10)\nPROMETHEUS_UPDATE_INTERVAL=30\n```\n\n#### Spin up container\n```shell\ndocker compose up -d\n```\n\n## Try it out\nNavigate to http://ip-or-host-address:8555/docs for list of supported API endpoints\n\n## Usage with [Home Assistant](https://www.home-assistant.io/)\nHome Assistant has [REST](https://www.home-assistant.io/integrations/rest) integration which can request and post data from `relay`.\n\nRefer to [Home Assistant Readme](./docs/home_assistant.md) for details.\n\n## Usage with [prometheus](https://prometheus.io/)\n`kronoterm_cloud_api` offers prometheus metrics endpoint at `/metrics` e.g.: http://ip-or-host-address:8555/metrics.\n\nMore on prometheus configuration can be found in [Prometheus Readme](./docs/prometheus.md).\n\n## Debugging\nTail container logs:\n```shell\ndocker logs -f kronoterm_cloud_relay\n```\nShut down container:\n```shell\ndocker compose down kronoterm_cloud_relay\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fleskoiam%2Fkronoterm_cloud_relay","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fleskoiam%2Fkronoterm_cloud_relay","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fleskoiam%2Fkronoterm_cloud_relay/lists"}