Fork me on GitHub

pimatic-raspbee by Kosta (treban) | github | npm

pimatic-raspbee

build status version downloads license

This plugin provides a raspbee interface for pimatic.

Features

  • Auto-discover devices, groups and sensors
  • Control lights
  • Control groups
  • Control scenes
  • Support for all sensors
  • Observe changes over websocket
  • Start pairing for new devices
  • Backup the deconz config

Prerequisite

You need a rasbpee or conbee device and the deCONZ REST API must be installed and configured.

An other good solution is to run deconz as a docker container.

=> go to the WIKI - there are installation instructions and other useful tips.

Installation

Just activate the plugin over the pimatic webUI. The plugin manager automatically installs the package with his dependencys.

Configuration

You can also load the plugin by adding following in the config.json from your pimatic server:

{
  "plugin": "raspbee",
  "debug": true,
  "active": true,
  "ip": "<deconz ip>",
  "port": "<deconz port>"
}

Usages

To create a connection to the raspbee gateway, the gateway must be unlocked over the deconz UI. check the unlock howto Then make a device discovery in pimatic.

Supported devices

Lights

pimatic Device type Feature Deconz Resource Type
RaspBeeSwitch switch on/off On/Off plug-in unit & Smart plug
RaspBeeDimmer switch and dimm light Dimmable light
RaspBeeCT change temperature Color temperature light
RaspBeeRGB change color Color light
RaspBeeRGBCT change color and temperature Extended color light

HINT: The Color device does not support color temperature. That's why i changed the device mapping.

Groups

pimatic Device type Feature Deconz Resource Type
RaspBeeDimmerGroup (DEPRECATED) switch and dimm Group
RaspBeeRGBCTGroup (NEW) change color and temperature Group
RaspBeeGroupScenes switch scene on Group Scenes

I have created a new group device with all color controls.

Sensors

All sensors are represented as a RaspBeeMultiDevice.

The device has 3 arrays.

  • associated device IDs
    This array contains all device ID associated to this object.

  • support parameter flag
    This array contains all supported attributes.

  • configMap
    During a device discovery, the config map is filled automatically. Customizable values ​​are stored in this config map. A custom config can be written to the API via the button on the new RaspBeeSystem device.

Supported resource types:

supports parameter flag Feature Deconz Resource Type
battery % (any battery-powered sensor)
lowbattery bool (any IAS Zone sensor)
carbon bool ZHACarbonMonoxide
switch string ZHASwitch
fire bool ZHAFire
humidity % ZHAHumidity
temperature °C ZHATemperature and any sensor with temperaure support
presence bool ZHAPresence
dark bool ZHAPresence & ZHALightLevel
lux lux ZHALightLevel
daylight bool ZHALightLevel
open bool ZHAOpenClose
pressure hPA ZHAPressure
water bool ZHAWater
vibration bool ZHAVibration
tampered bool (any IAS Zone sensor)
consumption Wh ZHAConsumption
power W ZHAPower & ZHAConsumption
voltage V ZHAPower
current mA ZHAPower

The other device types are DEPRECATED

  • RaspBeeMotionSensor
  • RaspBeeContactSensor
  • RaspBeeLightSensor
  • RaspBeeSwitchSensor
  • RaspBeeWaterSensor

RaspBeeSystem device

discover lights & discover sensors

This button starts a light or sensor detection from the deconz api.

create backup

This button creates a local backup of the deconz config.
The target folder is configurable. (default folder is the pimatic-app folder)

send config

This button sends for all devices all config parameter (configMap) to the deconz apikey.

ActionProvider

  • "activate group scene -name-"

  • "set color temp -name- to -value-"

  • "set color rgb -name- to -hexvalue-"

  • "dim raspbee -name- to -value-"

Example:
set color temp Light 1 to 10 and set color rgb Light 3 to #121212 and activate group scene All-ON

Optional a -transtime- can be specified. This allows the changeover to be time-controlled.

Example:
dim raspbee Flur to 100 transition time 2s and set color rgb Light RGB to #FF0000 with transition time 2s

PredicateProvider

  • "received from -name- event "2001""

Example: recieved from Switch1 event "2001"

ButtonEvents

Value Action
0 x000 Initial Press
1 x001 Hold
2 x002 Release (after press)
3 x003 Release (after hold)
4 x004 Double press
5 x005 Triple press
6 x006 Quadruple press
7 x007 Shake
8 x008 Drop
9 x009 Tilt
10 x010 Many press

