Creasol DomBus1: Domoticz-Karte mit 2 Relais, 6 Eingängen, 1 AC-Eingang

---

---

Ports parameters

Parameter name	Function
HWADDR=0xNNNN	This command set new address for the dombus device: reload the Switch panel to see the new devices associated with the new address of DomBus. NNNN is an exadecimal number, from 0x0001 to 0xff00, so 65280 combinations are available. Keep note of address assegnated to each dombus device, because in case of address conflict it's needed to switch off one of the conflicting device and program the remaining one to another address, or make a factory reset as explained below.
INVERTED	Used to invert the logic state of an input or output. Can be used in conjuction with OUT_DIGITAL, OUT_RELAY_LP, IN_DIGITAL, DIMMER. Normally, domoticz switch is On if input is at logic level high (open), and Off when it's shorted to ground. If INVERTED is specified, domoticz switch will be On when the corresponding input is shorted to ground, and vice versa.
OUT_DIGITAL	Output, open collector, active low, On => output wire is shorted to GND (max current 50mA). Off => output is open (current=0).
OUT_RELAY_LP	Not recommended: output, open collector, active low, but with duty cycle 25% to reduce power consumption on relays coil
OUT_DIMMER	Set the output as DIMMER, from 0 to 100% using 5% step, 500Hz frequency. Suitable to control LED strip lights
OUT_BUZZER	Set two outputs as BUZZER: a piezo buzzer can be connected to the selected two ports (configured in push-pull) to generate 5KHz frequency when the corrsponding Domoticz switch is On. The Domoticz switch can be configured as selector: in this case buzzer will output 1 or more short alerts to notify a status, similarly to the led configured as OUT_DIGITAL with Domoticz switch configured as Selector.
OUT_BLIND	Port configured to control a blind, in close direction. Next port will be automatically configured as blind in open direction. Ports OUT1 and OUT2 can directly be connected to 12V relay coils (if Vbus is 12-14V, or 24V relay coils if Vbus is 24V). Ports IN1..IN3 can be configured as OUT_BLIND, but in this case should be connected to relayboard that already have a transitors/optocouplers to drive relays.
OUT_LEDSTATUS	Configure a LED port to show the device status (flashes when a frame is transmit to the RS485 bus)
OUT_ANALOG	Set output as analog, with 0-10V linear output. It can be used to control another electronic board with 0-10V or 1-10V input (light dimmer, heat pump power, linear valve, ....)
IN_DIGITAL	Digital input, is On when the corresponding input is at high voltage level (open), and Off when the corresponding input is at GND (shorted).
IN_ANALOG	In DomBusTH there is one pad/hole where it's possible to solder a wire to measure an external DC voltage, <30Vdc; a solder jumper must be opened (because that pad is connected to Vbus). Also, one or more of the 4 input wires can be configured as analog inputs, 0-3V range: a solder jumper in the PCB must be opened by cutter to disable the internal pullup resistor. Also, external resistive divider should be added to measure higher voltages, so the voltage at the input is less equal than 3V. On DomBus12 it's possible to use IO7-IO9 ports as analog inputs. Also, it's possible to use IO1-IO4 ports as analog inputs, but in this case it's needed to open, using a cutter, the corresponding PCB jumper PU1-PU4 (that internally connect the input line with a 10k pullup resistor): for example, to use IO1 as analog input, the PU1 PCB jumper must be open. Analog voltage must not exceed the 0-3V range: if voltage range is higher, a resistive divider must be applied externally. On DomBus23 only IO1 and IO2 ports can be configured as analog inputs: only 0-3V range is supported, and a resistive divider must be externally connected to measure higher voltages.
IN_COUNTER	Used to count pulses, falling edge (or raising edge if INVERTED option is specified) with debounce (5 pulses/sec max). This solution is perfect to count energy, gas, water, ...If TYPENAME=kWh is also specified in Description, a device with both energy and power will be created.
IN_TWINBUTTON	This is a method to connect two pushbuttons/switches to a single input, to get a UP/DOWN/STOP select switch. The two switches are connected together by a 4.7KOhm resistor, using the schema indicated in the application notes below.
A	For analog and distance sensors: used to compute the real value using the formula  REAL_VALUE=A * VALUE_FROM_DOMBUS + B.
B	For analog and distance sensors: used to compute the real value using the formula  REAL_VALUE=A * VALUE_FROM_DOMBUS + B
TYPENAME	Option to force the creation of a the specified Domoticz. For example, IN_COUNTER,TYPENAME=kWh to create a energy/power meter instead of a normal incremental counter, or IN_ANALOG,TYPENAME=Temperature,A=0.123,B=-50 to get an analog input that return a temperature using the linear equation Temperature=A*x+B where x is the analog value read
OPPOSITE	Used for kWh devices, measuring electric power and energy. Suppose to have a PowerMeter Import device, with Unit=98 (see Setup ⇒ Devices), measuring the power/energy from grid, and PowerMeter Export, with Unit=99, measuring the power/energy produced and fed to the grid. If these devices are connected to the pulse output of an energy meter, when a pulse is received from the Import device it means that exported power is 0, and vice-versa. This parameter is used to set what is the Unit number associated to the opposite counter. So, PowerMeter Import description must have IN_COUNTER,TYPENAME=kWh,OPPOSITE=99 and PowerMeter Export description IN_COUNTER,TYPENAME=kWh,OPPOSITE=98
DISABLE	Used to disable one or more ports: it can be usedful with large buses with more than 255 ports (devices), because Domoticz has a limit of max 255 devices for each bus. In this case it's possible to disable unused module ports by writing, in the Description of port 1, the list of disabled ports separated by colon, for example DISABLE=2:5:6:7:11 to disable ports 2,5,6,7,11 of the current module. Port 1 can be never disabled. To enable a previosly disabled port, just edit the port 1 description for that module, removing the port from the list of DISABLE command: that port will be enabled again in 60 seconds (wait for 1 minute and reload the Domoticz panel).
DCMD	Dombus Command: through this keyword it's possible to set a command to send to the same or another module, when an event occurs. In this way, when an event occurs, the module send a command to a dombus module to execute an operation, and this work without the need of a Domoticz controller and without the need to configure Domoticz to manage this kind of actions. See the DCMD section below.

