New autocoder employing XML definition file format #527

cdjackson · 2019-02-09T18:30:39Z

This PR is a rewrite of the autocoder. Primarily, it changes from an MD format to an XML format. The MD file was getting unmanageable in size as more clusters are added, and it is also more difficult to parse and add new constructs.

This may change the name of some methods due to the way the file is parsed - eg Iascie is now formatted in methods/fields as IasCie and ZoneID is now ZoneId so this may break some implementations (sorry!).

There may also be some changes to commands and attributes as these are now marked with a direction (eg wether an attribute resides in the client or server). This is one of the drivers behind this change - ie to allow a future enhancement which supports different attributes for clients and servers, as required by some clusters.

Currently this PR adds attributes for the server. This needs to be resolved as the OTA is implemented as a client on the device, so this will cause it to not work right now!

@hsudbrock FYI. I still need to test this - it generates code that is pretty much the same as before, but there might be some changes...

Signed-off-by: Chris Jackson chris@cd-jackson.com

codecov · 2019-02-09T18:35:42Z

Codecov Report

❗ No coverage uploaded for pull request base (dev-1.2.0@f14fc50). Click here to learn what that means.
The diff coverage is 47.56%.

@@             Coverage Diff              @@
##             dev-1.2.0     #527   +/-   ##
============================================
  Coverage             ?   24.49%           
  Complexity           ?     3003           
============================================
  Files                ?     1298           
  Lines                ?    45306           
  Branches             ?     1917           
============================================
  Hits                 ?    11097           
  Misses               ?    33629           
  Partials             ?      580

Impacted Files	Coverage Δ	Complexity Δ
...gbee/zcl/clusters/iasace/GetZoneIdMapResponse.java	`0% <ø> (ø)`	`0 <0> (?)`
.../keyestablishment/EphemeralDataRequestCommand.java	`0% <ø> (ø)`	`0 <0> (?)`
...igbee/zcl/clusters/doorlock/UnlockDoorCommand.java	`0% <ø> (ø)`	`0 <0> (?)`
...e/zcl/clusters/general/WriteAttributesCommand.java	`0% <ø> (ø)`	`0 <0> (?)`
...ems/zigbee/zcl/clusters/metering/ChangeSupply.java	`0% <ø> (ø)`	`0 <0> (?)`
...onseandloadcontrol/CancelAllLoadControlEvents.java	`0% <ø> (ø)`	`0 <0> (?)`
...keyestablishment/ConfirmKeyDataRequestCommand.java	`0% <ø> (ø)`	`0 <0> (?)`
...bee/zcl/clusters/ZclPowerConfigurationCluster.java	`0% <ø> (ø)`	`0 <0> (?)`
.../clusters/basic/ResetToFactoryDefaultsCommand.java	`0% <ø> (ø)`	`0 <0> (?)`
.../demandresponseandloadcontrol/EventStatusEnum.java	`0% <ø> (ø)`	`0 <0> (?)`
... and 196 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f14fc50...d364c8e. Read the comment docs.

cdjackson · 2019-02-09T18:41:55Z

This pull request introduces 2 alerts and fixes 1 when merging caa6133 into da475fa - view on LGTM.com

new alerts:

1 for Useless comparison test
1 for Dereferenced variable may be null

fixed alerts:

1 for Useless comparison test

Comment posted by LGTM.com

cdjackson · 2019-02-09T19:15:38Z

This pull request introduces 2 alerts and fixes 10 when merging 06ad4e2 into 2cb1315 - view on LGTM.com

new alerts:

1 for Useless comparison test
1 for Dereferenced variable may be null

fixed alerts:

7 for Useless comparison test
1 for Unused format argument
1 for Missing format argument
1 for Useless null check

Comment posted by LGTM.com

cdjackson · 2019-02-09T19:53:50Z

This pull request introduces 2 alerts and fixes 10 when merging ccd804a into 2cb1315 - view on LGTM.com

new alerts:

1 for Useless comparison test
1 for Dereferenced variable may be null

fixed alerts:

7 for Useless comparison test
1 for Unused format argument
1 for Missing format argument
1 for Useless null check

Comment posted by LGTM.com

t-8ch · 2019-02-09T20:01:06Z

Is it intentional, that the generated code is commited to the repo?
I would have expected the code to be generated at build-time during the generate-sources phase.