CHANGELOG

-> see CHANGELOG


Contributors

Plugin Config Options

RaspBee plugin config options
OptionDescriptionDefault
debug
boolean
Enabled debug messages
false
ip
string
IP address from the deconz rest api
port
string
port from the deconz rest api
80
apikey
string
api key
""

Device Config Options

raspbee

RaspBeeSystem

Control Center Device properties
OptionDescriptionDefault
deviceID
integer
Raspbee device id
networkopenduration
integer
Scan for new device duration
60
backupfolder
string
backupfolder

RaspBeeMotionSensor

RaspBee MotionSensor
OptionDescriptionDefault
resetTime
integer
Reset time in seconds
60
sensorIDs
array of integers
All the ids of the sensors
[]
supportsBattery
boolean
does this sensor have a battery?
false
supports
array of strings
Feature List
[]

RaspBeeContactSensor

RaspBee ContactSensor
OptionDescriptionDefault
resetTime
integer
Optional auto reset time in milli seconds
0
sensorIDs
array of integers
All the ids of the sensors
[]
supportsBattery
boolean
does this sensor have a battery?
false
supports
array of strings
Feature List
[]

RaspBeeLightSensor

RaspBee LightSensor
OptionDescriptionDefault
sensorIDs
array of integers
All the ids of the sensors
[]
supportsBattery
boolean
does this sensor have a battery?
false
supports
array of strings
Feature List
[]

RaspBeeSwitchSensor

RaspBee SwitchSensor
OptionDescriptionDefault
resetTime
integer
Auto reset time in milliseconds
false
sensorIDs
array of integers
All the ids of the sensors
[]
supportsBattery
boolean
does this sensor have a battery?
false
supports
array of strings
Feature List
[]

RaspBeeWaterSensor

RaspBee WaterSensor
OptionDescriptionDefault
sensorIDs
array of integers
All the ids of the sensors
[]
supportsBattery
boolean
does this sensor have a battery?
false
supports
array of strings
Feature List
[]

RaspBeeRemoteControlNavigator

RaspBee MotionSensor
OptionDescriptionDefault
deviceID
integer
Raspbee device id
buttons
array of objects
Remote buttons
Elements

RaspBeeSwitch

Raspbee Switch Device
OptionDescriptionDefault
deviceID
integer
Raspbee address

RaspBeeDimmer

Raspbee Dimmer Light Device
OptionDescriptionDefault
deviceID
integer
Raspbee address
transtime
integer
Raspbee transtime
5

RaspBeeCT

Raspbee Color Temperature Light Device
OptionDescriptionDefault
deviceID
integer
Raspbee address
transtime
integer
Raspbee transtime
5

RaspBeeRGB

Raspbee Color Temperature Light Device
OptionDescriptionDefault
deviceID
integer
Raspbee address
transtime
integer
Raspbee transtime
5

RaspBeeRGBCT

Raspbee Color Temperature Light Device
OptionDescriptionDefault
deviceID
integer
Raspbee address
transtime
integer
Raspbee transtime
5

RaspBeeDimmerGroup

Raspbee Dimmer Light Device
OptionDescriptionDefault
deviceID
integer
Raspbee address
transtime
integer
Raspbee transtime
5

RaspBeeRGBCTGroup

Raspbee Dimmer Light Device
OptionDescriptionDefault
deviceID
integer
Raspbee address
transtime
integer
Raspbee transtime
5

RaspBeeMultiSensor

Raspbee Multi sensor
OptionDescriptionDefault
deviceID
string
Raspbee address
sensorIDs
array of integers
All the ids of the sensors
[]
supportsBattery
boolean
does this sensor have a battery?
false
supports
array of strings
Feature List
[]
configMap
array of objects
Config map
[]
Elements
temperatureAcronym
string
temperature acronym
"T"
humidityAcronym
string
humidity acronym
"H"
pressureAcronym
string
pressure acronym
"P"
powerAcronym
string
power acronym
"P"
currentAcronym
string
power acronym
"I"
voltageAcronym
string
voltage acronym
"U"
consumtionAcronym
string
consumtion acronym
"W"
resetTime
integer
Auto reset time in milliseconds
100

RaspBeeGroupScenes

RaspBeeScenes
OptionDescriptionDefault
deviceID
integer
Raspbee address
buttons
array of objects
Scene buttons
Elements
pimatic-raspbee is written by Kosta (treban)