Walter vl: /* Setting up a USB hardware */

2025-03-28T15:49:29Z

Setting up a USB hardware

← Older revision		Revision as of 15:49, 28 March 2025
Line 106:		Line 106:
	First make sure the device is recognized in the system. Domoticz automatically detects the USB port.		First make sure the device is recognized in the system. Domoticz automatically detects the USB port.

	If there are multiple Serial port devices listed choose the one starting with /dev/serial/by-id/ as those are persistent after a reboot.		If there are multiple Serial port devices listed choose the one starting with <code>/dev/serial/by-id/</code> as those are persistent after a reboot.

	If you do not have /dev/serial/by-id/ listed (eg when using an older Linux version) make sure the USB device is made persistent. Check Wiki [[PersistentUSBDevices]]		If you do not have <code>/dev/serial/by-id/</code> listed (eg when using an older Linux version) make sure the USB device is made persistent. Check Wiki [[PersistentUSBDevices]]

	[[File:USB Hardware.png]]<br>		[[File:USB Hardware.png]]<br>

Walter vl: /* Setting up a USB hardware */

2025-02-04T08:54:09Z

Setting up a USB hardware

← Older revision		Revision as of 08:54, 4 February 2025
Line 104:		Line 104:

	===Setting up a USB hardware===		===Setting up a USB hardware===
	First make sure the device is recognized in the system. Domoticz automatically detects the USB port.		First make sure the device is recognized in the system. Domoticz automatically detects the USB port.

			If there are multiple Serial port devices listed choose the one starting with /dev/serial/by-id/ as those are persistent after a reboot.

			If you do not have /dev/serial/by-id/ listed (eg when using an older Linux version) make sure the USB device is made persistent. Check Wiki [[PersistentUSBDevices]]

	[[File:USB Hardware.png]]<br>		[[File:USB Hardware.png]]<br>

Walter vl: /* Update Hardware Gateway */

2024-09-25T11:13:39Z

Update Hardware Gateway

New page

[[Category:Manual]]
__TOC__

Before you can use Domoticz to control your devices you must setup the communication to hardware device(s).

Select menu '''Setup - Hardware''' to add hardware. Devices will not show up in the [[Setup Devices|Device overview list]] until the appropriate hardware is added.