t-8ch · 2019-02-09T20:27:22Z

FYI, there is a nice library to support with java code generation: https://github.com/square/javapoet
The current generation seems fine, just to make you aware of it.

t-8ch · 2019-02-09T20:34:19Z

com.zsmartsystems.zigbee.autocode/src/main/java/com/zsmartsystems/zigbee/autocode/FileCopy.java

@@ -0,0 +1,108 @@
+/**


This class seems not to be used. Is something missing from the PR?

cdjackson · 2019-02-09T22:55:02Z

Is it intentional, that the generated code is commited to the repo?

I have been thinking about changing to this concept, but it's always been this way, and I've not bothered to change it. If you want to provide a PR, and it works ok, then that would be great :)

FYI, there is a nice library to support with java code generation: https://github.com/square/javapoet

Thanks. The autocoders in this PR aren't new so I don't really anticipate changing this.

This class seems not to be used. Is something missing from the PR?

Thanks - looks like I moved the functions out of the class at some point in the past, so it's not used. I've removed it.

cdjackson · 2019-02-09T23:08:40Z

This pull request introduces 2 alerts and fixes 10 when merging e6df9bd into 2cb1315 - view on LGTM.com

new alerts:

1 for Useless comparison test
1 for Dereferenced variable may be null

fixed alerts:

7 for Useless comparison test
1 for Unused format argument
1 for Missing format argument
1 for Useless null check

Comment posted by LGTM.com

cdjackson · 2019-02-15T23:54:30Z

This pull request introduces 2 alerts and fixes 10 when merging 4be095b into 263da31 - view on LGTM.com

new alerts:

1 for Useless comparison test
1 for Dereferenced variable may be null

fixed alerts:

7 for Useless comparison test
1 for Unused format argument
1 for Missing format argument
1 for Useless null check

Comment posted by LGTM.com

hsudbrock · 2019-02-22T14:34:44Z

@cdjackson I have started testing with the code from this PR; so far, things look good.

We discussed that it could be good to include these changes together with the changes necessary for the manufacturer-specific clusters, so I will simply rebase my PR for the manufacturer-specific clusters on this PR.

cdjackson · 2019-02-22T14:45:02Z

Thanks Henning - sounds good.

…

Sent from my iPhone

On 22 Feb 2019, at 08:34, Henning Sudbrock ***@***.***> wrote: @cdjackson I have started testing with the code from this PR; so far, things look good. We discussed that it could be good to include these changes together with the changes necessary for the manufacturer-specific clusters, so I will simply rebase my PR for the manufacturer-specific clusters on this PR. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub, or mute the thread.

hsudbrock · 2019-02-25T15:34:23Z

Chris, I am currently developing in openHAB based on this branch, also for testing it some more. What would be helpful is support for client-side attributes, as otherwise discoveries always run into a NPE (the node property discoverer tries to read the FW version, which fails as this is a client-side attribute that is not yet written into the attribute list of the ZclOtaUpgradeCluster).

So, if you happen to push updates to this branch, this would be helpful for me :) (But I can work around this in the time being...)

hsudbrock · 2019-02-25T15:44:44Z

...gbee.autocode/src/main/java/com/zsmartsystems/zigbee/autocode/ZigBeeZclCommandGenerator.java

+                out.println("    public boolean isTransactionMatch(ZigBeeCommand request, ZigBeeCommand response) {");
+                if (command.response.matchers.isEmpty()) {
+                    out.println("        return (response instanceof " + command.response.command + ")");
+                    out.println("                & ((ZdoRequest) request).getDestinationAddress().equals((("


Small typo: This should be && here (one & is missing).

cdjackson · 2019-02-25T19:08:48Z

This pull request introduces 2 alerts and fixes 8 when merging 5ada35f into ec8c99e - view on LGTM.com

new alerts:

1 for Useless comparison test
1 for Dereferenced variable may be null

fixed alerts:

7 for Useless comparison test
1 for Useless null check

Comment posted by LGTM.com

cdjackson · 2019-04-20T07:47:54Z

This pull request introduces 3 alerts and fixes 8 when merging ea3327e into cfca6e7 - view on LGTM.com

new alerts:

1 for Useless comparison test
1 for Dereferenced variable may be null
1 for Unused format argument

fixed alerts:

7 for Useless comparison test
1 for Useless null check

Comment posted by LGTM.com

cdjackson · 2019-04-20T08:09:59Z

This pull request fixes 8 alerts when merging 22f8c83 into cfca6e7 - view on LGTM.com

fixed alerts:

7 for Useless comparison test
1 for Useless null check

Comment posted by LGTM.com

cdjackson · 2019-04-20T22:54:05Z

This pull request fixes 8 alerts when merging d47fce4 into 1671d47 - view on LGTM.com

fixed alerts:

7 for Useless comparison test
1 for Useless null check

Comment posted by LGTM.com

cdjackson · 2019-04-20T23:26:53Z

This pull request fixes 8 alerts when merging 5c4c587 into edcce46 - view on LGTM.com

fixed alerts:

7 for Useless comparison test
1 for Useless null check

Comment posted by LGTM.com

Signed-off-by: Chris Jackson <chris@cd-jackson.com>

…methods Signed-off-by: Chris Jackson <chris@cd-jackson.com>

Signed-off-by: Chris Jackson <chris@cd-jackson.com>

cdjackson · 2019-04-21T13:57:56Z

This pull request fixes 8 alerts when merging d364c8e into f14fc50 - view on LGTM.com

fixed alerts:

7 for Useless comparison test
1 for Useless null check

Comment posted by LGTM.com

New autocoder employing XML definition file format Signed-off-by: Chris Jackson <chris@cd-jackson.com>

cdjackson added the breaking change label Feb 9, 2019

cdjackson force-pushed the XML-autocoder branch from caa6133 to 06ad4e2 Compare February 9, 2019 19:04

zsmartsystems deleted a comment Feb 9, 2019

cdjackson force-pushed the XML-autocoder branch 3 times, most recently from d5848e9 to ccd804a Compare February 9, 2019 19:42

zsmartsystems deleted a comment Feb 9, 2019

t-8ch reviewed Feb 9, 2019

View reviewed changes

cdjackson force-pushed the XML-autocoder branch from ccd804a to e6df9bd Compare February 9, 2019 22:57

zsmartsystems deleted a comment Feb 9, 2019

cdjackson added this to the 1.2.0 milestone Feb 10, 2019

cdjackson mentioned this pull request Feb 10, 2019

Add suport for the FAN_CONTROL cluster openhab/org.openhab.binding.zigbee#358

Closed

t-8ch mentioned this pull request Feb 12, 2019

[WIP] execute autocode from maven #531

Open

hsudbrock mentioned this pull request Feb 14, 2019

Wrong datatypes configured in thermostat cluster #534

Closed

cdjackson force-pushed the XML-autocoder branch from e6df9bd to 4be095b Compare February 15, 2019 23:42

zsmartsystems deleted a comment Feb 16, 2019

hsudbrock reviewed Feb 25, 2019

View reviewed changes

cdjackson force-pushed the XML-autocoder branch 2 times, most recently from bb47da3 to 22f8c83 Compare April 20, 2019 07:58

cdjackson force-pushed the XML-autocoder branch from 22f8c83 to d47fce4 Compare April 20, 2019 22:42

cdjackson force-pushed the XML-autocoder branch from d47fce4 to 5c4c587 Compare April 20, 2019 23:15

cdjackson force-pushed the dev-1.2.0 branch from edcce46 to f14fc50 Compare April 21, 2019 10:58

cdjackson added 12 commits April 21, 2019 11:58

New autocoder employing XML definition file format

29b38cc

Signed-off-by: Chris Jackson <chris@cd-jackson.com>

Fix matcher logic

f88b857

Signed-off-by: Chris Jackson <chris@cd-jackson.com>

Updated handling of cluster commands

f00f8b5

Signed-off-by: Chris Jackson <chris@cd-jackson.com>

Refactor to remove ZclCommandType enumeration

cd892c0

Signed-off-by: Chris Jackson <chris@cd-jackson.com>

Remove ZclDataType from auto code generation

c855922

Signed-off-by: Chris Jackson <chris@cd-jackson.com>

Provide public definitions of cluster and command IDs used in commands

8653875

Signed-off-by: Chris Jackson <chris@cd-jackson.com>

Fix errors in Thermostat cluster definition

54733cb

Signed-off-by: Chris Jackson <chris@cd-jackson.com>

Update some SmartEnergy attributes

697493a

Signed-off-by: Chris Jackson <chris@cd-jackson.com>

Add Analog Input (Basic) cluster

20add9b

Signed-off-by: Chris Jackson <chris@cd-jackson.com>

Split client/server attributes and refactor ZCL attribute read/write …

863bd77

…methods Signed-off-by: Chris Jackson <chris@cd-jackson.com>

Update ZclAttribute to add new methods and constructor

34760a8

Signed-off-by: Chris Jackson <chris@cd-jackson.com>

Add ZclAttributeDao

d364c8e

Signed-off-by: Chris Jackson <chris@cd-jackson.com>

cdjackson force-pushed the XML-autocoder branch from 5c4c587 to d364c8e Compare April 21, 2019 13:46

cdjackson merged commit 4904774 into dev-1.2.0 Apr 21, 2019

cdjackson added a commit that referenced this pull request Apr 23, 2019

New autocoder employing XML definition file format (#527)

fc82fe4

New autocoder employing XML definition file format Signed-off-by: Chris Jackson <chris@cd-jackson.com>

cdjackson added a commit that referenced this pull request Apr 27, 2019

New autocoder employing XML definition file format (#527)

42cb457

New autocoder employing XML definition file format Signed-off-by: Chris Jackson <chris@cd-jackson.com>

cdjackson added a commit that referenced this pull request Apr 28, 2019

New autocoder employing XML definition file format (#527)

4fc27ce

New autocoder employing XML definition file format Signed-off-by: Chris Jackson <chris@cd-jackson.com>

cdjackson added a commit that referenced this pull request May 4, 2019

New autocoder employing XML definition file format (#527)

529465e

New autocoder employing XML definition file format Signed-off-by: Chris Jackson <chris@cd-jackson.com>

cdjackson added a commit that referenced this pull request May 7, 2019

New autocoder employing XML definition file format (#527)

344f5c4

New autocoder employing XML definition file format Signed-off-by: Chris Jackson <chris@cd-jackson.com>

cdjackson added a commit that referenced this pull request May 10, 2019

New autocoder employing XML definition file format (#527)

aa18972

New autocoder employing XML definition file format Signed-off-by: Chris Jackson <chris@cd-jackson.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New autocoder employing XML definition file format #527

New autocoder employing XML definition file format #527

cdjackson commented Feb 9, 2019 •

edited

codecov bot commented Feb 9, 2019 •

edited

cdjackson commented Feb 9, 2019

cdjackson commented Feb 9, 2019

cdjackson commented Feb 9, 2019

t-8ch commented Feb 9, 2019

t-8ch commented Feb 9, 2019

t-8ch Feb 9, 2019

cdjackson commented Feb 9, 2019

cdjackson commented Feb 9, 2019

cdjackson commented Feb 15, 2019

hsudbrock commented Feb 22, 2019

cdjackson commented Feb 22, 2019 via email

hsudbrock commented Feb 25, 2019

hsudbrock Feb 25, 2019

cdjackson commented Feb 25, 2019

cdjackson commented Apr 20, 2019

cdjackson commented Apr 20, 2019

cdjackson commented Apr 20, 2019

cdjackson commented Apr 20, 2019

cdjackson commented Apr 21, 2019

New autocoder employing XML definition file format #527

New autocoder employing XML definition file format #527

Conversation

cdjackson commented Feb 9, 2019 • edited

codecov bot commented Feb 9, 2019 • edited

Codecov Report

cdjackson commented Feb 9, 2019

cdjackson commented Feb 9, 2019

cdjackson commented Feb 9, 2019

t-8ch commented Feb 9, 2019

t-8ch commented Feb 9, 2019

t-8ch Feb 9, 2019

Choose a reason for hiding this comment

cdjackson commented Feb 9, 2019

cdjackson commented Feb 9, 2019

cdjackson commented Feb 15, 2019

hsudbrock commented Feb 22, 2019

cdjackson commented Feb 22, 2019 via email

hsudbrock commented Feb 25, 2019

hsudbrock Feb 25, 2019

Choose a reason for hiding this comment

cdjackson commented Feb 25, 2019

cdjackson commented Apr 20, 2019

cdjackson commented Apr 20, 2019

cdjackson commented Apr 20, 2019

cdjackson commented Apr 20, 2019

cdjackson commented Apr 21, 2019

cdjackson commented Feb 9, 2019 •

edited

codecov bot commented Feb 9, 2019 •

edited