homebridge-logo-platform v1.4.3

Homebridge Logo Platform

Use a Siemens LOGO! PLC for switch on whatever you want.
Communicate with LOGO! over Snap7 or Modbus.

Type of Accessory:

• Switch
• Lightbulb
• Blind
• Window
• Garage Door
• Thermostat
• Irrigation System
• Valve
• Fan
• Filter Maintenance
• Outlet

Type of Sensor Accessory:

• Light Sensor
• Motion Sensor
• Contact Sensor
• Smoke Sensor
• Temperature Sensor
• Humidity Sensor
• Carbon Dioxide Sensor
• Air Quality Sensor
• Leak Sensor

Special Functions:

• Logging to InfluxDB or Eve App
• Multi Accessory

Examples:

• Main Configuration

Installation

1. Install homebridge using instruction from: Homebridge WiKi
2. Install this plugin in your homebridge
3. Update your configuration file with code like the sample below

Thanks to

• Tellicious for:
  • Adding logging to the Eve app.
  • Integrated valve as sub-accessory of IrrigationSystem.
  • His Bugfix to avoid memory leak.

Special thanks to

• Davide Nardella for Snap7
• Fabio Riva for Napi-Snap7. And for allowing me to improve his plugin.
• Mathias Küsel for Node-Snap7 (was used until v1.3.8)

Known issues

• The plugin cannot be configured with the Config UI. (The settings are too complex.)

Platform Main Configuration Parameters

Device Main Configuration Parameters

"platforms": [
    {
        "platform": "LogoPlatform",
        "name": "Logo 1",
        "ip": "10.0.0.100",
        "port": 505,
        "updateInterval": 10000,
        "debugMsgLog": 1,
        "pushButton": 1,
        "devices": [
            {
                "name": "Accessory Name 1",
                "type": "...",
                ...
            },
            {
                "name": "Accessory Name 2",
                "type": "...",
                ...
            }
        ]
    },
    {
        "platform": "LogoPlatform",
        "name": "Logo 2",
        "interface": "snap7",
        "ip": "10.0.0.200",
        "logoType": "0BA8",
        "localTSAP": "0x4200",
        "remoteTSAP": "0x4300",
        "updateInterval": 10000,
        "debugMsgLog": 1,
        "pushButton": 1,
        "devices": [
            {
                "name": "Accessory Name 3",
                "type": "...",
                ...
            },
            {
                "name": "Accessory Name 4",
                "type": "...",
                ...
            }
        ]
    }
]

Switch Configuration

{
    "name": "Q1",
    "type": "switch",
    "switchGet": "Q1",
    "switchSetOn": "V1.0",
    "switchSetOff": "V1.1"
}

Lightbulb Configuration

{
    "name": "Q1",
    "type": "lightbulb",
    "lightbulbGet": "Q1",
    "lightbulbSetOn": "V1.0",
    "lightbulbSetOff": "V1.1"
},
{
    "name": "Q4",
    "type": "lightbulb",
    "lightbulbGet": "Q4",
    "lightbulbSetOn": "V7.0",
    "lightbulbSetOff": "V7.1",
    "lightbulbSetBrightness": "VW70",
    "lightbulbGetBrightness": "VW72"
}

Blind Configuration

{
    "name": "Item-6",
    "type": "blind",
    "blindConvertValue": 1,
    "blindSetTargetPos": "VW26",
    "blindGetTargetPos": "VW28",
    "blindGetPos": "VW28",
    "blindGetState": "VW30"
}

Window Configuration

{
    "name": "Item-7",
    "type": "window",
    "windowConvertValue": 1,
    "windowSetTargetPos": "VW32",
    "windowGetTargetPos": "VW34",
    "windowGetPos": "VW34",
    "windowGetState": "VW36"
}

Garage Door Configuration

{
    "name": "Item-8",
    "type": "garagedoor",
    "garagedoorGetState": "VW40",
    "garagedoorGetTargetState": "VW40",
    "garagedoorSetTargetState": "VW38",
    "garagedoorObstruction": "V3.0"
}

Thermostat Configuration

{
    "name": "Item-9",
    "type": "thermostat",
    "thermostatGetHCState": "VW42",
    "thermostatGetTargetHCState": "VW44",
    "thermostatSetTargetHCState": "VW46",
    "thermostatGetTemp": "VW48",
    "thermostatGetTargetTemp": "VW50",
    "thermostatSetTargetTemp": "VW52",
    "thermostatTempDisplayUnits": 0,
    "thermostatConvertValue": 1
}

Irrigation System Configuration

{
    "name": "Item-10",
    "type": "irrigationSystem",
    "irrigationSystemGetActive": "V4.0",
    "irrigationSystemSetActiveOn": "V4.1",
    "irrigationSystemSetActiveOff": "V4.2",
    "irrigationSystemGetProgramMode": "VW54",
    "irrigationSystemGetInUse": "V4.3",
    "irrigationSystemGetRemainingDuration": "VW56",
    "irrigationSystemGetWaterLevel": "VW58"
}

