Add door control API #90

drewclauson · 2021-06-03T13:23:44Z

Opening up PR to have a place to discuss adding in these capabilities.

Kane610 · 2021-06-04T18:24:01Z

Awesome! I'll have a look during the weekend

Kane610

Overall it looks great, good job!

Is the whole door control API covered by your implementation? It seems some commands also can provide additional attributes such as AccessTime and OpenTooLongTime

Don't forget to look at events for door state changes so we get that warm fuzzy feeling of push notifications :)

axis/door_control.py

tests/test_door_control.py

drewclauson · 2021-06-08T03:35:39Z

Don't forget to look at events for door state changes so we get that warm fuzzy feeling of push notifications :)

Yes, thanks for the reminder. I just discovered how this works through ONVIF, but need to head to bed for tonight. That part will be a bit easier than I originally thought. At first glance (and I'm new to ONVIF), but looks like adding some notification filters / topics.

Kane610 · 2021-06-08T06:10:42Z

Don't forget to look at events for door state changes so we get that warm fuzzy feeling of push notifications :)

Yes, thanks for the reminder. I just discovered how this works through ONVIF, but need to head to bed for tonight. That part will be a bit easier than I originally thought. At first glance (and I'm new to ONVIF), but looks like adding some notification filters / topics.

Hopefully it's as easy as extending https://github.com/Kane610/axis/blob/master/axis/event_stream.py with a new class

drewclauson · 2021-06-08T18:43:52Z

Don't forget to look at events for door state changes so we get that warm fuzzy feeling of push notifications :)

Yes, thanks for the reminder. I just discovered how this works through ONVIF, but need to head to bed for tonight. That part will be a bit easier than I originally thought. At first glance (and I'm new to ONVIF), but looks like adding some notification filters / topics.

Hopefully it's as easy as extending https://github.com/Kane610/axis/blob/master/axis/event_stream.py with a new class

I think this is the case and I've added the right topics, but when I run __main__ and watch the events come in as I trigger actions manually on the device, I'm not seeing anything related to the topics I added. Should the debug output log out all events that come in from the device or just ones that are in set up event_stream.py? Do you have any other tools that you use to capture events from a device for troubleshooting or anything like that?

Kane610 · 2021-06-08T19:00:42Z

I think this is the case and I've added the right topics, but when I run __main__ and watch the events come in as I trigger actions manually on the device, I'm not seeing anything related to the topics I added. Should the debug output log out all events that come in from the device or just ones that are in set up event_stream.py? Do you have any other tools that you use to capture events from a device for troubleshooting or anything like that?

I don't remember 😂 .

Have you enabled events with main?

axis/axis/__main__.py

Line 92 in 17051d1

parser.add_argument("--events", action="store_true")

This one should print all events

axis/axis/__main__.py

Line 17 in 17051d1

LOGGER.info(f"{action} {event}")

You can put a print here to debug

axis/axis/streammanager.py

Line 67 in 17051d1

self.event(self.data)

drewclauson · 2021-06-08T19:18:23Z

I think this is the case and I've added the right topics, but when I run __main__ and watch the events come in as I trigger actions manually on the device, I'm not seeing anything related to the topics I added. Should the debug output log out all events that come in from the device or just ones that are in set up event_stream.py? Do you have any other tools that you use to capture events from a device for troubleshooting or anything like that?

I don't remember 😂 .

Have you enabled events with main?

axis/axis/__main__.py

Line 92 in 17051d1

parser.add_argument("--events", action="store_true")

This one should print all events

axis/axis/__main__.py

Line 17 in 17051d1

LOGGER.info(f"{action} {event}")

You can put a print here to debug

axis/axis/streammanager.py

Line 67 in 17051d1

self.event(self.data)

LOL and yes, I have --events enabled. I'm wondering if the device isn't sending all the events and I'm missing a configuration requirement for RSTP/ONVIF on the device. I'll keep digging. :-)

Kane610 · 2021-06-08T19:21:50Z

LOL and yes, I have --events enabled. I'm wondering if the device isn't sending all the events and I'm missing a configuration requirement for RSTP/ONVIF on the device. I'll keep digging. :-)

AFAIK it should support metadata events

drewclauson · 2021-06-09T20:33:30Z

I think I have events all configured, just need to add tests. Also, I did finally figure out how to get the events to log out when running with --events. I suspect it was actually a firewall issue as I was accessing my door controller through a firewall. Still more work to do, but I'm figuring some things out.

Remind me - I can't find the comment you previously made - is this the right spot to load/configure/include/not-sure-the-right-word the door_control.py stuff?

https://github.com/drewclauson/axis/blob/fed1fdfd71815f42299a95aaa78088d253209103/axis/vapix.py#L144

Or do I need to include something like how the light_control does it?

https://github.com/drewclauson/axis/blob/fed1fdfd71815f42299a95aaa78088d253209103/axis/vapix.py#L184

Kane610 · 2021-06-09T21:35:40Z

Remind me - I can't find the comment you previously made - is this the right spot to load/configure/include/not-sure-the-right-word the door_control.py stuff?

https://github.com/drewclauson/axis/blob/fed1fdfd71815f42299a95aaa78088d253209103/axis/vapix.py#L144

Or do I need to include something like how the light_control does it?

https://github.com/drewclauson/axis/blob/fed1fdfd71815f42299a95aaa78088d253209103/axis/vapix.py#L184

It depends ;)

