Skip to content

Latest commit

 

History

History
217 lines (183 loc) · 12.2 KB

README.md

File metadata and controls

217 lines (183 loc) · 12.2 KB
Raw

Homeserver

New - Read the WIKI

A python home IoT control suite, featuring a websocket server/client to control various cheap IoT RGB BLE lightbulbs, DIY devices and programmable ON/OFF devices (TVs via HDMI-CEC, sound systems using LIRC, HTPCs using shutdown/wake-on-lan functions...) and various modules (such as an automatic file backup wrapper around rsync)

The server runs on a RPi3 or a linux-based bluetooth-enabled processor board and waits for requests, either from IFTTT (using a webhook Then That), dialogflow, from a device on-connection event (detected by pinging a static local IP, ie. for a mobile phone), from the included webserver or by a direct command-line call using home.py (for example, when called on a specific event/via a menu button on Kodi - or other HTPC softwares).

Why Homeserver ?

  • It allows to control multiple devices that uses different protocols at the same time.
  • It can change device states using threads, which is much faster than running individual scripts one after another.
  • It can be integrated with any project that can run python, for example Kodi HTPCs.
  • It allows to change device states (turn lights on/off for example) depending on someone's presence at home or depending on the sunset time at your actual location.
  • It is portable - the server can be executed on any python3 compatible machine. You may also have multiple servers if, for example, your bluetooth devices are too far away.
  • It supports delayed changes (open x device for n seconds, or change y device state after n seconds).
  • Compatible with IFTTT (can be interfaced with Google Assistant/Google home and other voice devices) to add vocal commands to any non-smart device.
  • Can receive commands from any IoT device/detectors that can connect via TCP wifi socket (see WIKI page on this)
  • Can receive commands from a mobile-friendly web interface (for a rpi3, default address is raspberrypi:WEBSERVER_PORT - as defined in home.ini)
  • Can automatically schedule - or start from the webserver - rsync backups between linux computers via the backup module.

Supported devices

  • Milight BLE light bulbs
  • Mipow Playbulbs (tested with Rainbow, other BLE Pb devices should work)
  • Decora Leviton switches (all switches that are accessible via the MyLeviton app)
  • Generic ON/OFF devices (devices that can be turned ON, OFF or restarted using a sh/bash command. Includes TVs with cec-client commands, HTPCs with wakeonlan commands, IR Devices with LIRC irsend commands and everything else. TIP - Group them together with a similar name (for example GROUP = livingroom) and call "./home.py --on --group livingroom" to turn them all ON simultaneously)
  • Meross smart switches MSS110, MSS210, MSS310 and MSS425E (ON/OFF functions - via the Meross cloud app)
  • Input devices (arduinos, esp8266 and other wifi-enable boards) to link various sensors to the homeserver setup
  • TPLink smart switches (HS200, HS210, HS220)

Requirements

Absolute requirements

  • Python 3
  • Some BLE-enabled microprocessor (runs the server. Tested with the RPi3)

Relative requirements

  • HDMI cable (to send HDMI-CEC commands to TV. Check cec-client for infos about how to use this)
  • RPI-GPIO + LIRC setup (to create a small, sub-20$ IR remote controller for IR devices, such as a sound device)
  • Edited sudoers file to allow shutdown/reboot requests via ssh (UNIX/linux systems)

Installation and configuration

