[openwebnet] Add a time stamp when an alarm zone event occurs #14819

fabgio · 2023-04-15T16:45:46Z

Description:
This PR allows to show a time stamp when an alarm zone event occurs on Bticino/Legrand Alarm systems such as an Intrusion or a Tampering This PR closes #14535

Test
Tested on BTicino/Legrand bulgrar-alarm unit 3486

mvalla

@fabgio see required changes.

You also have to generate the default English localization, see: https://github.com/openhab/openhab-addons#translations

This is a second PR after #14743
PS
Do not change again the PR, beacuse each time a new review is required.

mvalla · 2023-04-15T20:23:49Z

bundles/org.openhab.binding.openwebnet/README.md

+| `network`                    | `bus_alarm_system`                     | Switch    | Alarm system network state (`ON` = network ok, `OFF` = no network)    |      R      |
+| `battery`                    | `bus_alarm_system`                     | String    | Alarm system battery state (`OK`, `FAULT`, `UNLOADED`)                |      R      |
+| `armed`                      | `bus_alarm_system`                     | Switch    | Alarm system is armed (`ON`) or disarmed (`OFF`)                      |      R      |
+| `alarm`                      | `bus_alarm_zone`                       | String    | Current alarm for the zone  (`SILENT`, `INTRUSION`, `TAMPERING`, `ANTI_PANIC`) |      R      |


can you modifiy only the lines related to adding the new channel?

Actually I did'nt change this lines I can't figure out why they appear as changed. I cannot spot any difference.. Can you?

maybe spaces? Copy paste the original lines from original version

...webnet/src/main/java/org/openhab/binding/openwebnet/internal/OpenWebNetBindingConstants.java

mvalla · 2023-04-15T20:29:08Z

...et/src/main/java/org/openhab/binding/openwebnet/internal/handler/OpenWebNetAlarmHandler.java