If the oldest device available (A1001 in this case) supports API discovery in its latest release, then it is fine to keep it to just be API discovery. But if the A1001 has a too old firmware to work with API discovery then you need to support the older mechanism to identify if it is supported or not. Hope that is clear

Kane610 · 2021-06-15T17:34:37Z

Hey! Press the re-request review button when you want my attention.

Kane610 · 2021-06-21T18:37:10Z

Hey @drewclauson, everything ok?

drewclauson · 2021-06-21T19:33:57Z

Yep, just ran into a home project that has eaten ALL of my time lately. Should have more done next week!

…

On Jun 21, 2021, 2:37 PM -0400, Robert Svensson ***@***.***>, wrote: Hey @drewclauson, everything ok? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub, or unsubscribe.

Kane610 · 2021-06-21T19:38:17Z

Take your time! I will go on vacation next week so might be a bit less active at times

drewclauson · 2021-07-21T13:37:08Z

I'll be coming back to this soon - had a death in the family that made things very busy for a month.

Kane610 · 2021-07-23T19:02:19Z

I'll be coming back to this soon - had a death in the family that made things very busy for a month.

My condolences.

I appreciate the status update but don't feel rushed that I'm expecting preogress. I have a couple of bug reports that I will try to solve before going back to working on Axis integration.

drewclauson · 2021-07-31T18:40:54Z

@Kane610 - I came back to this and fixed the failing flake8 statement. I think this encapsulates the functionality that I think would be beneficial for an A1001 door controller integration, but there might be other API calls that could be helpful. The majority of the Axis door controller API has to do with configuring the controller and I focused on the ones that are more about the day to day operation of the door (lock/unlock/access/etc). My specific use case is just to be able to have a button in HA that will let me click it to open it temporarily, but I tried to go much further outside that into the other API operations.

Let me know what you think! I'm finally back at a place where I can put a bit more time into it.... If I can get past the flake8 guardian 😂

Kane610 · 2021-08-05T07:46:33Z

I'll have a look during the next week. I think regardless of what additional apis to support to keep the PR to one api.

What I think would be interesting is card reader / access panel support. Possibly user support.

Kane610

Sorry, work came back with a wham! after vacation and forgot about this

Kane610 · 2021-08-20T19:42:15Z

axis/door_control.py