DCMD commands

This is an experimental function, undergoing testing and development, available on DomBusTH, DomBus12, DomBus23, DomBus31 modules.

For each port it's possible to configure, through the Domoticz Description field, one or more DCMD commands.

DCMD is a command that is sent to the same or to another DomBus module, in response to an event, and more DCMD commands can be specified for the same event and port.

The syntax is DCMD(Event:ValueLow:ValueHigh)=ModuleAddress.ModulePort:Command:Value

where ValueLow, ValueHigh, Value are optional parameters.
When ModuleAddress corresponds to the same module that we're editing, the command is executed locally, by the same module.
When ModuleAddress corresponds to another Dombus module, the command is sent by bus to that module.

DCMD: list of possible events

Event	Description	Example
OFF	This even occurs when input goes OFF	DCMD(OFF)=13.1:OFF When input goes off, turns OFF also port 1 of module 13
ON	This even occurs when input goes ON	DCMD(ON)=13.2:ON:90s When input goes on, turns ON port 2 of module 13 for 90s
PULSE	Input is pulsed ON for less than 0.5s	DCMD(Pulse)=13.3:TOGGLE When input is pulsed shortly, send command to module 13 port 3 to toggle it's output OFF->ON or vice versa
PULSE1	Input is pulsed ON for about 1s	DCMD(Pulse1)=13.3:ON When input is pulsed for 1s, turns ON port 3 of module 13
PULSE2	Input is pulsed ON for about 2s	DCMD(Pulse2)=13.3:OFF When input is pulsed for 2s, turns OFF port 3 of module 13
PULSE4	Input is pulsed ON for about 4s	DCMD(Pulse4)=13.4:ON:2h When input is pulsed for 4s, turns ON port 4 of module 13 for 2 hours
DIMMER
VALUE	Sensor value is in the range between ValueLow an ValueHigh	DCMD(Value:0:20.5)=13.5:ON DCMD(Value:21:50)=13.5:OFF Turns ON output 13.5 when temperature is below 20.5°C, and turns OFF when above 21°C DCMD(Value:0:12.2)=31.7:ON DCMD(Value:13.8:20)=31.7:OFF Turns ON port 31.7 when the current voltage is below 12.2V, and turns OFF when voltage is above 13.8V

 