Using the systemd script

  1. Setup python3 on your system if it's not already installed
  2. Git clone the repository in your RPi home folder (or wherever you want but don't forget to change the service script)
cd /home/pi
git clone https://github.com/Mazotis/Homeserver
  1. Configure your server and devices in the home.ini file. Read the file itself or the wiki for all the tweakable parameters.
  2. Install the requirements (this commands installs everything, but you may want to do it manually if you do not use every device type)
cd Homeserver
pip3 install -r requirements.txt
  1. Copy and start the systemd script
sudo cp ./homeserver.service /etc/systemd/system
sudo systemctl enable homeserver
sudo systemctl start homeserver

On a RPi3 or a linux-based bluetooth-enabled processor board (manual use)

  1. Setup python3 + required pip imports.
  2. Configure your server and devices in the home.ini file or run the configuration utility. Read the file itself or the wiki for all the tweakable parameters.
./home.py --server 
Optional command-line options:
--configure (run the configuration utility to generate a home.ini file)
--threaded (runs device state changes on different threads - faster but might be less stable)
--notime (ignores the EVENT_HOUR parameter. Run events anytime)
  1. To use HDMI-CEC, connect HDMI cable to a free TV port.

Note - to run the IFTTT server, you need to configure your actions on IFTTT and send the response via websocket. Configure a dynamic DNS for your local LAN and forward the server port (as set by the PORT variable in home.ini) to your raspberry pi local LAN address port on your router.

On a client device

  1. Setup python3 + required pip imports
  2. You can also trigger device state changes/HDMI-CEC requests by running ./home.py OPTIONS
Examples:
To turn everything on:
./home.py --on
To turn everything on any time of day:
./home.py --on --notime
To turn the living room (group) devices on any time:
./home.py --on --notime --group livingroom
To turn the living room (group) devices off any time, after a 50 seconds delay:
./home.py --off --notime --group livingroom --delay 50
To turn off the living room lights over the tv any time:
./home.py --off --notime --group livingroom tvlights

Development

Devices

More devices can be hardcoded directly in the devices folder. See below for examples.

The init function of your device will receive variables devid (device number) and config (handler for the home.ini configparser).

Decora compatible devices should use the decora variable to send requests (created by the Decora.py module).

BLE bulbs can use the Bulb.py module to simplify development. Integrate this module by changing MyNewDevice(device) to MyNewDevice(Bulb).

Note: the device name and the entry function should match or else the dynamic loader in home.py will fail.

from devices.common import *
from devices.device import device

class MyNewDevice(device):
    def __init__(self, devid, config):
        super().__init__(devid, config) # loads base functions from device.py
        # devid is this device's index within the devicemanager device list, and the hmeo.ini DEVICE# number
        # config is the handler to the home.ini config file
        self.device = config["DEVICE"+str(devid)]["DEVICE"] # Value of the DEVICE configurable in home.ini for DEVICE# (where # is devid)
        # use the same approach for any required variable taken from the config file
        # self._connection is provided by device.py to handle your device connection - True or False
        # self.auto_mode is provided by device.py to give you the AUTO mode status (True or False)
        self.state = DEVICE_OFF # You might want a variable to keep in memory the actual color/state of your bulb/device, in this case the initial value is OFF
        self.device_type = "MyNewDevice" # Tells the homeserver the actual device type - inheritance safe
        self.color_type = "rgb" # Tells the homeserver the expected device state variable type - see convert.py for more info

Each new device class must provide the run(self,color) and get_state(self) to properly work. def run(...) connects to the device, sends the state/color value and returns True or False depending on the success state of the request. It must also set the self.state variable to the end state and self.success to True when the request is completed. def get_state(...) "pings" the device to get its state (or just returns self.state if it cannot know the state in real-time). Subject to change.

device.py provides all functions except color, but you might want to override them if required. Bulb.py provides the device.py functions + additional features used in BLE lightbulbs (for the moment, it only provides a generic disconnection function for BLE devices). Subject to change.

    def get_state(self):
        """ Getter for the actual color/state of device """
        return self.state

    def disconnect(self):
        """ Disconnects the device """
        pass
        
    def descriptions(self):
        """ Getter for the device description """
        return "[{}] - {}".format(self.device_type, self.description)
        
    def run(self, color):
        """ Checks the request and trigger a device state change if needed """
        # Some code that can handle a state change request
        # EXAMPLE BELOW. Returning True completes the request. False reruns the request.
        if len(color) > 3:
            debug.write("Unhandled color format {}".format(color), 1)
            return True
        if color == DEVICE_OFF:
            if not self.turn_off(): return False
            self.state = DEVICE_OFF
            self.success = True
            return True
        elif color == DEVICE_ON:
            if not self.turn_on_and_dim_on(color):
                return False
            self.state = DEVICE_ON
            self.success = True
            return True
        else:
            if not self.turn_on_and_set_color(color): return False
            self.state = color
            self.success = True
            return True

    def post_run(self):
        """ Prepares the device for a future request. """
        self.success = False

Modules

More modules can be hardcoded in the modules folder. Modules can execute any required tasks and are able to communicate with the home server.

All modules receive the config handler and a reference to the home server itself. All modules are also threaded by default. See below for the base code.

Modules can also add some content to the webserver. It needs to provide a HTML file in the /web/modules folder - with its name set in the self.web variable. You can also create some dynamic content by adding the get_web(self) function - its content will be ajax-called on the webserver when you call the javascript function getContent("mynewmodule") (on the module's webpage) and fill any span/div with id = mynewmodule-content. Subject to change.

All texts from html module pages can be translated by encapsulating them in underscore(myTextToTranslate) and appening said text to file /web/texts.py. The locales must then be updated using xgettext:

xgettext -j -d base -o locales/base.pot web/texts.py --from-code utf-8

Then by manually updating each base.po files and updating the binary .mo file using:

msgfmt -o base.mo base

Note: the module name and the entry function should match or else the dynamic loader in home.py will fail.

from devices.common import *
from threading import Thread, Event

class mynewmodule(Thread):
    def __init__(self, config, dm):
        Thread.__init__(self)
        self.config = config # The config file
        self.dm = dm # The reference to the Homeserver's devicemanager. 
        self.running = True # Required. You may want to use this in a "while self.running:" loop in def run(): for telling your module when to start/stop.
        self.web = "mynewmodule.html" # Optional. The filename of the module web content, for the webserver

    def run(self):
        # Functions to run when the module starts

    def stop(self):
        # Functions to clean-up ressources when the thread/module stops

    def get_web(self):
        # Function to generate dynamic HTML code. Called (or updated) using javascript getContent("mynewmodule") and fills a div/span with id mynewmodule-content.
        web = """
        <p>Some web code with python</p>
        """
        web += self.getSomeValue()
        return web

Credits