[hueemulation] Migrate to bnd #5243

davidgraeff · 2019-03-25T16:17:57Z

Migrated to bnd (cherry pick possible)
Added Hue scenes support (via the automation engine)
Added Hue rules support (via the automation engine)
Added Hue schedules support (via the automation engine)
Added sensors support (exposing COLOR, DIMMER, ROLLERSHUTTER, SWITCH, CONTACT, NUMBER item types)
Self-check page with many statistics for troubleshooting
Added tests for all added functionality and extended other tests
- All tests are non-OSGi tests now. REST access is tested via a local jersey server. upnp is tested via direct udp datagram sockets. Test coverage 90%.
- There is only one OSGi test left for testing if the hue service comes up with all OSGi dependencies.

The Hue emulation service now provides about 95% of a real Hue bridge with firmware 1.22 and 100% of a Hue bridge with firmware 1.12.
Some details like https access and recurring timers with random element cannot be expressed by current openHAB means.

File statistics:

Tests: 3434 LOC (those are unit tests but also real http access tests for all endpoints)
Main: 6722 LOC (including non-java: 7027)
- Service + UPNP Server + Utilities: 1672 LOC
- Automation: 793 LOC
- DTO: 1875 LOC
- Logic/REST-API: 2342 LOC
Integration test: 236 LOC

Jar (works on OH 2.5 snapshots only)

Uninstall an existing hue emulation service.
Install the ("experimental") new rule engine
Install any binding that uses and installs "upnp" (for example the Yahama binding)
Download and unzip the following file
Drop the unzipped jar into your addons directory.

V29
org.openhab.io.hueemulation-2.5.0-SNAPSHOT-v29.zip

Do not use this on your production system, as it does not respect former item <--> hue id mappings.

Head to http://your-ip:8080/api/status for the self test status page:

martinvw · 2019-03-27T19:29:39Z

The build seems unhappy

davidgraeff · 2019-03-27T19:41:04Z

Yup, I have added the wip label. I'm also extending this service atm to support rooms, scenes and rules.

davidgraeff · 2019-04-06T08:44:20Z

Because 9k lines of code is hard to review, how should I proceed here?

The service is very modular, so I could make multiple pull requests introducing one feature at a time? 1/4 of the code is also tests only.

To make the review process easier I have:

Checked all author tags
Checked all licenses
Fixed or worked around all SAT warning findings
Changed the formatter settings to include newlines for all java files
Performed an eclipse autoformat for all java files
Added javadoc to all classes with reduced (one line or zero line) javadoc for DTO classes

I will also try to find 2 people that can confirm it works for them.

openhab-bot · 2019-04-06T09:36:45Z

This pull request has been mentioned on openHAB Community. There might be relevant details there:

https://community.openhab.org/t/hue-emulation-only-color-temperature-light/71832/4

openhab-bot · 2019-04-06T09:39:37Z

This pull request has been mentioned on openHAB Community. There might be relevant details there:

https://community.openhab.org/t/hue-emulation-re-sequences-hueids-on-openhab-service-restart-causes-out-of-sync-with-alexa/62294/7

mbehr1 · 2019-04-07T06:12:14Z

I'm testing the .jar you linked above but it fails to start:
│2019-04-07 08:07:34.279 [WARN ] [org.apache.felix.fileinstall ] - Error while starting bundle: file:/usr/share/openhab2/addons/org.openhab.io.hueemulation-2.5.0-SNAPSHOT.jar
.5.0-SNAPSHOT.zip&response-content-type=application%2Fzip [following] │org.osgi.framework.BundleException: Could not resolve module: org.openhab.io.hueemulation [257]
Unresolved requirement: Import-Package: io.swagger.annotations; version="[1.5.0,2.0.0)"; resolution:="optional"
Unresolved requirement: Import-Package: org.openhab.core.automation.internal.module.handler

