Giter VIP home page Giter VIP logo

mi-home-api's Introduction

Home API to Control Home Appliance with Hassio, Motion

This 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!!

API End Points

  • /api/v1/
    • light/ - If name is passed filter light, if not, all lights are used
      • GET:status/:name*?: - Get Lights Status
      • POST:on/:name*?: - Turn on Light
      • POST:off/:name*?: - Turn off Light
      • POST:toggle/:name*?: - Toogle Light Power
      • POST:color/:name*?: - Body: {color: string, duration: int} - Change Light color with duration animation
      • POST:brightness/:name*?: - Body: {value: int[0-100], duration: int} - Change Light color with duration animation
      • POST:temperature/:name*?: - Body: {value: int[2700-6500], duration: int} - Change Light color with duration animation
    • vaccum/
      • GET:status: - Get Vaccum Status
      • GET:zone: - Retrurn the list of zones
      • POST:start - Start cleaning
      • POST:stop - Stop the vaccum, even if it is going to dock
      • POST:spot - Start spot clean
      • POST:find - Make Vaccum play a sound
      • POST:zone - Body: {[speed: int,] zone: string, repeats: int} - Start Cleaning one or more Zones, zone names splited by ' '
      • POST:speed - Body: {speed: int} - Start Cleaning one or more Zones, zone names splited by ' '
      • POST:dock - Send the vaccum to dock
    • motion/
      • POST:detect -{motion_area: {x: int, y: int, width: int, heigth: int}} - Send Motion Detect Notification
      • POST:movie - {file: string, action: string(start|end)[, motion_area: {x: int, y: int, width: int, heigth: int}]} When Start: Send Motion Detect Notification When Ends: Send Video Access Link Notification

Features

  • Control Xiaomi Vaccum by Google Assitant
    • "Send vaccum to dock"
    • "Change vaccum's Power to ${speed}"
    • "Clean the ${room_name}"
  • Embeded Web Interface
    • Control Xiaomi Vaccum
    • Control Xiaomi Yeelight Ligths
  • Stream WebCam Video via WebInterface
  • Send Web/Mobile Notifications to Device
    • When WebCam Detects Motion - Text With Warning
    • When salves Detected Motion video - Text with button to access the via via WebInterface

See next planned changes Here

Dependencies

Dependencies Configs Examples

Funcional Diagram

Google Assistant Voice Control Data Flow Diagram

References

References that help me to learn to this project

mi-home-api's People

Contributors

victorwads avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

mi-home-api's Issues

feasibility question

Hello,

I found your project very interesting and k would like to build with it. my plan is to have a local cron to ping 2 of my cameras for detection presence every 10s or so, and trigger some google voice action based on it (basically, aircon control)

Could you tell quickly if this could work? I sense that from your schematics and api doc, it could work, but some validation from you could always be welcomed.

Thanks

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.