{"id":24506740,"url":"https://github.com/victorwads/mi-home-api","last_synced_at":"2025-04-14T07:10:28.903Z","repository":{"id":55139345,"uuid":"194443465","full_name":"victorwads/mi-home-api","owner":"victorwads","description":"Home API to Control Xiaomi Home Appliance ","archived":false,"fork":false,"pushed_at":"2019-08-31T23:37:16.000Z","size":150,"stargazers_count":63,"open_issues_count":1,"forks_count":8,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-06T11:44:55.569Z","etag":null,"topics":["camera-preview","home-automation","mi-home","xiaomi-smart-home"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/victorwads.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}},"created_at":"2019-06-29T19:54:33.000Z","updated_at":"2025-04-02T01:57:46.000Z","dependencies_parsed_at":"2022-08-14T13:10:43.381Z","dependency_job_id":null,"html_url":"https://github.com/victorwads/mi-home-api","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/victorwads%2Fmi-home-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/victorwads%2Fmi-home-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/victorwads%2Fmi-home-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/victorwads%2Fmi-home-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/victorwads","download_url":"https://codeload.github.com/victorwads/mi-home-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248837287,"owners_count":21169374,"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","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":["camera-preview","home-automation","mi-home","xiaomi-smart-home"],"created_at":"2025-01-21T23:39:32.810Z","updated_at":"2025-04-14T07:10:28.873Z","avatar_url":"https://github.com/victorwads.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# Home API to Control Home Appliance with Hassio, Motion \n\nThis is a Node Js API that centers some home appliance services initially made to able Voice Control of a Xiaomi Vaccum Cleaner. In my home, I've got new devices and the system starts to growing up. If you want to contribute, be free!!\n\n## API End Points\n\n - /api/v1/\n   - light/ - If name is passed filter light, if not, all lights are used\n     - GET:status/:name*?: - Get Lights Status\n     - POST:on/:name*?: - Turn on Light\n     - POST:off/:name*?: - Turn off Light\n     - POST:toggle/:name*?: - Toogle Light Power\n     - POST:color/:name*?: - Body: {color: string, duration: int} - Change Light color with duration animation\n     - POST:brightness/:name*?: - Body: {value: int[0-100], duration: int} - Change Light color with duration animation\n     - POST:temperature/:name*?: - Body: {value: int[2700-6500], duration: int} - Change Light color with duration animation\n   - vaccum/\n     - GET:status: - Get Vaccum Status\n     - GET:zone: - Retrurn the list of zones\n     - POST:start - Start cleaning\n     - POST:stop - Stop the vaccum, even if it is going to dock\n     - POST:spot - Start spot clean\n     - POST:find - Make Vaccum play a sound\n     - POST:zone - Body: {[speed: int,] zone: string, repeats: int} - Start Cleaning one or more Zones, zone names splited by ' '\n     - POST:speed - Body: {speed: int} - Start Cleaning one or more Zones, zone names splited by ' '\n     - POST:dock - Send the vaccum to dock\n   - motion/\n     - POST:detect -{motion_area: {x: int, y: int, width: int, heigth: int}} - Send Motion Detect Notification\n     - POST:movie - {file: string, action: string(start|end)[, motion_area: {x: int, y: int, width: int, heigth: int}]}\n       When Start: Send Motion Detect Notification\n       When Ends: Send Video Access Link Notification\n   \n# Features\n\n - Control Xiaomi Vaccum by Google Assitant\n   - \"Send vaccum to dock\"\n   - \"Change vaccum's Power to ${speed}\"\n   - \"Clean the ${room_name}\"\n - Embeded Web Interface\n   - Control Xiaomi Vaccum\n   - Control Xiaomi Yeelight Ligths\n - Stream WebCam Video via WebInterface\n - Send Web/Mobile Notifications to Device\n   - When WebCam Detects Motion - Text With Warning\n   - When salves Detected Motion video - Text with button to access the via via WebInterface\n\n[See next planned changes Here](todoing.md)\n\n# Dependencies\n\n - Miio - Xiaomi Device Comunication - https://github.com/aholstenson/miio\n - Motion - Stream WebCam - https://github.com/Motion-Project/motion\n - OneSignal - Send Notifications - https://github.com/zeyneloz/onesignal-node\n - IFFT - Google Assistant Integration - https://ifttt.com\n\n## Dependencies Configs Examples\n\n - Motion - [etc/motion/config.d - exemple](docs/examples/etc-motion-config.d)\n\n# Funcional Diagram\n\n![Google Assistant Voice Control Data Flow Diagram](docs/imgs/Google-Assistant-Data-Flow.svg)\n\n# References\n\nReferences that help me to learn to this project\n - https://github.com/marcelrv/XiaomiRobotVacuumProtocol\n - https://github.com/OpenMiHome/mihome-binary-protocol\n - https://kaeni.de/deutsche-sprachpakete-fuer-den-roborock-sweep-one/\n - https://www.domoticz.com/wiki/Xiaomi_Gateway_(Aqara)\n - https://dev.mi.com/docs/passport/en/scopes/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvictorwads%2Fmi-home-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvictorwads%2Fmi-home-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvictorwads%2Fmi-home-api/lists"}