any suggestions? (as part of issue #5419)

davidgraeff · 2019-04-08T13:05:17Z

I have updated the jar file and fixed that particular problem

TheLexus · 2019-04-10T12:18:35Z

I'm testing the .jar you linked above but it fails to start:
│2019-04-07 08:07:34.279 [WARN ] [org.apache.felix.fileinstall ] - Error while starting bundle: file:/usr/share/openhab2/addons/org.openhab.io.hueemulation-2.5.0-SNAPSHOT.jar
.5.0-SNAPSHOT.zip&response-content-type=application%2Fzip [following] │org.osgi.framework.BundleException: Could not resolve module: org.openhab.io.hueemulation [257]
Unresolved requirement: Import-Package: io.swagger.annotations; version="[1.5.0,2.0.0)"; resolution:="optional"
Unresolved requirement: Import-Package: org.openhab.core.automation.internal.module.handler

I have the exact same problem with V5 jar from above. Do I need to add something else? Im on 2.5.0~S1566-1 from apt.

davidgraeff · 2019-04-10T12:23:25Z

Are you sure that it is the exact error? Because org.openhab.core.automation.internal.module.handler cannot happen anymore, I'm pretty sure. org.openhab.core.automation can happen, if you haven't installed the new ("experimental") rule engine.

TheLexus · 2019-04-10T13:00:09Z

Sorry David, my fault. Youre right, Rule Engine was missing!

Is there any change in using the hue emulation? I added a Lighting tag to one of my dimmers and connect a harmony hub. It finds multiple (really many) devices, but it seems that I did not add the one with the tag.

Are the tags obsolete?

Matthy1810 · 2019-04-11T21:34:59Z

I still get an error during startup with V5 using 2.5.0 M1 from the debian repo. The experimental rule engine is installed.

Error while starting bundle: file:/usr/share/openhab2/addons/org.openhab.io.hueemulation-2.5.0-SNAPSHOT.jar
org.osgi.framework.BundleException: Could not resolve module: org.openhab.io.hueemulation [80]
Unresolved requirement: Import-Package: io.swagger.annotations; version="[1.5.0,2.0.0)"; resolution:="optional"
Unresolved requirement: Import-Package: org.openhab.core.automation

davidgraeff · 2019-04-11T21:43:13Z

The readme file of this pull request might shed some light into which items are exposed.

Tags are not obsolete, but hue emulation will also expose items based on other criteria like the category and item type.

Regarding the unresolved requirement:
Can you please open the openhab console / karaf console (openhab-cli console) and enter bundle:list? That should show if automation is indeed installed and if it is the old eclipse automation or the new openHAB automation. I'm not sure when the renaming took place. Could be after oh 2.5m1 in which case this zip file only works on snapshots.

Matthy1810 · 2019-04-11T22:01:42Z

The startup indeed works with the Snapshot-version. But now I have problems discovering my devices. I'm still on it.

…io/hueemulation/internal/RuleUtils.java Co-Authored-By: davidgraeff <[email protected]>

…io/hueemulation/internal/dto/changerequest/HueChangeRequest.java Co-Authored-By: davidgraeff <[email protected]>

davidgraeff · 2019-05-01T16:48:44Z

I'm currently reworking "org.openhab.core.io.rest.core". It's a mess. So can't work on this bundle atm, but should be able to address review comments by end of the week.

Signed-off-by: David Graeff <[email protected]>

davidgraeff · 2019-05-02T12:52:12Z

Jenkins fails on AmazonEchoControl, but succeed with this service.
Merging now, to no longer blocking the migration.

mdeneen · 2019-05-02T13:53:35Z

Yes it's finished and working for myself and also two other people. I was waiting for more tests but no one had time yet apparently.

David,

I will try to test between now and this weekend. Thank you for your efforts!

thesebastianf · 2019-05-02T17:00:35Z

sorry
I still need to test more.
for now I strangely alexa does not discover all devices (I think it did with the old version).

a) I think it only finds "Lighing" tags but not "Switchable" tagged items
b) With the Alexa Openhab Skill those tags also expose GROUP items to alexa which works pretty good for my light and rolltershutter groups. While I could use a proxy switch for that it might also be possible to allow Group items in Hue Emulation?

best

davidgraeff · 2019-05-02T17:02:35Z

If your group items are tagged as Lighting (or whatever you have configured) that should actually work otherwise it's a bug. Group items are per default exposed as Hue Groups.

davidgraeff · 2019-05-02T17:03:45Z

When you guys find undefined, unclear behaviour or bugs in the implementation, please open new Issues so that I can keep track of them.

mdeneen · 2019-05-05T19:26:30Z

How stable are the 2.5 snapshot builds? I didn't appreciate that the bundle was incompatible with the 2.4 release.

davidgraeff · 2019-05-05T19:32:50Z