DCMD: list of possible commands

Command	Description	Example
OFF	Turns output OFF. If the optional Value is specified, output will be OFF for the specified time, then returns ON
ON	Turns output ON. If the optional Value is specified, output will be ON for the specified time, then returns OFF
TOGGLE	Change state to the selected output. If the optional Value is specified, wait the specified time before toggling output
DIMMER

 

Value optional parameter: list of possible values for the command

Command	Description	Example
number	A number without any suffix should be multiplied by 31.25ms (seconds/32)	1=31.25ms 3=93.75ms 16=500ms
numberS	Number of seconds, from 1 to 3600	1s=1 second 60s=1 minute 100s, ....
numberM	Number of minutes, from 1 to 1440	1m=1 minute 10m=10 minutes 180m=3 hours
numberH	Number of hours, from 1 to 43824	1h=1 hour 6h= 6 hours 72h=3 days
numberD	Number of days, from 1 to 1826	1d=1 day ....

 

Examples 1: configure a pushbutton switch to have 3 functions:

short pulse => toggle ON/OFF light
1 second pulse => enable ventilation for 30s
2 seconds pulse => disable ventilation

This 3 events can be configured writing in the description of the pushbutton switch:
DCMD(Pulse)=0101.1:TOGGLE, (with a short pulse, toggle port 1 of module 0x0101)
DCMD(Pulse1)=0101.2:ON:30m, (with 1 second pulse => turn on port 2 of 0x0101 for 30 minutes)
DCMD(Pulse2)=0101.2:OFF, (with 2 seconds long pulse, turn OFF the port 2 of 0x0101)

The Domoticz switch Description will be

IN_DIGITAL,INVERTED,
DCMD(Pulse)=0101.1:TOGGLE,
DCMD(Pulse1)=0101.2:ON:30m,
DCMD(Pulse2)=0101.2:OFF

Example 2: temperature sensor that enable/disable electric heater and valve

In the description field of the temperature sensor we'll write

DCMD(Value:0:20.5)=0101.3:ON, (if temperature between 0 and 20.5°C, turns ON heater on output 3 of module 0x0101)
DCMD(Value:0:20.5)=0102.1:ON, (if temperature between 0 and 20.5°C, turns ON valve output 1 of module 0x0102)
DCMD(Value:20.8:50)=0101.3:OFF (turn OFF heater when temperature above 20.8°C)
DCMD(Value:20.8:50)=0102.1:OFF (turn OFF valve when temperature above 20.8°C)
Domoticz temperature sensor Description will be:

TEMPERATURE,
DCMD(Value:0:20.5)=0101.3:ON,
DCMD(Value:0:20.5)=0102.1:ON,
DCMD(Value:20.8:50)=0101.3:OFF,
DCMD(Value:20.8:50)=0102.1:OFF

 

Installation

Using RS485 specific cables it's possible to get almost 1km linear bus with several devices attached. Alternatively, it's possible to use 2 twisted pairs of cheap Cat6 UTP or STP cable, one twisted pair for data (A and B) and one for 12-24V power supply. Ideally, all devices should be connected using a linear bus topology, to get the lowest reflection/noise, and connect 100-150 Ohm resistor on the two ends, as illustrated in the Fig. 2. In practice, this is not important for common buildings.

At Raspberry/PC side, it's possible to use a cheap USB-RS485 adapter, if a serial port with RS485 driver is not already available.

Using DomBus modules it's possible to:

1. avoid RF pollution
2. no need to periodically change batteries on sensors/actuators
3. using a UPS or  13.6V power supply with backup battery, it's possible to get a building automation system that works also in case of power outage
4. very very low power consumption

 

Writing a microSD card with a fresh Raspbian + Domoticz distribution

Click here if you need to write a microSD card with a clean updated Raspbian+Domoticz image optimized to extend SD life (minimizing writings), and with some addons (firewall, backup, libraries).

Adding DomBus plugin to Domoticz

This procedure is not needed in case of a new Domoticz installation writing the SD as written above.
If Domoticz does not already include the DomBus plugin, type the following commands (from Linux root shell: type sudo su - to become root):

#install git, if not already installed
which git
if [ $? -ne 0 ]; then sudo apt install git; fi

#change to the domoticz directory / plugins
cd /home/pi/domoticz/plugins 

