Clipsal C-Bus Guide de l'utilisateur

cbus DocumentationRelease 0.1-devMichael FarrellDecember 10, 2014

cbus Documentation, Release 0.1-dev6 Chapter 1. Introduction

CHAPTER 2HackingInformation about using the hardware and software.2.1 Official documentationOfficial serial protocol documentation is available from Cli

cbus Documentation, Release 0.1-dev2.3 Setting up a fake CNI and sniffing the protocolIf you want to see how Toolkit interacts with a Serial PCI, use t

cbus Documentation, Release 0.1-dev2.5 Unit TestsThere’s some basic unit tests that are written that require you have the nosetests package (nose on p

cbus Documentation, Release 0.1-dev10 Chapter 2. Hacking

CHAPTER 3CNI DiscoveryAt the moment this is a rather unorganised set of notes while I’m still figuring out the protocol.I’ve started working on a test

cbus Documentation, Release 0.1-devProduct IDs:• 01: CNI2• 02: Hidden – Toolkit ignores packets with this product ID. May be used for internal develop

CHAPTER 4WiserThe Wiser is a rebadged SparkLAN WRTR-501 802.11b/g/draft-n WiFi Router with custom firmware. It runs anembedded Linux system, with an ex

cbus Documentation, Release 0.1-dev4.2 Protocol4.2.1 Discovery and HandshakeAfter the SWF is started, it loads the configuration file from /clipsal/reso

cbus Documentation, Release 0.1-dev<ka cbus_connected="1" /><cbd_version version="Kona_1.24.0" /><net_status cni_tr

cbus Documentation, Release 0.1-dev4.4 CFTPCFTP is a service which acts as a back-door into the device. It runs on port 8336, and is managed by the se

cbus Documentation, Release 0.1-dev4.4.3 Authenticated stateWhen in the authenticated state, the network code appears to be far less robust. Sending l

cbus Documentation, Release 0.1-devGETFILELISTClient command:GETFILELISTServer response:202 FILE1=C:\HomeGate\Projects\Current\EXAMPLEproj.tar.gzRetri

cbus Documentation, Release 0.1-dev– cftp_daemon will not be able to copy a new project file into RAM temporarily for flashing, and may be perma-nently

cbus Documentation, Release 0.1-dev20 Chapter 4. Wiser

CHAPTER 5daemonsThe cbus.daemon package defines a number of daemons used to interact with the C-Bus network.5.1 cdbusdcdbusd is a daemon that is used t

cbus Documentation, Release 0.1-dev• saged which is a backend WebSockets server that translates WebSockets messages into messages in cdbusd,and implem

cbus Documentation, Release 0.1-dev• locations: A dictionary of locations, with the key representing the ID of the location, and the value repre-senti

cbus Documentation, Release 0.1-dev5.3.3 ScreenshotsAndroid (Chrome)24 Chapter 5. daemons

cbus Documentation, Release 0.1-dev5.3. sage 25

Contents1 Introduction 31.1 What is CBus? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31.2 Clipsal’s o

cbus Documentation, Release 0.1-deviOS “Web App”26 Chapter 5. daemons

cbus Documentation, Release 0.1-dev5.3. sage 27

cbus Documentation, Release 0.1-dev5.4 stagedstaged is a scene control daemon. This isn’t finished yet.It connects to cdbusd, and allows you to create

CHAPTER 6dump_labels utilitydump_labels parses a Toolkit backup file (CBZ) and prints out group and unit address labels into a JSON file.It will remove

cbus Documentation, Release 0.1-dev30 Chapter 6. dump_labels utility

CHAPTER 7D-Bus Client APIThe recommended way to interact with libcbus is through cdbusd and it’s D-Bus API.It allows many applications, written in any

cbus Documentation, Release 0.1-dev• level (d) – An amount between 0.0 and 1.0 indicating the brightness to set.Returns Single-byte string with code f

CHAPTER 8libcbus module index8.1 cbus PackageThis is the package where all C-Bus modules are defined.8.1.1 Common functionscbus.common defines various c

cbus Documentation, Release 0.1-devThrows ValueError If the given duration is too long and cannot be represented.cbus.common.get_real_cbus_checksum(i)

cbus Documentation, Release 0.1-devclass cbus.protocol.base_packet.SpecialPacketBases: cbus.protocol.base_packet.BasePacketchecksum = Falsedestination

Python Module Index 51ii

cbus Documentation, Release 0.1-devapplication = Noneclassmethod decode_packet(data, checksum, flags, destination_address_type, rc, dp, priority_class)

cbus Documentation, Release 0.1-devParameters line (str) – CBus event dataReturns Remaining unparsed data (str) or None on error.Return type str or No

cbus Documentation, Release 0.1-devReturn type stringlineReceived(line)Called by LineReciever when a new line has been recieved on the PCI connection.

cbus Documentation, Release 0.1-devon_lighting_label_text(source_addr, group_addr, flavour, language_code, label)Event called when a group address’ lab

cbus Documentation, Release 0.1-devconnectionMade()Called by twisted a connection is made to the PCI.This doesn’t get fired in normal serial connection

cbus Documentation, Release 0.1-devlighting_group_terminate_ramp(source_addr, group_addr)Stops ramping a group address at the current point.Parameters

cbus Documentation, Release 0.1-devApplicationsRunning ontop of the C-Bus protocols are applications.This package provides encoders and decoders for a

cbus Documentation, Release 0.1-devParameters• packet (cbus.protocol.base_packet.BasePacket) – The packet that this SAL is to be includedin.• variable

cbus Documentation, Release 0.1-devclassmethod decode(data, packet)Decodes a enable control application packet and returns it’s SAL(s).Parameters• dat

cbus Documentation, Release 0.1-devBase type for lighting application SALs.This should not be called directly by your code!Use one of the subclasses o

cbus Documentation, Release 0.1-devProject Page / Source repository: https://github.com/micolous/cbuslibcbus is a set of Python libraries for interact

cbus Documentation, Release 0.1-devclass cbus.protocol.application.lighting.LightingOffSAL(packet, group_address)Bases: cbus.protocol.application.ligh

cbus Documentation, Release 0.1-devclass cbus.protocol.application.temperature.TemperatureSAL(packet=None,group_address=None)Bases: objectBase type fo

cbus Documentation, Release 0.1-devThis library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even theimplied w

CHAPTER 9Indices and tables• search49

cbus Documentation, Release 0.1-dev50 Chapter 9. Indices and tables

Python Module Indexccbus.common, 33cbus.protocol.application.clock, 42cbus.protocol.application.enable, 43cbus.protocol.application.lighting, 44cbus.p

cbus Documentation, Release 0.1-dev52 Python Module Index

IndexAadd_cbus_checksum() (in module cbus.common), 33application (cbus.protocol.pm_packet.PointToMultipointPacketattribute), 35application_addr1 (cbus

cbus Documentation, Release 0.1-devdecode_cbus_event() (cbus.protocol.pciprotocol.PCIProtocolmethod), 36decode_cbus_event() (cbus.protocol.pciserverpr

cbus Documentation, Release 0.1-devlighting_group_terminate_ramp(), 32lighting_group_terminate_ramp()(cbus.protocol.pciprotocol.PCIProtocolmethod), 37

cbus Documentation, Release 0.1-dev2 Contents

cbus Documentation, Release 0.1-devSpecialServerPacket (class in cbus.protocol.base_packet),35status_request (cbus.protocol.pm_packet.PointToMultipoin

CHAPTER 1IntroductionWelcome to libcbus!This is a Python library for interacting with Clipsal CBus units, and provides some additional utility functio

cbus Documentation, Release 0.1-devlibcbus also includes an abstraction daemon called cdbusd which will allow multiple applications to simultane-ously

cbus Documentation, Release 0.1-dev1.4.2 Mac OS XIn order to run this software, you’ll need to first install Xcode (from the App Store) and MacPorts.Yo