{"id":19262487,"url":"https://github.com/cdeck3r/smartmeter","last_synced_at":"2026-06-15T12:31:47.533Z","repository":{"id":114500856,"uuid":"287262837","full_name":"cdeck3r/SmartMeter","owner":"cdeck3r","description":"Image based approach to track electricity consumption","archived":false,"fork":false,"pushed_at":"2020-09-30T10:54:54.000Z","size":1275,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-23T18:47:00.767Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","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/cdeck3r.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}},"created_at":"2020-08-13T11:36:12.000Z","updated_at":"2020-09-30T10:54:57.000Z","dependencies_parsed_at":"2023-05-17T09:15:43.783Z","dependency_job_id":null,"html_url":"https://github.com/cdeck3r/SmartMeter","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/cdeck3r/SmartMeter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cdeck3r%2FSmartMeter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cdeck3r%2FSmartMeter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cdeck3r%2FSmartMeter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cdeck3r%2FSmartMeter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cdeck3r","download_url":"https://codeload.github.com/cdeck3r/SmartMeter/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cdeck3r%2FSmartMeter/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34363537,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-15T02:00:07.085Z","response_time":63,"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-11-09T19:31:56.015Z","updated_at":"2026-06-15T12:31:47.511Z","avatar_url":"https://github.com/cdeck3r.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SmartMeter\n\nOur goal is to improve our energy footprint. Therefore, we aim for a fine-grained tracking of the electricity consumption in a family home. \n\nQuicklinks:\n\n* project website: https://cdeck3r.com/SmartMeter.\n* development task tracking: [Github's project board](https://github.com/cdeck3r/SmartMeter/projects/1)\n* run logfile analysis: [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/cdeck3r/SmartMeter/master?urlpath=lab/tree/notebooks/LogAnalysis.ipynb)\n\n## Project Description\n\nA COTS camera-based embedded computer system takes pictures of a regular electricity meter. A server software performs an OCR and converts the pictures into numbers. Finally, a statistics report reveals some insights on consumption patterns and behaviors which enables us to improve our energy footprint.\n\nThis is a tiny research project. It focusses on software for \n\n* reliably taking pictures\n* data management across various systems at home as well as on the Internet\n* AI based optical character recognition\n* unattended operation\n* fine-grained consumption statistics\n\nExpected results\n\n* 24/7 solution delivering electricity consumption data\n* Set of real world pictures used for future AI projects\n\nLearning goals\n\n* Methods and tools for AI based image processing\n* Assess the maturity and ease of use of available tools\n\n## Hardware\n\nThe COTS camera-based embedded system is a [Raspberry Pi 3](https://en.wikipedia.org/wiki/Raspberry_Pi) with a [Raspberry Pi camera module](https://www.geeetech.com/wiki/index.php/Raspberry_Pi_Camera_Module) connected to it. Follow the [instruction](https://projects.raspberrypi.org/en/projects/getting-started-with-picamera) for connecting and first steps using the Pi camera module\n\nImages are stored on Dropbox and processed by a cloud server on the Internet.\n\n## Quickstart\n\nRaspberry Pi software setup\n\n* use a standard RaspiOS image\n* connect the camera\n* install the software from repo's `raspi` directory\n\nServer software setup\n\n* linux system required \n* install the software from the repo's `server/` directory \n* *TBD: there is a docker image*\n\nFor full instructions see\n\n* [install_raspi.md](install_raspi.md)\n* install_server.md\n\n## Backup Images\n\nDropbox provides 2GB storage space for free. If you run out of space, you may use the SmartMeter's backup script. It downloads all images, compares the downloaded files using their names and file sizes with the remote ones. It will delete the remote files, if found identical with the local ones (acc. to name and size).\n\nBackup script: [`src/backup_dropbox/backup_dropbox.sh`](https://github.com/cdeck3r/SmartMeter/blob/master/src/backup_dropbox/backup_dropbox.sh)\n\nFor usage, first, check and alter (if necessary) config variables in the script's variables section. Afterwards, start the script, simply by running:\n```bash\ncd src/backup_dropbox\n./backup_dropbox.sh\n``` \n\n## Development\n\nStart in project's root dir. Create docker image\n\n```bash\ndocker-compose build smeter-dev \n```\n\nSpin up the container and get a shell from the container\n```bash\ndocker-compose up -d smeter-dev\ndocker exec -it smeter-dev /bin/bash\n```\n\nRun the following workflow to generate the documentation for the project website\n\n```bash\ncd /SmartMeter/scripts\nsnakemake doc --cores 1\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcdeck3r%2Fsmartmeter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcdeck3r%2Fsmartmeter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcdeck3r%2Fsmartmeter/lists"}