Note: Be sure you have the setting [[Application Settings#Hardware.2FDevice|"Accept new hardware devices]]" in menu Setup - Settings activated else no devices are created! 
[[file:SetupHardware.JPG|link=|Setup hardware]]
==Supported Hardware==
Domoticz supports the below mentioned hardware devices natively. Click on the hardware device link to see more details. Devices that are not supported by the build in Domoticz Hardware but by the Python plugin framework can be found on the following page: '''[[Plugins|Plugins]]'''

The list below is not all, there are various ways to interact with other devices. It is highly recommended to check the forum and wiki pages, including the [[hardware]] overview page.

For [[Zwave-JS-UI]] and [[Zigbee2MQTT]] see the wiki pages [[Zwave-JS-UI]] and [[Zigbee2MQTT]]

{| class="wikitable"
|[[1Wire|1-Wire (System)]]||[[Kodi|Kodi Media Server]]||RFXCOM - RFXtrx shared over LAN Interface
|-
|AccuWeather (Weather Lookup)||[[Limitless/AppLamp_LED|Limitless/AppLamp/Mi Light With LAN/WiFi interface]]||RFXCOM - RFXtrx315 USB 315MHz Transceiver
|-
|Atag One Thermostat||[[I2C Hardware|Local I2C sensors]]||RFXCOM - RFXtrx433 USB 433.92MHz Transceiver
|-
|BleBox devices||[[Harmony_Hub|Logitech Harmony Hub]]||RFXCOM - RFXtrx868 USB 868MHz Transceiver
|-
|Comm5 MA-4XX/MI-XX Serial/USB interface||[[Logitech_Media_Server|Logitech Media Server]]||Rainforest RAVEn USB
|-
|Comm5 MA-SXX with LAN interface||[[MQTT|MQTT Client Gateway with LAN interface]]||[[GPIO|Raspberry's GPIO port]]
|-
|CurrentCost Meter USB||Meteostick USB||[[Zwave|Razberry Z-Wave via LAN interface (HTTP)]]
|-
|CurrentCost Meter with LAN interface||[[X10_devices,_CM15_Pro#Domoticz_.26_Mochad_-_New_style_:_Native_mochad|Mochad CM15Pro/CM19A bridge with LAN interface]]||Rego 6XX USB/serial interface
|-
|[[Daikin_wifi|Daikin Airconditioning with LAN (HTTP) interface]]||[[Motherboard sensors]]||[[S0Meter|S0 Meter USB]]
|-
|[[Weather_forecast_from_forecast.io_in_Domoticz|DarkSky (Weather Lookup)]] / Forecast.io||[[Multifun|Multifun LAN]]||[[S0Meter|S0 Meter with LAN Interface]]
|-
|Davis Vantage Weather Station USB||[[MyHome OpenWebNet Via LAN Interface|MyHome OpenWebNet]]||[[SMASpot_Monitoring_in_Domoticz|SBFSpot (SMA)]]
|-
|[http://denkovi.com/domoticz-with-denkovi-modules Denkovi Modules]||[[MySensors|MySensors Gateway USB]]||Satel Integra via LAN Interface
|-
|[[Setting_up_Device_sharing|Domoticz - Remote Server]]||[[MySensors|MySensors Gateway with LAN Interface]]||[[SolarEdge|SolarEdge via LAN interface]]
|-
|Domoticz Internal interface||[[NefitEasy|Nefit Easy HTTP server over LAN Interface]]||[[SolarEdge|SolarEdge via Web API]]
|-
|[[Dummy for virtual Switches|Dummy (Does nothing, use for virtual switches only)]]||[[NestDeveloperApiKey|Nest Thermostat/Protect]]||SolarMax via LAN Interface
|-
|ETH8020 Relay board with LAN interface||[[Netatmo|Netatmo]]||Sterbox v2-3 PLC With LAN Interface
|-
|[[Eco Devices Via LAN Interface]]||[[Open Weather Map]]||[[System Alive Checker (Ping)]]
|-
|[[EnOcean|EnOcean USB (ESP2)]]||[[Opentherm Gateway OTGW|OpenTherm Gateway USB]]||TE923 USB Compatible Weather Station
|-
|[[EnOcean|EnOcean USB (ESP3)]]||[[Opentherm Gateway OTGW|OpenTherm Gateway with LAN interface]]||[[Teleinfo|Teleinfo EDF USB]]
|-
|Energy Count 3000/ NETBSEM4/ La Crosse RT-10 LAN||[[Zwave|OpenZWave USB]]||[[Basic_Tellstick_functionality_with_Domoticz|Tellstick]]
|-
|[[Evohome|Evohome USB (for HGI/S80)]]||[[Dutch_DSMR_smart_meter_with_P1_port|P1 Smart Meter USB]]||Thermosmat Thermostat
|-
|[[Evohome|Evohome via script]]||[[Dutch_DSMR_smart_meter_with_P1_port|P1 Smart Meter with LAN interface]]||[[Toon|Toon Thermostat]]
|-
|[[EVehicles]]
|[[Domoticz and PvOutput.org|PVOutput (Input)]]
|[[USBtin CAN Gateway]]
|-
|[[Enphase]]||[[Panasonic TV]]||[[Voltcraft_CO-20|Volcraft CO-20 USB air qualty sensor]]
|-
|[[Fritzbox|Fritzbox Callmonitor via LAN interface]]||[[Philips Hue Lights|Philips Hue Bridge]]||[[Wake-up_On_Lan|Wake-on-LAN]]
|-
|[[GPIO]]||[[PiFace|PiFace - Raspberry Pi IO expansion board]]||[[Virtual_weather_devices|Weather Underground]]
|-
|HEOS by DENON||Plugwise Anna Thermostat via LAN interface||Winddelen
|-
|[[HTTP/HTTPS poller]]||[[RFLink Gateway USB]]||[[Yeelight|YeeLight LED]]
|-
|[[Essent|ICY Thermostat]]||[[RFLink Gateway with LAN interface]]||YouLess Meter with LAN Interface
|-
|KMTronic 433MHz Gateway USB|| ||[[ZiBlue RFPlayer|ZiBlue RFPIayer USB]]
|-
|KMTronic Gateway USB|| ||[[ZiBlue RFPlayer|ZiBlue RFPlayer with LAN Interface]]
|-
|KMTronic Gateway with LAN interface|| ||
|}

If you are a developer and want to contribute have a look here:

*[[Developing_a_hardware_plugin|Developing a hardware plugin]]
*[[Developing_a_Python_plugin|Developing a Python plugin]]

==Add a Hardware Gateway==
[[File:Add Hardware.png]]
 

*Type: Select a Hardware Gateway from the pull down list. A [[Plugins|Python Plugin]] first needs to be installed before showing up in this list.
*Enabled/Disabled: you can disable the hardware gateway. The created devices stay active (but greyed out) but will not be updated.
*Name: Enter a meaningful name for the Gateway
*Select Log Levels:
**'''Info''': Shows info logging about the hardware and its devices in the log file or log page. This will normally generate the most log lines
**'''Status''': Shows Status logging in the log file or log page.
**'''Error''': Shows Error logging in the log file or log page.
*Data Timeout: Enable Data Timeout if needed (1 minute to 24 hours). Domoticz will restart the Hardware thread/plugin if after the set timeout still no data is received by the gateway.
*Select USB device or LAN IP address and port

===Setting up a USB hardware===
First make sure the device is recognized in the system. Domoticz automatically detects the USB port.

[[File:USB Hardware.png]] 
By pressing the ADD button, the hardware is added to the system and will automatically start.

===Setting up a LAN hardware===
First make sure you know the IP address and port of the device.

As the Domoticz is able to resolve hostnames it is also allowed to fill in an hostname instead of IP Address (if your local network supports it). 
[[File:LAN Hardware.png]] 
By pressing the ADD button, the hardware is added to the system and will automatically start.
==Update Hardware Gateway==
When hardware is added the overview of all defined hardware will be shown.

Some Hardware Gateways have extra buttons for specific actions like [[Dummy for virtual Switches|Dummy]], RFXCOM, [[Zwave|ZWave]].

For the RFXCOM transceiver the different protocols can be selected by clicking the "Set Mode" button.

To '''update''' the basic configuration of an hardware gateway/plugin:

*Select the hardware from the list
*Change the configuration (eg IP Address, disable temporarily etc)
*Change Log Levels:
**'''Info''': Shows info logging about the hardware and its devices in the log file or log page. This will normally generate the most log lines
**'''Status''': Shows Status logging in the log file or log page.
**'''Error''': Shows Error logging in the log file or log page.
*Data Timeout: Enable Data Timeout if needed (1 minute to 24 hours). Default value is Disabled. Domoticz will restart the Hardware thread/plugin if after the set timeout still no data is received by the gateway
*Click on '''Update''' button. The Hardware gateway/plugin will be restarted with the new configuration. Some hardware gateways require a restart of Domoticz to activate the configuration change.

To '''delete''' the hardware configuration (and all attached devices!!) select the Hardware and click on button Delete.

 [[File:Update Hardware.png]]

==Shared Devices / Remote Server==
It is possible to share your (Domoticz) sensors with your friends or a second Domoticz installation in your holiday home. For instance you can share your Rain Meter, but also lights/switches that other people can control. For this, you need to enter an Administrator username/password in the application settings. Then you
can add users and assign sensors/switches to this user. An example how to set up sharing is detailed in [[Setting_up_Device_sharing]]. 
To make your Domoticz server reachable when behind a NAT/Firewall router it's port forwarding needs to be configured. Consult the documentation of the router on how to setup a Firewall/NAT/Forward rule or check this [http://www.howtogeek.com/66214/how-to-forward-ports-on-your-router/ howto].

==Dummy Hardware==
Another special hardware type is the Dummy Hardware. As the name implies this hardware does not communicate with the outside world. It's purpose is to be a placeholder for virtual switches and virtual sensors which can be used as variables in events and scripts. New virtual switches need to be added in the switches tab (Add manual light/switch). New virtual sensors (and switches) can be created from the hardware overview list. See the following page for more instructions: [[Dummy for virtual Switches|Dummy for virtual switches]] 
[[File:DummyHardware.JPG|link=|Dummy Hardware]]
==Debugging Hardware==
You can see a debug console (windows) by pressing the right mouse button on the Domoticz icon in the
system tray or check the Log window by selecting menu '''Setup - Log'''.

For extra logging on debug level and to log to a log file instead of a window see the [[Troubleshooting#Activate logging to OS-file .28with or without debugging.29|Troubleshooting page]] 
[[File:LogOption.JPG|link=|Log Option]] 

[[Category:Domoticz]]
[[Category:Manual]]
[[Category:Install]]
[[Category:Setup]]

Hardware Setup - Revision history

Walter vl: /* Setting up a USB hardware */

Walter vl: /* Setting up a USB hardware */

Walter vl: /* Update Hardware Gateway */