{
    "name": "Item-10",
    "type": "irrigationSystem",
    "irrigationSystemSetActiveOn": "V4.1",
    "irrigationSystemSetActiveOff": "V4.2",
    "irrigationSystemGetProgramMode": "VW54",
    "irrigationSystemGetRemainingDuration": "VW56",
    "irrigationSystemGetWaterLevel": "VW58",
    "irrigationSystemAutoUpdate": 1
}

Valve Configuration

• Item-11-A: Valve as child from a Irrigation System (Item-10)
• Item-11-B: Valve without IsConfigured characteristic
• Item-11-C: Valve with IsConfigured characteristic
• Item-11-D: Valve as minimum without SetDuration and IsConfigured

{
    "name": "Item-11-A",
    "type": "valve",
    "valveGetActive": "V5.0",
    "valveSetActiveOn": "V5.1",
    "valveSetActiveOff": "V5.2",
    "valveGetInUse": "V5.3",
    "valveType": 1,
    "valveSetDuration": "VW56",
    "valveGetDuration": "VW56",
    "valveGetRemainingDuration": "VW58",
    "valveParentIrrigationSystem": "Item-10",
    "valveZone": 1
}
{
    "name": "Item-11-B",
    "type": "valve",
    "valveGetActive": "V5.0",
    "valveSetActiveOn": "V5.1",
    "valveSetActiveOff": "V5.2",
    "valveGetInUse": "V5.3",
    "valveType": 1,
    "valveSetDuration": "VW56",
    "valveGetDuration": "VW56",
    "valveGetRemainingDuration": "VW58"
}
{
    "name": "Item-11-C",
    "type": "valve",
    "valveGetActive": "V5.0",
    "valveSetActiveOn": "V5.1",
    "valveSetActiveOff": "V5.2",
    "valveGetInUse": "V5.3",
    "valveType": 1,
    "valveSetDuration": "VW56",
    "valveGetDuration": "VW56",
    "valveGetRemainingDuration": "VW58",
    "valveSetIsConfiguredOn": "V5.4",
    "valveSetIsConfiguredOff": "V5.5",
    "valveGetIsConfigured": "V5.6"
}
{
    "name": "Item-11-D",
    "type": "valve",
    "valveGetActive": "V5.3",
    "valveSetActiveOn": "V5.1",
    "valveSetActiveOff": "V5.1",
    "valveGetInUse": "V5.3",
    "valveType": 1,
    "pushButton": 0
}

Fan Configuration

{
    "name": "Item-12",
    "type": "fan",
    "fanGet": "V6.0",
    "fanSetOn": "V6.1",
    "fanSetOff": "V6.2",
    "fanGetRotationDirection": "V6.3",
    "fanSetRotationDirectionCW": "V6.4",
    "fanSetRotationDirectionCCW": "V6.5",
    "fanGetRotationSpeed": "VW60",
    "fanSetRotationSpeed": "VW62"
}

Filter Maintenance Configuration

The Home-App only supports this accessory as an additional feature of a dehumidifier, for example.

{
    "name": "Item-13",
    "type": "filterMaintenance",
    "filterChangeIndication": "V7.0",
    "filterLifeLevel": "VW64",
    "filterResetFilterIndication": "V7.1"
}

Outlet Configuration

{
    "name": "Q1",
    "type": "outlet",
    "outletGet": "Q1",
    "outletSetOn": "V1.0",
    "outletSetOff": "V1.1"
}

Other Configuration

This accessory can contain other accessories, but does not respond to tapping to turn it on or off. It opens a detailed view of the sub accessories.

{
    "name": "Ventilation",
    "type": "other"
},
{
    "name": "Level 1",
    "type": "switch",
    "switchGet": "Q3",
    "switchSetOn": "V3.2",
    "switchSetOff": "V4.2",
    "parentAccessory": "Ventilation"
},
{
    "name": "Level 2",
    "type": "switch",
    "switchGet": "Q4",
    "switchSetOn": "V3.3",
    "switchSetOff": "V4.3",
    "parentAccessory": "Ventilation"
},
{
    "name": "Automatic",
    "type": "switch",
    "switchGet": "M16",
    "switchSetOn": "V3.4",
    "switchSetOff": "V4.4",
    "parentAccessory": "Ventilation"
},
{
    "name": "Supply Air",
    "type": "temperatureSensor",
    "convertValue": 1,
    "temperature": "AM5",
    "parentAccessory": "Ventilation"
},
{
    "name": "Exhaust Air",
    "type": "temperatureSensor",
    "convertValue": 1,
    "temperature": "AM6",
    "parentAccessory": "Ventilation"
}

Light Sensor Configuration

{
    "name": "Sensor-1",
    "type": "lightSensor",
    "light": "VW66"
}

Motion Sensor Configuration

{
    "name": "Sensor-2",
    "type": "motionSensor",
    "motion": "V8.0"
}

Contact Sensor Configuration

{
    "name": "Sensor-3",
    "type": "contactSensor",
    "contact": "V8.1"
}

Smoke Sensor Configuration

{
    "name": "Sensor-4",
    "type": "smokeSensor",
    "smoke": "V8.2"
}

Temperature Sensor Configuration

{
    "name": "Sensor-5",
    "type": "temperatureSensor",
    "convertValue": 1,
    "temperature": "VW68"
}