+"""Door Control API.
+
+The Axis Door control API makes it possible to control the behavior and functionality
+of physical access controls in the Axis devices (e.g. A1001, A1601)


Remove device examples, access control is enough, I think video door stations might be applicable here as well and I don't want to keep updating the list.

Kane610 · 2021-08-20T19:42:34Z

axis/door_control.py

+        """Initialize door control manager."""
+        super().__init__({}, request, URL, Door)
+
+    # TODO: Question: Is this used to get status information for the door?  Or to update the object properties?


Time to remove it? ;)

Kane610 · 2021-08-20T19:46:14Z

axis/door_control.py

+        """Capabilities of Door."""
+        return self.raw["Capabilities"]
+
+    async def is_capable_of(self, capability: str) -> bool:


Whats the reasoning behind this? When will this be used? It doesnt seem to have test coverage when looking for the method

Kane610 · 2021-08-20T20:01:43Z

tests/event_fixtures.py

@@ -4,6 +4,8 @@

 DAYNIGHT_INIT = b'<?xml version="1.0" encoding="UTF-8"?>\n<tt:MetadataStream xmlns:tt="http://www.onvif.org/ver10/schema">\n<tt:Event><wsnt:NotificationMessage xmlns:tns1="http://www.onvif.org/ver10/topics" xmlns:tnsaxis="http://www.axis.com/2009/event/topics" xmlns:wsnt="http://docs.oasis-open.org/wsn/b-2" xmlns:wsa5="http://www.w3.org/2005/08/addressing"><wsnt:Topic Dialect="http://docs.oasis-open.org/wsn/t-1/TopicExpression/Simple">tns1:VideoSource/tnsaxis:DayNightVision</wsnt:Topic><wsnt:ProducerReference><wsa5:Address>uri://1c8ae81b-3b00-46cf-bf76-79cc3fa533dc/ProducerReference</wsa5:Address></wsnt:ProducerReference><wsnt:Message><tt:Message UtcTime="2019-02-06T18:58:51.007104Z" PropertyOperation="Initialized"><tt:Source><tt:SimpleItem Name="VideoSourceConfigurationToken" Value="1"/></tt:Source><tt:Key></tt:Key><tt:Data><tt:SimpleItem Name="day" Value="1"/></tt:Data></tt:Message></wsnt:Message></wsnt:NotificationMessage></tt:Event></tt:MetadataStream>\n'

+DOOR_MODE_INIT = b'<?xml version="1.0" encoding="UTF-8"?>\n<tt:MetadataStream xmlns:tt="http://www.onvif.org/ver10/schema">\n <tt:Event><wsnt:NotificationMessage xmlns:tns1="http://www.onvif.org/ver10/topics" xmlns:tnsaxis="http://www.axis.com/2009/event/topics" xmlns:wsnt="http://docs.oasis-open.org/wsn/b-2" xmlns:wsa5="http://www.w3.org/2005/08/addressing"><wsnt:Topic Dialect="http://docs.oasis-open.org/wsn/t-1/TopicExpression/Simple">tns1:Door/State/DoorMode</wsnt:Topic><wsnt:ProducerReference><wsa5:Address>uri://755cc9bb-cf3a-410b-bd1b-0ec97c6d6256/ProducerReference</wsa5:Address></wsnt:ProducerReference><wsnt:Message><tt:Message UtcTime="2020-09-05T04:25:51.692744Z" PropertyOperation="Initialized"><tt:Source><tt:SimpleItem Name="DoorToken" Value="Axis-5fba94a4-8601-4627-bdda-cc408f69e026"/></tt:Source><tt:Key></tt:Key><tt:Data><tt:SimpleItem Name="state" Value="Accessed"/></tt:Data></tt:Message></wsnt:Message></wsnt:NotificationMessage></tt:Event></tt:MetadataStream>\n'


Can you generate additional events? The better coverage and examples the easier it will be to maintain

Kane610 · 2021-08-20T20:04:21Z

tests/test_door_control.py

+    assert item.door_name == "Test Door 1"
+    assert item.door_description == "Test Door 1 Description"
+
+    # TODO: Check to see that comparing dict using "==" actually does what I want it to do


Dictionaries are sorted since python 3.6 I think so this should be fine

Kane610 · 2021-08-20T20:25:41Z

tests/test_event_stream.py

@@ -55,66 +56,66 @@ def event_manager(axis_device) -> EventManager:
    [
        (FIRST_MESSAGE, {}),
        (
-            PIR_INIT,


Whats happening with this extra indentation?

Kane610 · 2021-08-20T20:27:23Z

tests/test_event_stream.py

@@ -12,6 +12,7 @@
    FIRST_MESSAGE,
    AUDIO_INIT,
    DAYNIGHT_INIT,
+    DOOR_MODE_INIT,


Please add coverage for all events

Kane610 · 2021-08-20T20:30:24Z

tests/test_door_control.py

+
+
+@respx.mock
+async def test_update(door_control):


All previous tests have a @pytest.mark.asyncio descriptor, if you can pin point what dependency you have in your system that rids that dependency please add it to this PR so I can remove the descriptor.

Kane610 · 2021-09-20T19:15:57Z

Hey @drewclauson everything ok?

drewclauson mentioned this pull request Jun 3, 2021

Support for Access control? #43

Open

Kane610 requested changes Jun 6, 2021

View reviewed changes

axis/door_control.py Show resolved Hide resolved

axis/door_control.py Outdated Show resolved Hide resolved

axis/door_control.py Outdated Show resolved Hide resolved

tests/test_door_control.py Outdated Show resolved Hide resolved

drewclauson added 9 commits June 9, 2021 14:39

Initial start to adding door_control support

78eea76

Updated tests and door_control

2a3a9cf

Removed - not needed

a03bd91

Add capabilities globals

776c8bf

Fix formatting issues

bd92b6d

Docs update

01f4733

Quick pass at a check for capabilities

6ba6f11

Add door events

8762d20

Remove initialization

ecca638

drewclauson force-pushed the add-door-control branch from 082cbe8 to ecca638 Compare June 9, 2021 18:42

drewclauson added 6 commits June 9, 2021 15:00

Fix assignment

4a4c1fa

Remove global

3113545

Add events

02d7ea1

Fix Typo

b3bf6f6

Add API_DISCOVERY_ID back in

d133c1b

Add newline at end of file

fed1fdf

drewclauson added 3 commits June 9, 2021 22:11

No more flake8 complaining.

98d2a75

Parameterize tests!

5fa5026

Anonymize door token

f2fe2c6

drewclauson added 2 commits June 9, 2021 23:36

Anonymize more

07a9dd7

Some event testing added

8015c6a

drewclauson and others added 2 commits July 31, 2021 14:03

Merge branch 'Kane610:master' into add-door-control

cdee38b

Fix indentation

ed9eafc

drewclauson requested a review from Kane610 July 31, 2021 18:38

Kane610 reviewed Aug 20, 2021

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add door control API #90

Add door control API #90

drewclauson commented Jun 3, 2021 •

edited

Loading

Kane610 commented Jun 4, 2021

Kane610 left a comment

drewclauson commented Jun 8, 2021

Kane610 commented Jun 8, 2021

drewclauson commented Jun 8, 2021 •

edited

Loading

Kane610 commented Jun 8, 2021 •

edited

Loading

drewclauson commented Jun 8, 2021

Kane610 commented Jun 8, 2021

drewclauson commented Jun 9, 2021 •

edited

Loading

Kane610 commented Jun 9, 2021

Kane610 commented Jun 15, 2021

Kane610 commented Jun 21, 2021 •

edited

Loading

drewclauson commented Jun 21, 2021 via email

Kane610 commented Jun 21, 2021

drewclauson commented Jul 21, 2021

Kane610 commented Jul 23, 2021

drewclauson commented Jul 31, 2021 •

edited

Loading

Kane610 commented Aug 5, 2021

Kane610 left a comment

Kane610 Aug 20, 2021

Kane610 Aug 20, 2021

Kane610 Aug 20, 2021

Kane610 Aug 20, 2021

Kane610 Aug 20, 2021

Kane610 Aug 20, 2021

Kane610 Aug 20, 2021

Kane610 Aug 20, 2021

Kane610 commented Sep 20, 2021

		@@ -4,6 +4,8 @@

		DAYNIGHT_INIT = b'<?xml version="1.0" encoding="UTF-8"?>\n<tt:MetadataStream xmlns:tt="http://www.onvif.org/ver10/schema">\n<tt:Event><wsnt:NotificationMessage xmlns:tns1="http://www.onvif.org/ver10/topics" xmlns:tnsaxis="http://www.axis.com/2009/event/topics" xmlns:wsnt="http://docs.oasis-open.org/wsn/b-2" xmlns:wsa5="http://www.w3.org/2005/08/addressing"><wsnt:Topic Dialect="http://docs.oasis-open.org/wsn/t-1/TopicExpression/Simple">tns1:VideoSource/tnsaxis:DayNightVision</wsnt:Topic><wsnt:ProducerReference><wsa5:Address>uri://1c8ae81b-3b00-46cf-bf76-79cc3fa533dc/ProducerReference</wsa5:Address></wsnt:ProducerReference><wsnt:Message><tt:Message UtcTime="2019-02-06T18:58:51.007104Z" PropertyOperation="Initialized"><tt:Source><tt:SimpleItem Name="VideoSourceConfigurationToken" Value="1"/></tt:Source><tt:Key></tt:Key><tt:Data><tt:SimpleItem Name="day" Value="1"/></tt:Data></tt:Message></wsnt:Message></wsnt:NotificationMessage></tt:Event></tt:MetadataStream>\n'

		DOOR_MODE_INIT = b'<?xml version="1.0" encoding="UTF-8"?>\n<tt:MetadataStream xmlns:tt="http://www.onvif.org/ver10/schema">\n <tt:Event><wsnt:NotificationMessage xmlns:tns1="http://www.onvif.org/ver10/topics" xmlns:tnsaxis="http://www.axis.com/2009/event/topics" xmlns:wsnt="http://docs.oasis-open.org/wsn/b-2" xmlns:wsa5="http://www.w3.org/2005/08/addressing"><wsnt:Topic Dialect="http://docs.oasis-open.org/wsn/t-1/TopicExpression/Simple">tns1:Door/State/DoorMode</wsnt:Topic><wsnt:ProducerReference><wsa5:Address>uri://755cc9bb-cf3a-410b-bd1b-0ec97c6d6256/ProducerReference</wsa5:Address></wsnt:ProducerReference><wsnt:Message><tt:Message UtcTime="2020-09-05T04:25:51.692744Z" PropertyOperation="Initialized"><tt:Source><tt:SimpleItem Name="DoorToken" Value="Axis-5fba94a4-8601-4627-bdda-cc408f69e026"/></tt:Source><tt:Key></tt:Key><tt:Data><tt:SimpleItem Name="state" Value="Accessed"/></tt:Data></tt:Message></wsnt:Message></wsnt:NotificationMessage></tt:Event></tt:MetadataStream>\n'

Add door control API #90

Are you sure you want to change the base?

Add door control API #90

Conversation

drewclauson commented Jun 3, 2021 • edited Loading

Kane610 commented Jun 4, 2021

Kane610 left a comment

Choose a reason for hiding this comment

drewclauson commented Jun 8, 2021

Kane610 commented Jun 8, 2021

drewclauson commented Jun 8, 2021 • edited Loading

Kane610 commented Jun 8, 2021 • edited Loading

drewclauson commented Jun 8, 2021

Kane610 commented Jun 8, 2021

drewclauson commented Jun 9, 2021 • edited Loading

Kane610 commented Jun 9, 2021

Kane610 commented Jun 15, 2021

Kane610 commented Jun 21, 2021 • edited Loading

drewclauson commented Jun 21, 2021 via email

Kane610 commented Jun 21, 2021

drewclauson commented Jul 21, 2021

Kane610 commented Jul 23, 2021

drewclauson commented Jul 31, 2021 • edited Loading

Kane610 commented Aug 5, 2021

Kane610 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Kane610 commented Sep 20, 2021

drewclauson commented Jun 3, 2021 •

edited

Loading

drewclauson commented Jun 8, 2021 •

edited

Loading

Kane610 commented Jun 8, 2021 •

edited

Loading

drewclauson commented Jun 9, 2021 •

edited

Loading

Kane610 commented Jun 21, 2021 •

edited

Loading

drewclauson commented Jul 31, 2021 •

edited

Loading