Code Monkey home page Code Monkey logo

merossdevicehandler's Introduction

Contributors Forks Stargazers Issues MIT License


Devicehandler

The MerossDeviceHandler module can be used in the DIY-Smarthome ecosystem to control smart devices from the company "Meross". The goal is to control devices locally, without using the company's servers.
Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

The proof of concept was achieved with the protoype that was submitted as an university exam. Currently, the code isn't functional because of some big API changes. We aim to repair the code and extend functionality (support more devices, etc.).\

There are already multiple benefits using this library:

  • Get rid of Meross' Rate limts (formerly 1 Message per 10 min, currently unknown)
    • Enables features like realtime monitoring (i.e. Power consumption)
  • Control devices independently of
    • internet connection
    • manifacturer server

(back to top)

Built With

  • TypeScript
  • MQTT

(back to top)

Currently supported devices

MSS310

Supported functions:

  • LED State (Get/Set)
  • Powerstate (Get/Set)
  • Get current Powerconsumption
  • more to come!

MSS425f

Supported functions:

  • LED State (Get/Set)
  • Powerstate (Get/Set)
  • Powerstate per Channel (Get/Set)
  • more to come!

(back to top)

Getting Started

Currently, there is no dedicated installer for any module of the DIY-Smarthome ecosystem. You can clone this repository and try the example code (not working atm!) or clone the Dev-Environment and use the module with others.

Prerequisites

You will need NodeJs and npm to use this module.

Installation (in Dev-Environment)

  1. Clone the Dev-Environment from https://example.com
    git clone https://github.com/DIY-Smarthome/Dev-Environment.git
  2. Enter the lib folder
  3. Clone the module
    git clone https://github.com/DIY-Smarthome/MerossDeviceHandler.git
  4. Install NPM packages
    npm install
  5. Build Dev-Environment and all modules
    npm run build

(back to top)

Roadmap

  • Repair code
  • Extend supported functions of already supported devices
  • Extend supported devices

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Also check contributing.md for more info!

Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See license.md for more information.

(back to top)

Contact

Project Link: https://github.com/DIY-Smarthome/MerossDeviceHandler

(back to top)

merossdevicehandler's People

Contributors

quisel avatar

Stargazers

 avatar

Watchers

 avatar

merossdevicehandler's Issues

Device Abilities

Request namespace 'Appliance.System.Ability' in constructor, create object "Abilities" and set each field to false/true.

On get/set function check if device has ability to perform this action. --> Fixes "Socket hang up" Exceptions

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.