HubConnect Custom Drivers
A collection of custom drivers to use with HubConnect
Using these Custom Drivers with HubConnect
Install and Configure Custom Driver on your HubConnect Server (master)
- Install and save the desired Custom Driver in the Drivers section of your HubConnect Server.
- On the HubConnect Server:
- Open the HubConnect Server for Hubitat application
- Click on Manage Custom Drivers
- Click on Add A Driver
- Fill in the Attribute Class Name and Device Driver Name as shown below for the driver you installed in step 1.
- Select the Attribute 1/18 type from the options list, as shown below
- Fill in the remainder of the Attributes as shown below
- Click Save
- Click Done
- Click Home (or Next)
Install Custom Driver on any HubConnect Remote Clients
This is only necessary if you want to reflect a Custom Device as a device on your Remote Client. If the device is physically installed on your Remote Client, you do not need to install the Custom Device (but it doesn't hurt anything if you do).
- Install and save the desired Custom Driver in the Drivers section of the HubConnect Remote Client that you want to use the (reflected) device on. Note that some drivers will not work on SmartThings Hubs
Reflect a Custom Device from your HubConnect Server
- Open the appropriate HubConnect Server Instance application for the target Remote Client
- Click on Connect local devices to Remote Hub
- Click on Custom Devices
- Click on the desired Custom Driver definition
- Select the desired local devices that you want to reflect using this driver. Be sure that the Custom Driver is already installed on the Remote Client!
- When finished, click Done/Next all the way back to the main menu
Reflect a Custom Device from a HubConnect Remote Client
- Open HubConnect Remote Client application on the Remote Hub
- Click on Select devices to synchronize to Server hub
- Click on Custom Devices. Here you should see the list of Custom Drivers that you Installed & Configured in the very first step above.
- Click on the desired Custom Driver definition
- Select the desired local devices that you want to reflect using this driver. Be sure that the Custom Driver is already installed on the Remote Client!
- When finished, click Done/Next all the way back to the main menu
HubConnect EchoSpeaks
importUrl: https://raw.githubusercontent.com/SANdood/HubConnect-Custom-Drivers/master/HubConnect%20EchoSpeaks
Echo Speaks by Anthony Santilli (@tonesto7)
Works With- Hubitat webSockets-only, as HubConnect limits the number of attributes that can be reflected via http. Cannt be used with SmartThings-hosted Echo Speaks, nor to reflect Hubitat-hosted Echo Speaks to a SmartThings hub.
HubConnect Configuration
- Attribute Class Name:
EchoSpeaks
- Device Driver Name:
HubConnect Echo Speaks Device
- Attribute 1/18:
speechSynthesis
- Attribute 2/18:
mute
- Attribute 3/18:
level
- Attribute 4/18:
volume
- Attribute 5/18:
alarmVolume
- Attribute 6/18:
doNotDisturb
- Attribute 7/18:
alexaWakeWord
- Attribute 8/18:
currentAlbum
- Attribute 9/18:
currentStation
- Attribute 10/18:
wasLastSpokenToDevice
- Attribute 11/18:
status
- Attribute 12/18:
deviceStatus
- Attribute 13/18:
onlineStatus
- Attribute 14/18:
followUpMode
- Attribute 15/18:
nediaSource
- Attribute 16/18:
lastUpdated
- Attribute 17/18:
alexaPlaylists
- Attribute 18/18:
alexaGuardStatus
HubConnect Ecobee Suite Sensor
importUrl:
- Designed for reflecting SmartThings-based Ecobee Suite Sensors to Hubitat, or Hubitat to Hubitat. Will not save as a SmartThings DTH
HubConnect Configuration
- Attribute Class Name:
ESSensor
- Device Driver Name:
HubConnect Ecobee Suite Sensor
- Attribute 1/18:
temperatureMeasurement
- Attribute 2/18:
motion
- Attribute 3/18:
Awake
// Sensor used in Awake Program? off = no, on = yes - Attribute 4/18:
Away
// Sensor used in Away Program? - Attribute 5/18:
Home
// Sensor used in Home Program? - Attribute 6/18:
Sleep
// Sensor used in Sleep Program? - Attribute 7/18:
Fan Only
- Attribute 8/18:
programsList
- Attribute 9/18:
SmartRoom
- Attribute 10/18:
Wakeup
// Sensor used in Wakeup Program? - Attribute 11/18:
currentProgramName
- Attribute 12/18:
doors
- Attribute 13/18:
humidity
- Attribute 14/18:
thermostatId
- Attribute 15/18:
windows
- Attribute 16/18:
vents
HubConnect Ecobee Suite Thermostat
Ecobee Suite
Works With- As of HubConnect 1.6.1, users can now configure up to 50 attributes to be reflected from an http-connected sources (SmartThings, or Hubitat configured not to use WebSockets). Listed below are the required, recommended, alternative and
not recommended
attributes that you can configure. (Note that for Hubbbitat-based HubConnected hubs using WebSockets, ALL attribbutes will be reflected and updated). importUrl: - Designed for reflecting Ecobee Suite Thermostats to Hubitat hubs only. Will not save as a SmartThings DTH.
- IMPORTANT NOTE: Ecobee Suite Helpers are NOT supported by this reflected device!
HubConnect Configuration
- Attribute Class Name:
ESThermostat
- Device Driver Name:
HubConnect Ecobee Suite Thermostat
- Primary attribute: thermostatOperatingState
Required Attributes
- coolingSetpoint
- coolingSetpointRange
- heatingSetpoint
- heatingSetpointRange
- humidity
- motion
- schedule
- supportedThermostatFanModes
- supportedThermostatModes
- temperature
- thermostatFanMode
- thermostatMode
- thermostatSetpoint
- thermostatSetpointRange
Recommended Attributes
- autoAway
- coolDifferential
Alternative Attributes
- autoHeatCoolFeatureEnabled // wether
autoMode
is enabled (change withsetEcobeeSetting()
- currentProgram // e.g. "Home"
- currentProgramName // e.g. "Hold: Home"
Possibilities
- backlightOffDuringSleep
- backlightOffTime
- backlightOnIntensity
- backlightSleepIntensity
- brand
- coolAtSetpoint
Not Recommended
Most of these you will configure once, and then they will never change. Or, they are internal-use only.
-
autoMode // if enabled, will show "auto" in supportedThermostatModes
-
auxHeatMode
-
auxMaxOutdoorTemp
-
auxOutdoorTempAlert
-
auxOutdoorTempAlertNotify
-
auxRuntimeAlert
-
auxRuntimeAlertNotify
-
auxOutdoorTempAlertNotifyTechnician
-
auxRuntimeAlertNotifyTechnician
-
coldTempAlert
-
coldTempAlertEnabled
-
compressorProtectionMinTemp
-
compressorProtectionMinTime
-
condensationAvoid // deprecated - no longer used by Ecobee
-
coolMaxTemp
-
coolMinTemp
-
coolMode
-
coolRange
-
coolRangeHigh
-
coolRangeLow
-
coolStages
-
coolingLockout
-
coolingSetpointDisplay // internal
-
coolingSetpointMax
-
coolingSetpointMin
-
coolingSetpointTile
-
currentProgramId // internal
-
currentProgramOwner // internal
-
currentProgramType // internal
-
debugEventFromParent
-
debugLevel: 2
-
ecimalPrecision: 1
-
dehumidifierLevel: 60
-
dehumidifierMode: off
-
dehumidifyOvercoolOffset: 2.0 F
-
dehumidifyWhenHeating: false
-
dehumidifyWithAC: true
-
dehumidityLevel: 60
-
dehumiditySetpoint: 60
-
disableAlertsOnIdt: false
-
disableHeatPumpAlerts: false
-
disablePreCooling: false disablePreHeating: false drAccept: always ecobeeConnected: true eiLocation: electricityBillCycleMonths: 1 electricityBillStartMonth: 1 electricityBillingDayOfMonth: 1 enableElectricityBillAlert: false enableProjectedElectricityBillAlert: false equipmentOperatingState: heat 1 hum equipmentStatus: auxHeat1,fan,humidifier fanControlRequired: true fanMinOnTime: 8 features: Home,HomeKit followMeComfort: false groupName: ChezBurke groupRef: 9023c63a47fff2444152 groupSetting: 1745 hasBoiler: false hasDehumidifier: true hasElectric: false hasErv: false hasForcedAir: true hasHeatPump: false hasHrv: false hasHumidifier: true hasUVFilter: true heatAtSetpoint: 68.5 F heatCoolMinDelta: 4.0 F heatDifferential: 0.5 F heatMaxTemp: 120.0 F heatMinTemp: 45.0 F heatMode: true heatPumpGroundWater: false heatPumpReversalOnCool: true heatRange: (45..78) F heatRangeHigh: 78.0 F heatRangeLow: 45.0 F heatStages: 2 heatingSetpointDisplay: 69.0 F heatingSetpointMax: 78.0 F heatingSetpointMin: 45.0 F heatingSetpointTile: 69.0 F holdAction: nextPeriod holdEndsAt: today at 6:00pm holdStatus: Hold ends today at 6:00pm hotTempAlert: 87.0 hotTempAlertEnabled: true humidifierMode: auto humidityAlertNotify: true humidityAlertNotifyTechnician: false humidityHighAlert: 80 humidityLowAlert: -1 humiditySetpoint: 49 % humiditySetpointDisplay: 49 % identifier: 311019854581 installerCodeRequired: false isRegistered: true isRentalProperty: false isVentilatorTimerOn: false lastHoldType: nextTransition lastModified: 2019-05-29 17:08:51 lastOpState: heating lastPoll: Succeeded lastServiceDate: 2019-07-11 locale: en maxSetBack: 10.0 F maxSetForward: 8.0 F microphoneEnabled: mobile: iOS modelNumber: athenaSmart monthlyElectricityBillLimit: 0 monthsBetweenService: 6 name: Downstairs playbackVolume: programsList: ["Awake", "Away", "Home", "Sleep"] quickSaveSetBack: 4.0 F quickSaveSetForward: 4.0 F randomStartDelayCool: 0 randomStartDelayHeat: 0 remindMeDate: 2020-01-11 schedText: until 6:00pm scheduledProgram: Away scheduledProgramId: away scheduledProgramName: Away scheduledProgramOwner: system scheduledProgramType: program serviceRemindMe: true serviceRemindTechnician: false smartCirculation: false soundAlertVolume: 0 soundTickVolume: 0 stage1CoolingDifferentialTemp: 0.5 F stage1CoolingDissipationTime: 31 stage1HeatingDifferentialTemp: 0.5 F stage1HeatingDissipationTime: 31 statHoldAction: nextPeriod supportedVentModes: tempAlertNotify: true tempAlertNotifyTechnician: false tempCorrection: -1.0 F temperatureDisplay: 68.5° F temperatureScale: F thermostatFanModeDisplay: circulate thermostatHold: hold thermostatOperatingStateDisplay: heating thermostatSetpointMax: 78.0 F thermostatSetpointMin: 45.0 F thermostatStatus: Setpoint updating... thermostatTime: 2019-12-13 12:35:44 timeOfDay: day userAccessCode: userAccessSetting: 0 vent: off ventMode: off ventilatorDehumidify: true ventilatorFreeCooling: true ventilatorMinOnTime: 5 ventilatorMinOnTimeAway: 0 ventilatorMinOnTimeHome: 20 ventilatorOffDateTime: ventilatorType: none voiceEngines: weatherDewpoint: 30.0 F weatherHumidity: 75 % weatherPressure: 30.42 inHg weatherSymbol: 3 weatherTemperature: 37.1 F wifiOfflineAlert: false
HubConnect EcoVent
importUrl: https://raw.githubusercontent.com/SANdood/HubConnect-Custom-Drivers/master/HubConnect%20EcoVent
Econet EV100 Vent for Hubitat (my custom version)
Works With- Tested for use reflecting Hubitat-based EcoVents to SmartThings Remote Hub
HubConnect Configuration
- Attribute Class Name:
EcoVent
- Device Driver Name:
HubConnect EcoVent
- Attribute 1/18:
switchLevel
- Attribute 2/18:
switch
- Attribute 3/18:
battery
- Attribute 4/18:
contact
HubConnect Illuminance Sensor
Works With all Illuminance Sensors
- Useful to reflect
illuminance
only from multi-sensor devices
HubConnect Configuration
- Attribute Class Name:
Lux
- Device Driver Name:
HubConnect Illuminance Sensor
- Attribute 1/18:
illuminanceMeasurement
HubConnect MyQ Garage Door Opener
Works With Brian Beaird's MyQ Lite Garage Door Opener
HubConnect Configuration
- Attribute Class Name:
MyQGarageDoor
- Device Driver Name:
HubConnect MyQ Garage Door Opener
- Attribute 1/18:
garageDoorControl
- Attribute 2/18:
contact
- Attribute 3/18:
acceleration
- Attribute 4/18:
doorSensor
- Attribute 5/18:
lastActivity
- Attribute 6/18:
switch
- Attribute 7/18:
myQDeviceId
- Attribute 8/18:
CloseButton
- Attribute 9/18:
OpenButton
HubConnect Relative Humidity Sensor
Works With all Relative Humidity Sensors
- Useful to reflect 'humidity' only from multi-sensor devices
- Probably works with moisture sensors as well
HubConnect Configuration
- Attribute Class Name:
Humidistat
- Device Driver Name:
HubConnect Relative Humidity Sensor
- Attribute 1/18:
relativeHumidityMeasurement
HubConnect Temperature Sensor
Works With all Temperature Sensors
- Useful to reflect
temperature
only from multi-sensor devices
HubConnect Configuration
- Attribute Class Name:
Thermometer
- Device Driver Name:
HubConnect Temperature Sensor
- Attribute 1/18:
temperatureMeasurement