Draft: Add support for Doors

[fr3nch13]

Description

I'm trying to add support for Doors, specifically the Lychee Things SmartSlyder, but I could use some help.

Type of change

• [X ] New feature (non-breaking change which adds functionality)

How Has This Been Tested?

Currently: testing live locally: % npm run build && npm link && homebridge -I -D
Then watching the output when viewing/triggering via the web frontend at http://localhost:8581/accessories

Checklist:

I'll do this once I have Proof of concept working, but it is currently passing npm run lint && npm run format

• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• New and existing unit tests pass locally with my changes

I'll put code snippets below in the comments of what the Door looks like coming from Alexa, and the error I'm getting when I try to set the state. I could use some help.

[fr3nch13]

Output I'm seeing from Alexa:
The UUID is redacted as I'm not sure if it's specific to the product or to my instance specifically:

Support:
Alexa.TemperatureSensor - Not Started - Apparently is has a thermometer installed
Alexa.ToggleController - Not Started - Allows you to run on/off the access for Pet Passes
Alexa.RangeController - On progress - Able to read, Having trouble setting/writing

[4/15/2024, 6:20:23 PM] [HomebridgeAlexaSmartHome] Slider ::: Attempting to add accessory(s) for device: {
  "id": "[UUID REDACTED]",
  "displayName": "Slider",
  "description": "SmartSlydr by LycheeThings",
  "supportedProperties": [
    "turnOff@[UUID REDACTED]_Door.TagControl",
    "turnOn@[UUID REDACTED]b_Door.TagControl",
    "setRangeValue@[UUID REDACTED]_Door.Percent"
  ],
  "supportedTriggers": [],
  "supportedOperations": [
    "turnOff@[UUID REDACTED]_Door.TagControl",
    "turnOn@[UUID REDACTED]_Door.TagControl",
    "setRangeValue@[UUID REDACTED]_Door.Percent"
  ],
  "availability": "AVAILABLE",
  "icon": {
    "@iconType": "SmartHomeApplianceType",
    "value": "DOOR"
  },
  "providerData": {
    "enabled": true,
    "relationships": [],
    "categoryType": "APPLIANCE",
    "deviceType": "DOOR",
    "dmsDeviceIdentifiers": []
  }
}
[4/15/2024, 6:20:23 PM] [HomebridgeAlexaSmartHome] Slider ::: Current state: [
  {
    "namespace": "Alexa.TemperatureSensor",
    "name": "temperature",
    "value": {
      "value": 80.6,
      "scale": "FAHRENHEIT"
    }
  },
  {
    "namespace": "Alexa.ToggleController", <--- Pet Pass
    "name": "toggleState",
    "value": "ON",
    "instance": "Door.TagControl"
  },
  {
    "namespace": "Alexa.RangeController",
    "name": "rangeValue",
    "value": 0,
    "instance": "Door.Percent"
  }
]
[4/15/2024, 6:20:23 PM] [HomebridgeAlexaSmartHome] Slider ::: Range capabilities: {}
{
  id: '[UUID REDACTED]',
  displayName: 'Slider',
  description: 'SmartSlydr by LycheeThings',
  supportedProperties: [
    'turnOff@[UUID REDACTED]_Door.TagControl',
    'turnOn@[UUID REDACTED]_Door.TagControl',
    'setRangeValue@[UUID REDACTED]_Door.Percent'
  ],
  supportedTriggers: [],
  supportedOperations: [
    'turnOff@[UUID REDACTED]_Door.TagControl',
    'turnOn@[UUID REDACTED]_Door.TagControl',
    'setRangeValue@[UUID REDACTED]_Door.Percent'
  ],
  availability: 'AVAILABLE',
  icon: { '@iconType': 'SmartHomeApplianceType', value: 'DOOR' },
  providerData: {
    enabled: true,
    relationships: [],
    categoryType: 'APPLIANCE',
    deviceType: 'DOOR',
    dmsDeviceIdentifiers: []
  }
}
[4/15/2024, 6:20:36 PM] [HomebridgeAlexaSmartHome] Slider - Get door state result: 2
[4/15/2024, 6:20:36 PM] [HomebridgeAlexaSmartHome] Slider - Get door position result: 0
[4/15/2024, 6:20:44 PM] [HomebridgeAlexaSmartHome] Slider - Triggered door position: 100
{ action: 'setRangeValue', rangeValue: '100' }
[4/15/2024, 6:20:44 PM] [HomebridgeAlexaSmartHome] Slider - Set door position - RequestUnsuccessful(Error setting smart home device state. Response: {
  "controlResponses": [],
  "errors": [
    {
      "entity": {
        "entityId": "[UUID REDACTED]",
        "entityType": "APPLIANCE"
      },
      "code": "FAILURE_TO_SEND",
      "message": "JSON payload could not be extracted",
      "data": null
    }
  ]
}. Error code: FAILURE_TO_SEND)
[4/15/2024, 6:20:44 PM] [HomebridgeAlexaSmartHome] Slider - Service communication error

[fr3nch13]

I'm currently working on the Required Characteristics as defined here, but would like to add the Optional Characteristics if I can get that info from Alexa https://developers.homebridge.io/#/service/Door

[fr3nch13]

So in emailing with LycheeThings support team, it seems like I may be missing the 'instance' variable in the payload when setting the range value.

[joeyhage]

@fr3nch13, thanks for the PR! Sorry I overlooked this. I had to do a pretty major refactor of the plugin to fix some recent issues so this will need a lot of changes if you are still interested in adding door support.

[fr3nch13]

Oh ok. Adding support for v3?

[fr3nch13]

I'll wait until you have a more stable version of 2.2.0 before trying to add the door. However, I don't mind being a tester/contributor.

[joeyhage]

@fr3nch13, v2.2.0 is stable now so go ahead with your contribution when you are ready. Thanks!