{"id":17340819,"url":"https://github.com/kenfdev/remo-exporter","last_synced_at":"2025-10-06T21:54:29.840Z","repository":{"id":58012359,"uuid":"141894683","full_name":"kenfdev/remo-exporter","owner":"kenfdev","description":"Prometheus Nature Remo Exporter","archived":false,"fork":false,"pushed_at":"2025-10-02T16:48:58.000Z","size":11411,"stargazers_count":51,"open_issues_count":11,"forks_count":14,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-10-02T18:33:42.625Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kenfdev.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":"2018-07-22T12:42:13.000Z","updated_at":"2025-08-05T09:44:40.000Z","dependencies_parsed_at":"2023-10-13T11:10:34.916Z","dependency_job_id":"aa9f3f09-9602-4b57-9131-390b2611af05","html_url":"https://github.com/kenfdev/remo-exporter","commit_stats":{"total_commits":47,"total_committers":7,"mean_commits":6.714285714285714,"dds":0.5319148936170213,"last_synced_commit":"e33f8705b75fde1751387512f20f57fe560c71ec"},"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/kenfdev/remo-exporter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kenfdev%2Fremo-exporter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kenfdev%2Fremo-exporter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kenfdev%2Fremo-exporter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kenfdev%2Fremo-exporter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kenfdev","download_url":"https://codeload.github.com/kenfdev/remo-exporter/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kenfdev%2Fremo-exporter/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278486276,"owners_count":25994941,"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-05T02:00:06.059Z","response_time":54,"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":[],"created_at":"2024-10-15T15:46:36.844Z","updated_at":"2025-10-06T21:54:29.824Z","avatar_url":"https://github.com/kenfdev.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Prometheus Nature Remo Exporter\n\n[![CircleCI](https://circleci.com/gh/kenfdev/remo-exporter.svg?style=svg)](https://circleci.com/gh/kenfdev/remo-exporter) [![codecov](https://codecov.io/gh/kenfdev/remo-exporter/branch/master/graph/badge.svg)](https://codecov.io/gh/kenfdev/remo-exporter)\n\nExposes Nature Remo and Nature Remo E lite devices metrics to Prometheus.\n\n## Configuration\n\nThis exporter is configurable via environment variables:\n\n### Required\n\nEither `OAUTH_TOKEN_FILE` (recommended) or `OAUTH_TOKEN` should be set.\n\n- `OAUTH_TOKEN_FILE` The path to the file where the OAuth token is stored. Usually you will mount a secret here.\n- `OAUTH_TOKEN` The OAuth token to be used for requests. Get one from [here](https://developer.nature.global/)\n\n### Optional\n\n- `METRICS_PATH` The metrics URL path. Default `/metrics`.\n- `API_BASE_URL` The Remo API base URL. Default `https://api.nature.global`.\n- `PORT` The port to be used by the exporter. Default `9352`.\n- `CACHE_INVALIDATION_SECONDS` This exporter caches results for this perios of seconds. Default `60`.\n\n## Metrics\n\nThe following is a sample metrics you can get from this exporter:\n\n```plain\n# HELP remo_humidity The humidity of the remo device\n# TYPE remo_humidity gauge\nremo_humidity{id=\"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",name=\"Living Remo\"} 50\n# HELP remo_illumination The illumination of the remo device\n# TYPE remo_illumination gauge\nremo_illumination{id=\"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",name=\"Living Remo\"} 141.8\n# HELP remo_temperature The temperature of the remo device\n# TYPE remo_temperature gauge\nremo_temperature{id=\"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",name=\"Living Remo\"} 28.2\n# HELP remo_motion The motion of the remo device\n# TYPE remo_motion gauge\nremo_motion{id=\"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",name=\"Living Remo\"} 1.568608471e+09\n```\n\nIf you have a Nature Remo E lite, you can also get the following metrics:\n\n```plain\n# HELP remo_cumulative_electric_energy_kilowatt The cumulative electric energy of the remo e lite\n# TYPE remo_cumulative_electric_energy_kilowatt counter\nremo_cumulative_electric_energy_kilowatt{id=\"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",name=\"Remo E lite\"} 5094.8\n# HELP remo_measured_instantaneous_energy_watt The measured instantaneous energy of the remo e lite\n# TYPE remo_measured_instantaneous_energy_watt gauge\nremo_measured_instantaneous_energy_watt{id=\"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",name=\"Remo E lite\"} 529\n```\n\n## Usage\n\n### docker-compose\n\nThere's a sample `docker-compose.yml` to be used to test this exporter with prometheus and grafana. Hit the command below:\n\n```bash\nREMO_OAUTH_TOKEN=\u003cYOUR_OAUTH_TOKEN\u003e docker-compose up\n```\n\n### Swarm\n\n#### Create a secret for the oauth token\n\nCreate a file which contains the oauth token.(e.g. `token-file` )\n\n```bash\n# token-file (be sure not to contain a new line!)\n\u003cYOUR-OAUTH-TOKEN\u003e\n```\n\nCreate the secret\n\n```bash\ndocker secret create api-keys token-file\n```\n\n#### Deploy the stack\n\n```bash\n./swarm/deploy_stack.sh\n```\n\n#### Access the metrics\n\nThe following is an example url for the NodePort(30452):\n\nhttp://localhost:30452/metrics\n\n### Kubernetes\n\n#### Prepare namespace\n\n```bash\n# This creates a remo namespace\nkubectl apply -f k8s/namespace.yaml\n```\n\n#### Create a secret for the oauth token\n\nCreate a file which contains the oauth token.(e.g. `api-keys` )\n\n```bash\n# api-keys (be sure not to contain a new line!)\n\u003cYOUR-OAUTH-TOKEN\u003e\n```\n\nCreate the secret\n\n```bash\nkubectl -n remo create secret generic api-keys --from-file=api-keys\n```\n\n#### Deploy\n\n```bash\n# deploy common resources\nkubectl apply -f ./k8s/yaml\n\n# if arch is amd64\nkubectl apply -f ./k8s/yaml-amd64\n\n# if arch if armhf\nkubectl apply -f ./k8s/yaml-armhf\n```\n\n#### Access the metrics\n\nThe following is an example url for the NodePort(30452):\n\nhttp://localhost:30452/metrics\n\n## Grafana\n\nThe following is what it would look like with integration with Grafana:\n\n![Grafana](assets/grafana.jpg)\n\n## Development\n\n### Creating mocks\n\nThis project uses mockgen to create mocks. The following is an example of creating mocks.\n\n```\nmockgen -source ./config/reader.go -destination ./mocks/reader.go -package mocks\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkenfdev%2Fremo-exporter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkenfdev%2Fremo-exporter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkenfdev%2Fremo-exporter/lists"}