#fetch the Python Plugin Manager (that can be used to install/upgrade other plugins, including Creasol DomBus)
git clone https://github.com/ycahome/pp-manager

#fetch Creasol Plugin
git clone https://github.com/CreasolTech/CreasolDomBus

#restart Domoticz daemon
service domoticz restart

Domoticz configuration

After plugins installation and Domoticz restart, it's possible to add the Creasol DomBus hardware (Setup->Hardware , add new "dombus" hardware type "Creasol DomBus" and specify the serial device, normally /dev/ttyUSB0) and connect the DomBus device to the RS485 bus.
DomBus module is factory programmed with a default address indicated above, and only one port will be automatically added to the Switches panel of Domoticz. Enter the Switches panel, find the new device with the DomBus default address, click on Edit and add in the description ,HWADDR=0x0001 to set the new address to 0001, or specify another address of your choice. Reload the Switches panel to see all input/output/led ports of DomBusTH active.

With Domoticz, each DomBus port can be configured via the Domoticz device description: for example a port IN_DIGITAL normally is On when it's left unconnected, and Off when it's shorted to GND, but it's possible to invert this function specifying in the device description the parameter INVERTED, separated by a comma (,): IN_DIGITAL,INVERTED . Relay outputs can be configured writing in the description field OUT_DIGITAL or OUT_RELAY_LP: in the latter case, relay are internally managed to assure a low power consumption.
Please check the sections Ports capabilities and Ports parameters.

Ports that are not used can be disabled in Domoticz Setup ⇒ Devices clicking on the blue arrow of each useless port (device), but in case of a bus with almost 255 ports, it's suggested to disable the unused ports by using the DISABLE command:
1. suppose that DomBus module 0x0001 has ports 3,4,5,6,8 not used
2. in Domoticz Switches panel select port1 of that module ([0001.1] RL1)
3. click on Edit, and add in the Description field DISABLE=3:4:5:6:8 and click on Save.
In this way, the selected ports will be disabled and removed from the Devices list. With this solution it's possible to add more DomBus modules to the same bus, with up to 255 enabled ports. In large buildings, it's a good practice to have more than one bus, to divide floors or areas.

Installing CreasolDomBus Home Assistant custom component

The integration code is available at https://github.com/CreasolTech/home-assistant-creasol-dombus
The following commands should be executed in the linux shell: for people using Windows, use git UI to download the custom component and place it in the right directory.

cd /tmp
git clone https://github.com/CreasolTech/home-assistant-creasol-dombus.git
cp -a home-assistant-creasol-dombus/custom_components HADIR/config/
ha core restart

where HADIR is the Home Assistant root dir: in case of Hassio, use the command cp -a home-assistant-creasol-dombus/custom_components /config/
After reboot of Home-Assistant, this integration can be added through the Configuration -> Integrations -> + ADD INTEGRATION and selecting Creasol DomBus integration.

FAQ about DomBus products

How can I change address of DomBus1 device?