Unfortunately that had to be done because of #4602. I couldn't even add a migration routine, because the hue id sequence numbers were gone after stopping openHAB.

The current implementation is expected to be stable. The sequence numbers are stored as item metadata which is managed by the core.

mdeneen · 2019-05-05T19:48:05Z

I tried updating to the latest 2.5 snapshot available through the openhabian repos, but openhab fails to start for unknown reasons -- nothing in the log.

I apologize for being unable to test the changes at this time.

* [HueEmulation] Migrate to bnd * [hueemulation] Use JAX-RS for hue emulation * Split RESTapi class into logical units (ConfigurationAccess, UserManagement, LightsAndGroups) * rules support * scenes support * schedule support * New self-test page under /api/status * Refactor tests: Use jersey JAX-RS server to test without requiring the framework (non OSGi tests) * Worked around doube-activate problem. Signed-off-by: David Graeff <[email protected]>

openhab-bot · 2019-05-15T18:04:50Z

This pull request has been mentioned on openHAB Community. There might be relevant details there:

https://community.openhab.org/t/new-rules-engine/74428/12

openhab-bot · 2019-05-15T18:05:17Z

This pull request has been mentioned on openHAB Community. There might be relevant details there:

https://community.openhab.org/t/new-rules-engine/74428/12

openhab-bot · 2019-06-10T11:34:33Z

This pull request has been mentioned on openHAB Community. There might be relevant details there:

https://community.openhab.org/t/new-rules-engine/74428/12

* [HueEmulation] Migrate to bnd * [hueemulation] Use JAX-RS for hue emulation * Split RESTapi class into logical units (ConfigurationAccess, UserManagement, LightsAndGroups) * rules support * scenes support * schedule support * New self-test page under /api/status * Refactor tests: Use jersey JAX-RS server to test without requiring the framework (non OSGi tests) * Worked around doube-activate problem. Signed-off-by: David Graeff <[email protected]> Signed-off-by: Pshatsillo <[email protected]>

* [HueEmulation] Migrate to bnd * [hueemulation] Use JAX-RS for hue emulation * Split RESTapi class into logical units (ConfigurationAccess, UserManagement, LightsAndGroups) * rules support * scenes support * schedule support * New self-test page under /api/status * Refactor tests: Use jersey JAX-RS server to test without requiring the framework (non OSGi tests) * Worked around doube-activate problem. Signed-off-by: David Graeff <[email protected]> Signed-off-by: Maximilian Hess <[email protected]>

davidgraeff requested review from digitaldan and a team as code owners March 25, 2019 16:17

davidgraeff added work in progress A PR that is not yet ready to be merged infrastructure Build system and Karaf related issues and PRs labels Mar 26, 2019

maggu2810 mentioned this pull request Mar 29, 2019

Migration to a Maven + Bnd based build system #5005

Closed

davidgraeff force-pushed the migrate_hueemulation branch 3 times, most recently from 1211cab to 1157c4c Compare April 6, 2019 08:37

davidgraeff removed the work in progress A PR that is not yet ready to be merged label Apr 6, 2019

davidgraeff force-pushed the migrate_hueemulation branch from 1157c4c to 11ec316 Compare April 6, 2019 09:07

davidgraeff force-pushed the migrate_hueemulation branch from 11ec316 to 8e6b8ba Compare April 6, 2019 09:55

wborn changed the title ~~[HueEmulation] Migrate to bnd~~ [hueemulation] Migrate to bnd Apr 6, 2019

davidgraeff mentioned this pull request Apr 7, 2019

MapDB: Not prepared to work with Metadata? openhab/openhab-core#699

Closed

davidgraeff force-pushed the migrate_hueemulation branch from 8e6b8ba to 6d7b30f Compare April 8, 2019 12:50

davidgraeff force-pushed the migrate_hueemulation branch from 6d7b30f to 7be736d Compare April 8, 2019 21:21

davidgraeff mentioned this pull request Apr 8, 2019

[hueemulation] Re-sequences HueId's on openHAB restart - out-of-sync w/ Alexa #4602

Closed

davidgraeff force-pushed the migrate_hueemulation branch from 7be736d to 221e781 Compare April 8, 2019 21:33

J-N-K and others added 2 commits May 1, 2019 18:45

Update bundles/org.openhab.io.hueemulation/src/main/java/org/openhab/…

90b881d

…io/hueemulation/internal/RuleUtils.java Co-Authored-By: davidgraeff <[email protected]>

