Skip to content

perfectdeveloper53/yombo-gateway

 
 

Repository files navigation

Yombo Gateway Overview

The Yombo Gateway Framework is used for home and business automation. This framework provides a base foundation that can be easily extended with module to provide advanced functionality. Support for automation protocols occurs through the use of modules; such as X10, Z-Wave, Insteon, Zigbee, etc.

This framework can also act a bridge between vendor protocols. For example, an X10 controler can be used to control Z-Wave products.

Modules can:

  • Extend the features of the framework through the use of hooks.
  • Provide additional API features to other modules.
  • Provide advanced automation rules and tasks.

Documentation

For new users, check out the quick start guide at https://yg2.in/start

Otherwise, full documentation can be found at https://yg2.in/docs

To created intermediate to advanced automation rules or to extend the capabilites of the gateway, consider developing a module.

Python 3.7.x

Yombo Gateway only works on python 3.7.x. It might work on 3.6.8, however, this isn't tested or supported due to new features. If you are not using the quick start <https://yombo.net/docs/gateway/quick_start> guide to get started, you can just install python 3.7.x using the setup_pyenv.sh script file: to setup: 1) Go to the yombo gateway directory (where this README file is located) 2) bash install/setup_pyenv.sh

On a Raspberry Pi 3, this will take quite a while. On a Raspberry Pi Zero, it's best to enjoy some lunch or dinner at your favorite place or simply use one of our images.

Developing Modules

Documentation for developing modules can be found at: https://yg2.in/dev

A quick start guide to developing modules can be found here: https://yg2.in/dev1

Getting Help / Other Resources

For issue (tickets), feature requests, and roadmaps, visit Yombo github projects page.

Privacy Policy

The full privacy policy is located here: https://yombo.net/policies/privacy_policy

In short: It's your data. We don't sell it or give it away, unless required to do so by court order.

Yombo Gateway License

By accessing or using any Yombo code, you are agreeing to the licensing terms as listed in the LICENSE file. If you do not agree to these terms, do not access or use this softare.

The Yombo Gateway source and/or binaries is governed by the Yombo Reciprocal Public License Version 1.6. A copy is included in the LICENSE file distributed with this software.

About

Advanced home automation, includes web interface for configuration and management.

Resources

License

Unknown, Unknown licenses found

Licenses found

Unknown
LICENSE
Unknown
COPYING

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 64.6%
  • HTML 22.0%
  • CSS 4.8%
  • Vue 4.2%
  • JavaScript 2.6%
  • Shell 1.2%
  • Other 0.6%