clach04 / x10_any

Wrapper module to control X10 devices, CM17A serial Firecracker and Mochad

x10_any

Wrapper module to control X10 devices.

• https://github.com/clach04/x10_any
• https://pypi.org/project/x10_any/

Table of Contents

• Information
• Getting Started

Information

Initial focus is supporting:

• Mochad (or compatible) servers to control
  • https://sourceforge.net/projects/mochad/ for CM15A RF (radio frequency) and PL (power line) controller and the CM19A RF controller
  • https://bitbucket.org/clach04/mochad_firecracker/ works under Windows and Linux and can control CM17A serial Firecracker
• CM17A serial Firecracker X10 unit, builtin support for CM17A over regular serial port. Also known to work with CM19A USB Firecracker device. For control via GPIO on Raspberry Pi manually install:
  • https://bitbucket.org/cdelker/python-x10-firecracker-interface can be used on Raspberry Pi to control GPIO, not (yet) Python 3 compatible and does not support ALL on/off

Implemented in pure Python. Known to work with:

• Python 2.7
• Python 3.4.4
• Python 3.5

Getting Started

To get started and install the latest version from PyPi:

pip install x10_any
# Or latest from source code via; pip install git+https://github.com/clach04/x10_any.git

If installing/working with a source checkout issue:

pip install -r requirements.txt

NOTE Debian/Ubuntu/Rasbian can install system packages instead of using pip via:

sudo apt-get install python-serial
sudo apt-get install python2-serial

Then run tests via:

python -m x10_any.test.tests

Serial Port Permissions under Linux

Under Linux most users do not have serial port permissions, either:

• give user permission (e.g. add to group "dialout") - RECOMMENDED
• run this demo as root - NOT recommended!

Giver user dialout (serial port) access:

# NOTE requires logout/login to take effect
sudo usermod -a -G dialout $USER

Sample

Mochad:

import x10_any

dev = x10_any.MochadDriver()
dev.x10_command('A', 1, x10_any.ON)
dev.x10_command('A', 1, x10_any.OFF)

Firecracker:

import logging

log = logging.getLogger('x10_any')
logging.basicConfig()  # TODO include function name/line numbers in log
#log.setLevel(level=logging.INFO)
log.setLevel(level=logging.DEBUG)

import x10_any

dev = x10_any.FirecrackerDriver()
#dev = x10_any.FirecrackerDriver('COM11')
#dev = x10_any.FirecrackerDriver('/dev/ttyUSB0')
house_code = 'A'
unit_code = 1
dev.x10_command(house_code, unit_code, x10_any.ON)
dev.x10_command(house_code, unit_code, x10_any.OFF)

Serial Port Device names under Linux

See http://hintshop.ludvig.co.nz/show/persistent-names-usb-serial-devices/ for notes on using udevadm to determine serial number and adding entries to /etc/udev/rules.d/99-usb-serial.rules for persistent devicenames if using multiple usb serial adapters.

x10_any's Issues

CI failures

Github CI changed since last commit.

Need to pick one of:

• disable 3.5 and 2.7 - not an option, want 2.7 tested
• tweak (ala https://github.com/clach04/puren_tonbo/blob/main/.github/workflows/main.yml)
• use a new custom/base recipe that supports 2.7 (and ideally 3.5, which some SBCs still use)

commands to a real Mochad server buffer up and do not execute immediately

Reported in clach04/home-assistant-x10#1

Suspect this is due to \n rather than \r usage, https://github.com/zonyl/pytomation/blob/master/pytomation/interfaces/mochad.py#L151 is using 0x0d as teminator. x10_any has only been tested with a fake server so far.

auto publish via GitHub actions to PyPi

See https://github.com/simonw/python-lib-template-repository for what appears to be a robust complete solution to this for new projects with builtin actions.

x10_any/cm17a.py is not thread safe

Simple test case (note requires hardware) will silently fail, devices will not change state:

#!/usr/bin/env python3

import threading

import x10_any

#x10_any.default_logger.setLevel(x10_any.logging.DEBUG) # DEBUG


class X10(threading.Thread):
    def __init__(self, house_code, house_num):
        threading.Thread.__init__(self)
        self.house_code = house_code
        self.house_num = house_num
        #print('%r' % ((self.house_code, self.house_num),))

    def run(self):
        # TODO use same device, probably not?
        dev = x10_any.FirecrackerDriver()
        #dev = x10_any.FirecrackerDriver('COM11')
        #dev = x10_any.FirecrackerDriver('/dev/ttyUSB0')

        #print('%r ON' % ((self.house_code, self.house_num),))
        #print('%r OFF' % ((self.house_code, self.house_num),))
        dev.x10_command(self.house_code, self.house_num, x10_any.ON)
        dev.x10_command(self.house_code, self.house_num, x10_any.OFF)


# TODO there are better ways than this....

c4 = X10('C', 4)
c6 = X10('C', 6)

c4.start()
c6.start()

# wait to stop
"""
c4.join()
c6.join()
"""