Humidity Sensor Configuration

{
    "name": "Sensor-6",
    "type": "humiditySensor",
    "convertValue": 1,
    "humidity": "VW70"
}

Carbon Dioxide Sensor Configuration

{
    "name": "Sensor-7",
    "type": "carbonDioxideSensor",
    "carbonDioxide": "V9.0",
    "carbonDioxideLevel": "VW72",
    "carbonDioxidePeakLevel": "VW74"
}

Air Quality Sensor Configuration

• 0 - Unknown
• 1 - Excellent - CO2 < 800ppm (IDA 1)
• 2 - Good - CO2 = 800 - 1000ppm (IDA 2)
• 3 - Fair - CO2 = 1000 - 1400ppm (IDA 3)
• 4 - Inferior - CO2 = 1400 - 1800ppm (IDA 4)
• 5 - Poor - CO2 > 1800ppm

{
    "name": "Sensor-8",
    "type": "airQualitySensor",
    "airQuality": "VW76"
}

Leak Sensor Configuration

{
    "name": "Sensor-9",
    "type": "leakSensor",
    "leak": "V9.1",
    "waterLevel": "VW78"
}

Logging to InfluxDB or Eve App

Main Configuration

"platforms": [
        {
            "platform": "LogoPlatform",
            "name": "Logo 6",
            "ip": "10.0.0.100",
            "port": 502,
            "updateInterval": 10000,
            "debugMsgLog": 1,
            "pushButton": 1,
            "loggerType": "influxDB",
            "loggerInterval": 30000,
            "influxDBUrl": "http://10.0.0.99:8086",
            "influxDBToken": "qwertzuiopasdfghjklyxcvbnm1234567890",
            "influxDBOrg": "Org-Name",
            "influxDBBucket": "Bucket-Name",
            "devices": [
                {
                    "name": "Logo 6 - Q1",
                    "type": "switch",
                    "switchGet": "Q1",
                    "switchSetOn": "V1.0",
                    "switchSetOff": "V1.1",
                    "logging": 1
                },
                {
                    "name": "Logo 6 - Q2",
                    "type": "switch",
                    "switchGet": "Q2",
                    "switchSetOn": "V1.2",
                    "switchSetOff": "V1.3"
                },
                {
                    "name": "Logo 6 - Q3",
                    "type": "switch",
                    "switchGet": "Q3",
                    "switchSetOn": "V1.4",
                    "switchSetOff": "V1.5",
                    "logging": 1
                },
                {
                    "name": "Logo 6 - M1",
                    "type": "switch",
                    "switchGet": "M1",
                    "switchSetOn": "V1.6",
                    "switchSetOff": "V1.7"
                },
                {
                    "name": "Logo 6 - Q4",
                    "type": "lightbulb",
                    "lightbulbGet": "Q4",
                    "lightbulbSetOn": "V2.0",
                    "lightbulbSetOff": "V2.1",
                    "lightbulbSetBrightness": "VW20",
                    "lightbulbGetBrightness": "VW22",
                    "logging": 1
                }
            ]
        },
        {
            "platform": "LogoPlatform",
            "name": "Logo 7",
            "interface": "snap7",
            "ip": "10.0.0.101",
            "logoType": "0BA7",
            "localTSAP": "0x2200",
            "remoteTSAP": "0x2100",
            "updateInterval": 10000,
            "debugMsgLog": 1,
            "pushButton": 1,
            "retryCount": 5,
            "devices": [
                {
                    "name": "Logo 7 - Q1",
                    "type": "switch",
                    "switchGet": "Q1",
                    "switchSetOn": "V1.0",
                    "switchSetOff": "V1.1"
                },
                {
                    "name": "Logo 7 - Q2",
                    "type": "switch",
                    "switchGet": "Q2",
                    "switchSetOn": "V1.2",
                    "switchSetOff": "V1.3"
                },
                {
                    "name": "Logo 7 - Q3",
                    "type": "switch",
                    "switchGet": "Q3",
                    "switchSetOn": "V1.4",
                    "switchSetOff": "V1.5"
                },
                {
                    "name": "Logo 7 - M1",
                    "type": "switch",
                    "switchGet": "M1",
                    "switchSetOn": "V1.6",
                    "switchSetOff": "V1.7"
                },
                {
                    "name": "Logo 7 - Q4",
                    "type": "lightbulb",
                    "lightbulbGet": "Q4",
                    "lightbulbSetOn": "V2.0",
                    "lightbulbSetOff": "V2.1",
                    "lightbulbSetBrightness": "VW20",
                    "lightbulbGetBrightness": "VW22"
                }
            ]
        }
    ]

Type of your LOGO

Required: yes* - means that this parameter is only required for this particular accessory!
Required: no* - means if no valid LOGO address is specified for this parameter, this characteristic returns the specified value or is deactivated in the accessory!

Test Homebridge-Logo-Platform

1. Download or clone Homebridge-Logo-Platform.
2. Install: $ npm install
3. Build: $ npm run build
4. Run: $ /usr/local/bin/homebridge -D -P ~/Homebridge-Logo-Platform/