DomBusTH is factory programmed with address 0xff51 : please connect only 1 new/unprogrammed DomBusTH to the existing bus, and you'll find one "switch" device in the Domoticz Switches panel with name "dombus - [Hff51] OUT1" or something similar.
Click on the Edit button of that switch and add the following text to its description:  ,HWADDR=0x0001  (don't forget the comma used to separate each parameter) to set the new address to 0001, ot another not-used value.
DomBus device will be set to the specified address, then you'll find in the Switches panel all ports with the selected address.
At this point you can add another new dombus device, and change its address in the same way.

DomBusTH: how to do a factory reset?

Normally, factor reset is not needed because, enabling debug on Domoticz controller, it's always possible to know the address of a device, changing its address, and for each port change it's configuration through the Domoticz web panel.
Anyway, it's possible to do a factory reset in this way:

1. Disconnect the device
2. Solder the PCB jumper a to force IN4 in low impedance (150 Ohm resistor)
3. Connect together IN1, IN2, IN3, IN4 wires
4. Connect the device to the power supply: you can see a red flash 500ms long, that notify that configuration was restored to the factory default.
5. If IN4 is used as input, remove the solder bump on PCB jumper a

How many DomBus modules can I connect to a bus?

Domoticz has a limit of 256 devices (I/O) to a single hardware, and this correspond to 20-30 DomBus modules (it depends by the number of I/O/Sensors for each module).
It's possible to have more than one bus, each bus associated to one RS485 port: for example for large buildings or if it's needed to differentiate the buses to increase system security, it's possible to use many RS485/USB adapters connected to Domoticz, one for each bus.

Why there is a long delay between pushing a button and get light/output on?

Some possible problems that lead to long latency are:

1. bus is not terminated by resistors: RS485 is a balanced bus, and need two resistors 100-150 ohm connected to the two opposite end of the bus.
   RESISTOR --- Module1 --- Module 2 --- Raspberry --- ..... --- Module 20 --- Module 21 --- RESISTOR between A and B
   Some DomBus modules have a PCB jumper that can be shorted (using a solder iron) to enable the RS485 resistor already included in the module.
   There must be exactly 2 resistors connected on the bus!
2. Latency can be caused by Domoticz being busy with other services. Disable hardware that is not used or not needed, like Python Plugin Manager that is known to cause longer latencies. Also, enable logging so you can check exactly what is the latency reason (Domoticz reading the Raspberry internal sensors/cpu usage/disk usage, for example).
3. Update DomBus plugin to the last version: you can install/enable Python Plugin Manager, update all python plugins (including Creasol Dombus) and then disable it.

Why DomBus device does not work?

1. Are you using Domoticz? Does it work?
2. Did you installed the Creasol DomBus plugin on Domoticz? If not, check the Configuration section above
3. If you open the Domoticz web panel, and enter Settings -> Hardware, can you find the Creasol DomBus protocol ? Did you enable it? If not, check the Configuration section above
4. When you connect the DomBus device to the RS485 bus, can you see a new device in the Domoticz Switches panel? if not, the device cannot communicate to Domoticz by RS485 serial bus. In this case, check that:
  a) DomBus device is supplied by 12Vdc or similar voltage
  b) RS485 bus is connected (A, B, GND) to Domoticz (Raspberry or other hw) through the USB/RS485 adapter or other RS485 adapter
  c) Verify that the DomBus protocol on Domoticz is configured correctly (115200bps and right serial device), and that there are not 2 DomBus hardware with in Domoticz with the same serial port

Why current consumption is 0uA?

DomBus devices have a serie protection resistor, 2.2 Ohm, acting as a fuse when the user forget to protect 12V power supply by a fuse. Maybe the resistor is burned (you can check using an ohm-meter) and can be replaced by another resistor or, if you know what you do, by a short circuit.
DomBus1: first version of DomBus1 was not protected against polarity inversion, and switching mode power supply circuitry break down in case of polarity inversion opening the circuit. If you have a solder iron, you can try DomBus1 connecting a 5Vdc power supply to +5V indicated by the red arrow, and GND terminal block. Click to see the picture!
DomBusTH: Check polarity: the first wire (black) is ground (0V) and the second wire (brown) V+ (normally, +12V). DomBusTH is protected against polarity inversion.

---

DomBus software ChangeLog

2021-03-16

Added IN_COUNTER type, used to count pulses from electric meter, gas meter, water meter, .... Max pulse frequency = 5Hz (input is debounced), min transmission period = 5s (accumulate pulses if frequency is greater than 0.2Hz, to avoid high CPU usage by Domoticz.

Added TYPENAME=kWh option, to get an electric Power/Energy meter: this device computes both energy (proportional to the number of pulses) and power (frequency of pulses).

Added OPPOSITE=Unit option, associated to kWh devices (power/energy meters): when the opposite device receives a pulse, power for the current device is immediately set to 0 Watt
For example: PowerMeter_Import, with Unit=98. PowerMeter_Export, with Unit=99
On PowerMeter_Import description, add ,OPPOSITE=99, and in PowerMeter_Export description add ,OPPOSITE=98 : in this way when a pulse is received from the import device, the power on export device will be set to 0, and viceversa.
After powerOn, the module transmits its firmware version and module name, logged by Domoticz with priority INFO.

---

Need help? join the DomBus channel on Telegram!
Esiste anche il Canale Telegram in Italiano DomBus_it!

Facebook domoticz groups:
Domoticz community, Domoticz Italia, Domoticz France, Domoticz Nederland, ... just search Domoticz on Facebook!