Improve ZHADoorlock device

[Smanar]

This code:

• move the doorlock stuff in doorlock.cpp file
• add the field "state/doorstate" with value open/closed/error jammed/error forced open/error unspecified
• add the field "state/notification" with some information like "source:keypad, code:Unlock, pin:0"
• add a field "state/pin" for pin management

[Smanar]

For Pin management I m using state/pin and not config/pin, because the work need to be done by the third app, there is no "get all pin" command, and thoses kind of device realy don't like request spamming.

Can use GET and DELETE with
/api/{apikey}/sensors/{sensorid}/state/pin/{userid}

Can use PUT with
/api/{apikey}/sensors/{sensorid}/state/pin
and the body
{"id":4,"type": X, "status":Y, "code":"YYYYYY"}

When a new ID is detected, it will be added in state/pin, but you can delete them even it is not in the Json. The Json don't contain the full id list.

    "state": {
        "doorstate": "closed",
        "lastupdated": "2021-04-30T19:11:59.026",
        "lockstate": "unlocked",
        "notification": "source:manual,code:Manual Unlock,pin:0",
        "pin": [
            {
                "code": "XXXXXXXXXX",
                "id": 2,
                "status": 1,
                "type": 0
            },
            {
                "code": "XXXXXXXXXX",
                "id": 1,
                "status": 1,
                "type": 0
            },
            {
                "code": "1234",
                "id": 3,
                "status": 1,
                "type": 0
            }
        ]
    }

[manup]

Cool, I like that the door lock code moved into a separate file. I'm going to get a Yalelock for testing myself. For the PIN security we still need to find a way which works for all clients, I guess it would be good to create a dedicated issue for that and get discussion and ideas how to approach this.

[zeiphon]

@manup did you end up getting a yale lock for testing?

[bjornomy]

@Smanar this looks very promising. Is there anything I could help with? I have an ID Lock 150 where I would like to use the set/get pin functionality and maybe 'Door opened by user x' or whatever it may be.
I've seen people implementing this (lock) in Zigbee2Mqtt, and I might be able to get some details from them, if needed.

[Smanar]

If I m right the "ID Lock 150" is alreadu in the code ?
This Pr and the key pad one #4758 are in the todo list, it s for that they was recently updated, with some luck we will have them in the future PR validation session.

[bjornomy]

Ahh, sorry, I might have been somewhat unclear.

As far as I understand, this PR improves the generic ZHADoorlock basis that all Zigbee locks could use as a representation of the component. ZHADoorlock is then the object which is serialized into JSON when you GET /api//[sensor|light]/, correct?

It seems to me that this PR adds at least the ability to read out both 'locked/unlocked' and 'open, closed, jammed', which the last of I can't get through the REST API today.

Since my lock has the correct cluster and state fields (0x0101 -> 0x000 - 0x0003), I was simply thinking I could test, or otherwise look through the locks implementation in Zigbee2Mqtt to maybe get some implementation hints towards other useful and generic functionality.

[Smanar]

ZHAdoorlock is already in the code, but yes, the actual version miss some feature like the state/doorstate or the state/notification.
Thoses one are on this PR, and if you have a linux machine with full OS you can test this PR, it was updated recently so it don't miss lot of changes.

[manup]

Small update: I got a Danalock V3 now for testing and will review and test the code after the next stable release.

[wvuyk]

@manup

Are there any plans to implement pin code management possibilities on the Yale lock keypads (and others too I imagine)? I have a customer who would like to implement the zigbee version of Yale lock as the responbse seems to be a lot better then zwave versions. But he needs user (pin) management to have its tracks correct?

Wim

[burken-]

@Smanar @manup Is there anything I can help with to get this PR over the finishline? Would be really neat to have the pin-code handling in the api

[amaino]

Really would like to have PIN management through the REST api. I have a cleaner coming by every second week and want to create a one time pin automatically for him in the morning of the day.

Is there anything I can do to help this PR to go through?

[dtd]

Any updates on progress on this PR? Would really love to have the pin management.