Update bundles/org.openhab.io.hueemulation/src/main/java/org/openhab/…

466bf9b

…io/hueemulation/internal/dto/changerequest/HueChangeRequest.java Co-Authored-By: davidgraeff <[email protected]>

Address review comments

ba4dc2f

Signed-off-by: David Graeff <[email protected]>

J-N-K approved these changes May 2, 2019

View reviewed changes

Finish renaming variable

262c9d8

Signed-off-by: David Graeff <[email protected]>

J-N-K added rebuild Triggers Jenkins PR build enhancement An enhancement or new feature for an existing add-on and removed rebuild Triggers Jenkins PR build labels May 2, 2019

davidgraeff merged commit a5e6930 into openhab:master May 2, 2019

davidgraeff deleted the migrate_hueemulation branch May 5, 2019 19:33

wborn added this to the 2.5 milestone May 26, 2019

5iver mentioned this pull request Jul 21, 2019

[hueemulation] All Items are discovered #5847

Closed

wborn removed the enhancement An enhancement or new feature for an existing add-on label Dec 8, 2019

wborn removed this from the 2.5 milestone Dec 8, 2019

wborn added this to the 2.5 milestone Dec 16, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[hueemulation] Migrate to bnd #5243

[hueemulation] Migrate to bnd #5243

davidgraeff commented Mar 25, 2019 •

edited

Loading

martinvw commented Mar 27, 2019

davidgraeff commented Mar 27, 2019

davidgraeff commented Apr 6, 2019 •

edited

Loading

openhab-bot commented Apr 6, 2019

openhab-bot commented Apr 6, 2019

mbehr1 commented Apr 7, 2019 •

edited

Loading

davidgraeff commented Apr 8, 2019

TheLexus commented Apr 10, 2019

davidgraeff commented Apr 10, 2019 •

edited

Loading

TheLexus commented Apr 10, 2019 •

edited

Loading

Matthy1810 commented Apr 11, 2019

davidgraeff commented Apr 11, 2019

Matthy1810 commented Apr 11, 2019

davidgraeff commented May 1, 2019

davidgraeff commented May 2, 2019

mdeneen commented May 2, 2019

thesebastianf commented May 2, 2019

davidgraeff commented May 2, 2019

davidgraeff commented May 2, 2019

mdeneen commented May 5, 2019

davidgraeff commented May 5, 2019 •

edited

Loading

mdeneen commented May 5, 2019

openhab-bot commented May 15, 2019

openhab-bot commented May 15, 2019

openhab-bot commented Jun 10, 2019

[hueemulation] Migrate to bnd #5243

[hueemulation] Migrate to bnd #5243

Conversation

davidgraeff commented Mar 25, 2019 • edited Loading

Jar (works on OH 2.5 snapshots only)

martinvw commented Mar 27, 2019

davidgraeff commented Mar 27, 2019

davidgraeff commented Apr 6, 2019 • edited Loading

openhab-bot commented Apr 6, 2019

openhab-bot commented Apr 6, 2019

mbehr1 commented Apr 7, 2019 • edited Loading

davidgraeff commented Apr 8, 2019

TheLexus commented Apr 10, 2019

davidgraeff commented Apr 10, 2019 • edited Loading

TheLexus commented Apr 10, 2019 • edited Loading

Matthy1810 commented Apr 11, 2019

davidgraeff commented Apr 11, 2019

Matthy1810 commented Apr 11, 2019

davidgraeff commented May 1, 2019

davidgraeff commented May 2, 2019

mdeneen commented May 2, 2019

thesebastianf commented May 2, 2019

davidgraeff commented May 2, 2019

davidgraeff commented May 2, 2019

mdeneen commented May 5, 2019

davidgraeff commented May 5, 2019 • edited Loading

mdeneen commented May 5, 2019

openhab-bot commented May 15, 2019

openhab-bot commented May 15, 2019

openhab-bot commented Jun 10, 2019

davidgraeff commented Mar 25, 2019 •

edited

Loading

davidgraeff commented Apr 6, 2019 •

edited

Loading

mbehr1 commented Apr 7, 2019 •

edited

Loading

davidgraeff commented Apr 10, 2019 •

edited

Loading

TheLexus commented Apr 10, 2019 •

edited

Loading

davidgraeff commented May 5, 2019 •

edited

Loading