@@ -232,31 +240,44 @@ private void updateZoneAlarm(WhatAlarm w) {
        switch (w) {
            case ZONE_ALARM_INTRUSION:
                updateState(CHANNEL_ALARM_ZONE_ALARM, new StringType(ALARM_INTRUSION));
+                updateZoneAlarmTimeStamp();


you have to choose when updateZoneAlarmTimeStamp is called. This way it's called 2 times: in the switch inside updateZoneAlarm and then again in the updateZone switch

You are right, I choose to call it in updateZone() to invoke it only once

mvalla · 2023-04-15T20:29:25Z

...et/src/main/java/org/openhab/binding/openwebnet/internal/handler/OpenWebNetAlarmHandler.java

                break;
            case ZONE_ALARM_TAMPERING:
                updateState(CHANNEL_ALARM_ZONE_ALARM, new StringType(ALARM_TAMPERING));
+                updateZoneAlarmTimeStamp();


see previous comment

mvalla · 2023-04-15T20:29:30Z

...et/src/main/java/org/openhab/binding/openwebnet/internal/handler/OpenWebNetAlarmHandler.java

                break;
            case ZONE_ALARM_ANTI_PANIC:
                updateState(CHANNEL_ALARM_ZONE_ALARM, new StringType(ALARM_ANTI_PANIC));
+                updateZoneAlarmTimeStamp();


see previous comment

mvalla · 2023-04-15T20:30:08Z

...et/src/main/java/org/openhab/binding/openwebnet/internal/handler/OpenWebNetAlarmHandler.java

@@ -218,6 +225,7 @@ private void updateZone(Alarm msg) {
            case ZONE_ALARM_TECHNICAL:
            case ZONE_ALARM_TECHNICAL_RESET:
                updateZoneAlarm(w);
+                updateZoneAlarmTimeStamp();


you have to choose when updateZoneAlarmTimeStamp is called. This way it's called 2 times: in the switch inside updateZoneAlarm and then again in the updateZone switch

ok I will call it in updateZone() only

mvalla · 2023-04-15T20:31:36Z

...et/src/main/java/org/openhab/binding/openwebnet/internal/handler/OpenWebNetAlarmHandler.java

                break;
            default:
                updateState(CHANNEL_ALARM_ZONE_ALARM, new StringType(ALARM_NONE));
                logger.warn("Alarm.updateZoneAlarm() Ignoring unsupported WHAT {} for  zone {}", w, this.deviceWhere);
        }
    }

+    private void updateZoneAlarmTimeStamp() {
+        ZonedDateTime now = ZonedDateTime.now();
+        ChannelUID cuid = new ChannelUID(getThing().getUID(), CHANNEL_ALARM_ZONE_TIMESTAMP);


this line is useless. Why don't you do the same like in initialize():
updateState(CHANNEL_ALARM_ZONE_TIMESTAMP, ....

mvalla · 2023-04-15T20:33:46Z

bundles/org.openhab.binding.openwebnet/src/main/resources/OH-INF/thing/BusAlarmZone.xml

@@ -17,6 +17,7 @@
 			<!-- read only -->
 			<channel id="state" typeId="alarmZoneState"/>
 			<channel id="alarm" typeId="zoneAlarm"/>
+			<channel id="timestamp" typeId="zoneAlarmTimeStamp"/>


Suggested change

<channel id="timestamp" typeId="zoneAlarmTimeStamp"/>

<channel id="timestamp" typeId="zoneAlarmTimestamp"/>

Timestamp and not TimeStamp (it's one word)

mvalla · 2023-04-15T20:34:21Z

bundles/org.openhab.binding.openwebnet/src/main/resources/OH-INF/thing/channels.xml

@@ -461,6 +461,14 @@
 		</state>
 	</channel-type>

+	<channel-type id="zoneAlarmTimeStamp">


Suggested change

<channel-type id="zoneAlarmTimeStamp">

<channel-type id="zoneAlarmTimestamp">

mvalla · 2023-04-15T20:35:26Z

bundles/org.openhab.binding.openwebnet/src/main/resources/OH-INF/thing/channels.xml

@@ -461,6 +461,14 @@
 		</state>
 	</channel-type>

+	<channel-type id="zoneAlarmTimeStamp">
+		<item-type>DateTime</item-type>
+		<label>Zone TimeStamp</label>


Suggested change

<label>Zone TimeStamp</label>

<label>Zone Alarm Timestamp</label>

mvalla · 2023-04-16T20:26:06Z

bundles/org.openhab.binding.openwebnet/src/main/resources/OH-INF/i18n/openwebnet.properties

@@ -285,6 +285,8 @@ channel-type.openwebnet.zoneAlarm.state.option.SILENT = Silent
 channel-type.openwebnet.zoneAlarm.state.option.TECHNICAL = Technical
 channel-type.openwebnet.zoneAlarm.state.option.TECHNICAL_RESET = Technical Reset
 channel-type.openwebnet.zoneAlarm.state.option.NONE = None
+channel-type.openwebnet.zoneAlarmTimestamp.label = Zone Alarm TimeStamp


Suggested change

channel-type.openwebnet.zoneAlarmTimestamp.label = Zone Alarm TimeStamp

channel-type.openwebnet.zoneAlarmTimestamp.label = Zone Alarm Timestamp

mvalla · 2023-04-16T20:26:37Z

bundles/org.openhab.binding.openwebnet/src/main/resources/OH-INF/thing/channels.xml

 		<item-type>DateTime</item-type>
-		<label>Zone TimeStamp</label>
+		<label>Zone Alarm TimeStamp</label>


Suggested change

<label>Zone Alarm TimeStamp</label>

<label>Zone Alarm Timestamp</label>

mvalla · 2023-04-16T20:28:44Z

...et/src/main/java/org/openhab/binding/openwebnet/internal/handler/OpenWebNetAlarmHandler.java

@@ -270,14 +264,13 @@ private void updateZoneAlarm(WhatAlarm w) {

    private void updateZoneAlarmTimeStamp() {
        ZonedDateTime now = ZonedDateTime.now();


Suggested change

ZonedDateTime now = ZonedDateTime.now();

mvalla · 2023-04-16T20:29:05Z

...et/src/main/java/org/openhab/binding/openwebnet/internal/handler/OpenWebNetAlarmHandler.java

@@ -270,14 +264,13 @@ private void updateZoneAlarm(WhatAlarm w) {

    private void updateZoneAlarmTimeStamp() {
        ZonedDateTime now = ZonedDateTime.now();
-        ChannelUID cuid = new ChannelUID(getThing().getUID(), CHANNEL_ALARM_ZONE_TIMESTAMP);
-        updateState(cuid, new DateTimeType(now.truncatedTo(ChronoUnit.SECONDS)));
+        updateState(CHANNEL_ALARM_ZONE_ALARM_TIMESTAMP, new DateTimeType(now.truncatedTo(ChronoUnit.SECONDS)));


Suggested change

updateState(CHANNEL_ALARM_ZONE_ALARM_TIMESTAMP, new DateTimeType(now.truncatedTo(ChronoUnit.SECONDS)));

updateState(CHANNEL_ALARM_ZONE_ALARM_TIMESTAMP, new DateTimeType());

line 266 is unuseful at this point so I would remove it and as a consequence would be updateZoneTimeStamp() implementation still convenient? I could simply invoke updateState(CHANNEL_ALARM_ZONE_ALARM_TIMESTAMP, new DateTimeType()) directly in updateZone()?

done as per previous comment

mvalla · 2023-04-16T20:30:58Z

bundles/org.openhab.binding.openwebnet/README.md

+| `network`                    | `bus_alarm_system`                     | Switch    | Alarm system network state (`ON` = network ok, `OFF` = no network)    |      R      |
+| `battery`                    | `bus_alarm_system`                     | String    | Alarm system battery state (`OK`, `FAULT`, `UNLOADED`)                |      R      |
+| `armed`                      | `bus_alarm_system`                     | Switch    | Alarm system is armed (`ON`) or disarmed (`OFF`)                      |      R      |
+| `alarm`                      | `bus_alarm_zone`                       | String    | Current alarm for the zone  (`SILENT`, `INTRUSION`, `TAMPERING`, `ANTI_PANIC`) |      R      |


maybe spaces? Copy paste the original lines from original version

mvalla

LGTM

fabgio · 2023-04-18T06:23:16Z

Thank you so much!

lolodomo · 2023-04-24T11:42:11Z

Please add migration instructions for the new channel.
A link to the documentation
https://next.openhab.org/docs/developer/bindings/thing-xml.html#updating-thing-types

mvalla

I never used such migration feature, but I think that:

directory is wrong
< label > should be the new channel label, not its description
according to instructions this is also needed that "In addition to the update instructions, the thing-type definition needs to add a property thingTypeVersion to prevent newly created things from being modified"

fabgio · 2023-04-24T16:55:53Z

@mvalla I see, I will check in accordance with your tips.

I never used such a migration feature

So do I, that is completely new to me

fabgio · 2023-04-25T10:52:43Z

@mvalla I fulfilled all of the three points you mentioned above. Moreover I validated update.xml for correctness

bundles/org.openhab.binding.openwebnet/src/main/resources/OH-INF/thing/channels.xml

...et/src/main/java/org/openhab/binding/openwebnet/internal/handler/OpenWebNetAlarmHandler.java

bundles/org.openhab.binding.openwebnet/src/main/resources/OH-INF/update/update.xml

bundles/org.openhab.binding.openwebnet/src/main/resources/OH.INF/update/update.xml

fabgio · 2023-05-03T15:48:41Z

Do you mean I should remove that line,right? I removed it and validate update.xml with no errors

lolodomo · 2023-05-03T17:27:35Z

You have update.xml twice in 2 different folders: OH-INF/update and OH.INF/update. Only the first is needed.

fabgio · 2023-05-03T17:36:14Z

You are right My local branch does not show OH.INF update whereas the origin does. lets try push it

fabgio · 2023-05-03T18:07:04Z

I am striving to get rid of the wrong OH.INF dir from my origin even by forcing push... I will handle this problem

fabgio · 2023-05-03T19:55:36Z

ok OH.INF dir has gone now!!!

lolodomo

LGTM, thank you

lolodomo · 2023-05-04T07:05:52Z

DCO KO.
Maybe you did not sign-off properly one of your last commits ?
Please fix it in case it is the last one. If not, squash several of your commits.

This reverts commit 3807c80. Signed-off-by: Giovanni Fabiani <[email protected]>

fabgio · 2023-05-04T16:57:02Z

DTO is ok now.. tommorow I will do further integration-tests, waiting for @mvalla review

fabgio · 2023-05-04T16:58:21Z

@lolodomo I appreciated your support! Thanks a lot

lolodomo · 2023-05-04T18:33:59Z

tommorow I will do further integration-tests, waiting for @mvalla review

Do you mean the PR is not yet ready for a merge?

fabgio · 2023-05-04T19:01:39Z

Yes, Exactly I prefer to perform a couple of integration tests tomorrow so if everything works as expected and @mvalla agrees, on saturday the PR will be ready for merge!

lolodomo · 2023-05-05T08:16:54Z

Current code looks good to me.

fabgio · 2023-05-05T14:09:55Z

@lolodomo, i did tests. Good feedbacks! To me the PR is ready for merge

lolodomo

LGTM, thank you

fabgio · 2023-05-05T14:19:11Z

Thanks again See you soon!

fabgio · 2023-05-09T18:14:02Z

Hi lolodomo! After the merging of my PR I am not able to compile the binding anymore. Even Cloning from Main repo! This is the message [WARNING] Could not transfer metadata org.openhab:openhab-super-pom/maven-metadata.xml from/to github (https://maven.pkg.github.com/fabgio/14535_openwebnet_4.0.0_publish): authentication failed for https://maven.pkg.github.com/fabgio/14535_openwebnet_4.0.0_publish/org/openhab/openhab-super-pom/maven-metadata.xml, status: 401 Unauthorized It looks that maven looks for an unwanted dependency… I don’t know where it comes from I need help.. I am terrified!!! Please help!! From: lolodomo ***@***.***> Sent: giovedì 4 maggio 2023 20:34 To: openhab/openhab-addons ***@***.***> Cc: Giovanni Fabiani ***@***.***>; Mention ***@***.***> Subject: Re: [openhab/openhab-addons] [openwebnet] Add a time stamp when an alarm zone event occurs (PR #14819) tommorow I will do further integration-tests, waiting for @mvalla <https://github.com/mvalla> review Do you mean the PR is not yet ready for a merge? — Reply to this email directly, view it on GitHub <#14819 (comment)> , or unsubscribe <https://github.com/notifications/unsubscribe-auth/ACZHU6DATRC2KFU6T4RXBDLXEPZCFANCNFSM6AAAAAAW7QR7QU> . You are receiving this because you were mentioned. <https://github.com/notifications/beacon/ACZHU6AVJSQVA55QKYECUELXEPZCFA5CNFSM6AAAAAAW7QR7QWWGG33NNVSW45C7OR4XAZNMJFZXG5LFINXW23LFNZ2KUY3PNVWWK3TUL5UWJTS3QG6KA.gif> Message ID: ***@***.*** ***@***.***> >

This reverts commit 3807c80. Signed-off-by: Giovanni Fabiani <[email protected]> Signed-off-by: Thomas Burri <[email protected]>

This reverts commit 3807c80. Signed-off-by: Giovanni Fabiani <[email protected]> Signed-off-by: Matt Myers <[email protected]>

This reverts commit 3807c80. Signed-off-by: Giovanni Fabiani <[email protected]> Signed-off-by: Jørgen Austvik <[email protected]>

fabgio requested a review from mvalla as a code owner April 15, 2023 16:45

mvalla requested changes Apr 15, 2023

View reviewed changes

mvalla added the enhancement An enhancement or new feature for an existing add-on label Apr 15, 2023

mvalla requested changes Apr 16, 2023

View reviewed changes

mvalla approved these changes Apr 17, 2023

View reviewed changes

mvalla requested changes Apr 24, 2023

View reviewed changes

lolodomo requested changes May 3, 2023

View reviewed changes

lolodomo approved these changes May 4, 2023

View reviewed changes

[openwebnet] Final review

437bcc1

This reverts commit 3807c80. Signed-off-by: Giovanni Fabiani <[email protected]>

lolodomo added the work in progress A PR that is not yet ready to be merged label May 5, 2023

lolodomo removed the work in progress A PR that is not yet ready to be merged label May 5, 2023

lolodomo approved these changes May 5, 2023

View reviewed changes

lolodomo merged commit 7bcf2e7 into openhab:main May 5, 2023

lolodomo added this to the 4.0 milestone May 5, 2023

fabgio deleted the 14535_openwebnet_4.0.0 branch May 9, 2023 16:27

tb4jc pushed a commit to tb4jc/openhab-addons that referenced this pull request Jun 19, 2023

[openwebnet] Final review (openhab#14819)

ed05f6f

This reverts commit 3807c80. Signed-off-by: Giovanni Fabiani <[email protected]> Signed-off-by: Thomas Burri <[email protected]>

matchews pushed a commit to matchews/openhab-addons that referenced this pull request Aug 9, 2023

[openwebnet] Final review (openhab#14819)

c958d71

This reverts commit 3807c80. Signed-off-by: Giovanni Fabiani <[email protected]> Signed-off-by: Matt Myers <[email protected]>

austvik pushed a commit to austvik/openhab-addons that referenced this pull request Mar 27, 2024

[openwebnet] Final review (openhab#14819)

69a60b5

This reverts commit 3807c80. Signed-off-by: Giovanni Fabiani <[email protected]> Signed-off-by: Jørgen Austvik <[email protected]>

	<channel id="timestamp" typeId="zoneAlarmTimeStamp"/>
	<channel id="timestamp" typeId="zoneAlarmTimestamp"/>

	<channel-type id="zoneAlarmTimeStamp">
	<channel-type id="zoneAlarmTimestamp">

	<label>Zone TimeStamp</label>
	<label>Zone Alarm Timestamp</label>

	channel-type.openwebnet.zoneAlarmTimestamp.label = Zone Alarm TimeStamp
	channel-type.openwebnet.zoneAlarmTimestamp.label = Zone Alarm Timestamp

		@@ -270,14 +264,13 @@ private void updateZoneAlarm(WhatAlarm w) {

		private void updateZoneAlarmTimeStamp() {
		ZonedDateTime now = ZonedDateTime.now();

	updateState(CHANNEL_ALARM_ZONE_ALARM_TIMESTAMP, new DateTimeType(now.truncatedTo(ChronoUnit.SECONDS)));
	updateState(CHANNEL_ALARM_ZONE_ALARM_TIMESTAMP, new DateTimeType());

[openwebnet] Add a time stamp when an alarm zone event occurs #14819

[openwebnet] Add a time stamp when an alarm zone event occurs #14819

Conversation

fabgio commented Apr 15, 2023 • edited Loading

mvalla left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fabgio Apr 16, 2023 • edited Loading

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fabgio Apr 16, 2023 • edited Loading

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

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

fabgio Apr 17, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mvalla left a comment

Choose a reason for hiding this comment

fabgio commented Apr 18, 2023

lolodomo commented Apr 24, 2023

mvalla left a comment • edited Loading

Choose a reason for hiding this comment

fabgio commented Apr 24, 2023 • edited Loading

fabgio commented Apr 25, 2023

fabgio commented May 3, 2023

lolodomo commented May 3, 2023

fabgio commented May 3, 2023

fabgio commented May 3, 2023

fabgio commented May 3, 2023

lolodomo left a comment

Choose a reason for hiding this comment

lolodomo commented May 4, 2023

fabgio commented May 4, 2023 • edited Loading

fabgio commented May 4, 2023 • edited Loading

lolodomo commented May 4, 2023

fabgio commented May 4, 2023

lolodomo commented May 5, 2023

fabgio commented May 5, 2023 • edited Loading

lolodomo left a comment

Choose a reason for hiding this comment

fabgio commented May 5, 2023

fabgio commented May 9, 2023 via email

fabgio commented Apr 15, 2023 •

edited

Loading

fabgio Apr 16, 2023 •

edited

Loading

fabgio Apr 16, 2023 •

edited

Loading

fabgio Apr 17, 2023 •

edited

Loading

mvalla left a comment •

edited

Loading

fabgio commented Apr 24, 2023 •

edited

Loading

fabgio commented May 4, 2023 •

edited

Loading

fabgio commented May 4, 2023 •

edited

Loading

fabgio commented May 5, 2023 •

edited

Loading