Plugin Model Reference

Plugin Model Reference

This is not for the feint of heart and very much still under construction. The purpose for this information is not only for development and maintenance of the plugin but for other things that will be made clear in the near future.

Special Functions

special_onStateToFullBrightness

Characteristic: Any 0 to 100 characteristics

Property:

• onState attribute (only if present and not None)

References:

• onState

Value:

• Returns 0 if onState is False and 100 if onState is True

---

special_lowbattery

Characteristic: StatusLowBattery

Property:

• batteryLevel attribute (only if present and not None)

References:

• lowbattery plugin configuration parameter that gives the percentage threshold for the plugin to report a low battery state

Value:

• Returns True if batteryLevel as a percentage of 100 is less than or equal to lowbattery

---

special_inuse

Characteristic: OutletInUse

Property:

• energyCurLevel attribute (only if present and not None)
• onState attribute (only if present)

Value:

• Returns True if energyCurLevel is greater than zero and False if it is zero
• Returns the state of onState

---

special_thermHVACMode

Characteristic: CurrentHeatingCoolingState

Property:

• hvacMode attribute (only if present and not None)

Value:

• Returns 0 if hvacMode is equal to Off
• Returns 1 if hvacMode is equal to Heat
• Returns 2 if hvacMode is equal to Cool

---

special_thermTemperature

Characteristic: CurrentTemperature

Property:

• temperatureInput1 state (only if present and not None)

References:

• tempunits configuration property of the server configuration

Value:

• Returns Celsius Value of temperatureInput1 if tempunits is c
• Returns Celsius Conversion Value of temperatureInput1 if tempunits is f

---

special_wuTemperature

Characteristic: CurrentTemperature

Property:

• temp state (only if present and not None)

References:

• tempunits configuration property of the server configuration
• temp state of a WUnderground "wunderground" device

Value:

• Returns Celsius Value of temp if tempunits is c
• Returns Celsius Conversion Value of temp if tempunits is f

---

special_serverCorFSetting

Characteristic: TemperatureDisplayUnits

References:

• tempunits configuration property of the server configuration

Value:

• Returns 0 of temp if tempunits is c
• Returns 1 of temp if tempunits is f