Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[hccrubbishcollection] HCC Rubbish Collection Binding - Initial Contribution #9975

Merged
merged 12 commits into from Apr 30, 2021
Merged

[hccrubbishcollection] HCC Rubbish Collection Binding - Initial Contribution #9975

merged 12 commits into from Apr 30, 2021

Conversation

Cossey
Copy link
Contributor

@Cossey Cossey commented Jan 28, 2021

A binding that displays rubbish collection days for Hamilton City Council (New Zealand).

This binding is simple and polls a web API. It uses to the Fight the Landfill website rubbish collection API that I had discovered. This API displays the date when the recycling and the general rubbish will be collected as well as the collection day of week for an address, which gets pulled into channels.

There is also an event that triggers for the day of collection that also supports an offset of up to +- 2 days, in minutes. You can use the event in a rule so that you can do what you need, in my case I send myself a notification reminder to put out the rubbish the night before, using an offset of -300.

@Cossey Cossey added the new binding If someone has started to work on a binding. For a new binding PR. label Jan 28, 2021
@Cossey Cossey requested a review from a team as a code owner January 28, 2021 09:20
@Hilbrand Hilbrand changed the title HCC Rubbish Collection Binding [hccrubbishcollection] HCC Rubbish Collection Binding - Initial Contribution Jan 29, 2021
fwolter
fwolter reviewed Apr 2, 2021
View reviewed changes
Copy link
Member

@fwolter fwolter left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your contribution! I reviewed your code and here is my feedback.

Please add yourself to the CODEOWNERS file and add an entry to bom\openhab-addons\pom.xml.

bundles/org.openhab.binding.hccrubbishcollection/pom.xml Outdated Show resolved Hide resolved
bundles/org.openhab.binding.hccrubbishcollection/src/main/feature/feature.xml Outdated Show resolved Hide resolved
bundles/org.openhab.binding.hccrubbishcollection/src/main/resources/OH-INF/binding/binding.xml Outdated Show resolved Hide resolved
...les/org.openhab.binding.hccrubbishcollection/src/main/resources/OH-INF/thing/thing-types.xml Outdated Show resolved Hide resolved
@Cossey
Copy link
Contributor Author

Cossey commented Apr 21, 2021

Thanks @fwolter for the feedback, I will go ahead and make required corrections.

@Cossey
Copy link
Contributor Author

Cossey commented Apr 21, 2021

@fwolter all done. Thanks for reviewing.

@Cossey
Initial commit of updated HCC Rubbish Binding.
9996f09 
Signed-off-by: Stewart Cossey <stewart.cossey@gmail.com>
@Cossey
Added Collection Trigger Event.
887fb67 
Signed-off-by: Stewart Cossey <stewart.cossey@gmail.com>
@Cossey
Update readme.
d3345de 
Signed-off-by: Stewart Cossey <stewart.cossey@gmail.com>
@Cossey
Update API to get day of week and collection week from API.
a8f75a1 
Add pattern to Collection Date items.
Add Options to Collection day channel.

Signed-off-by: Stewart Cossey <stewart.cossey@gmail.com>
@Cossey
Small fixes to API and readme.
fa557ab 
Signed-off-by: Stewart Cossey <stewart.cossey@gmail.com>
@Cossey
Add binding to POM.
9c4ef14 
Signed-off-by: Stewart Cossey <stewart.cossey@gmail.com>
@Cossey
Remove author tag.
90c24a2 
Remove incorrect commented tag.
Fix binding naming in XML files.

Signed-off-by: Stewart Cossey <stewart.cossey@gmail.com>
@Cossey
Add entry to codeowners.
3e9331f 
Signed-off-by: Stewart Cossey <stewart.cossey@gmail.com>
@Cossey
Add POM entry.
bdc44aa 
Signed-off-by: Stewart Cossey <stewart.cossey@gmail.com>
@Cossey
Update Bins and Collection Day channels to be read only.
d1ea557 
Signed-off-by: Stewart Cossey <stewart.cossey@gmail.com>
@Cossey
Change GSON to use the static method.
b17168b 
Added additional comments into code.
Checks if binding is disposing to make sure already started processes do not execute.

Signed-off-by: Stewart Cossey <stewart.cossey@gmail.com>
@Cossey
Copy link
Contributor Author

Cossey commented Apr 28, 2021

I made a fix with gson and commented the code further.

I made additional improvements based on #10549 since I have designed these bindings in the same way.

@Cossey
Copy link
Contributor Author

Cossey commented Apr 28, 2021

@fwolter Can you review please and approve if it all looks okay? Thanks heaps!

fwolter
fwolter requested changes Apr 29, 2021
View reviewed changes
Copy link
Member

@fwolter fwolter left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Your code doesn't compile as there are some formatting issues. You can fix them with mvn spotless:apply.

@Cossey
Fix spotless bugs resulting in compile failure.
8d73f31 
Signed-off-by: Stewart Cossey <stewart.cossey@gmail.com>
@Cossey
Copy link
Contributor Author

Cossey commented Apr 30, 2021

Apologies @fwolter, I missed that check after that last set of changes. All fixed now.

fwolter
fwolter approved these changes Apr 30, 2021
View reviewed changes
Copy link
Member

@fwolter fwolter left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Now, you could add your binding's logo to the openHAB website. See https://deploy-preview-1540--openhab-docs-preview.netlify.app/docs/developer/bindings/#add-your-binding-s-logo-to-the-openhab-website

@fwolter fwolter merged commit 02b4943 into openhab:main Apr 30, 2021
@fwolter fwolter added this to the 3.1 milestone Apr 30, 2021
@Cossey Cossey deleted the hccrubbishcollection branch May 2, 2021 06:51
themillhousegroup pushed a commit to themillhousegroup/openhab2-addons that referenced this pull request May 10, 2021
@Cossey @themillhousegroup
[hccrubbishcollection] HCC Rubbish Collection Binding - Initial Contr…
f52034e 
…ibution (openhab#9975)

Signed-off-by: Stewart Cossey <stewart.cossey@gmail.com>
Signed-off-by: John Marshall <john.marshall.au@gmail.com>
computergeek1507 pushed a commit to computergeek1507/openhab-addons that referenced this pull request Jul 13, 2021
@Cossey @computergeek1507
[hccrubbishcollection] HCC Rubbish Collection Binding - Initial Contr…
0623ee9 
…ibution (openhab#9975)

Signed-off-by: Stewart Cossey <stewart.cossey@gmail.com>
frederictobiasc pushed a commit to frederictobiasc/openhab-addons that referenced this pull request Oct 26, 2021
@Cossey @frederictobiasc
[hccrubbishcollection] HCC Rubbish Collection Binding - Initial Contr…
fda836d 
…ibution (openhab#9975)

Signed-off-by: Stewart Cossey <stewart.cossey@gmail.com>
thinkingstone pushed a commit to thinkingstone/openhab-addons that referenced this pull request Nov 7, 2021
@Cossey @thinkingstone
[hccrubbishcollection] HCC Rubbish Collection Binding - Initial Contr…
9c0a72f 
…ibution (openhab#9975)

Signed-off-by: Stewart Cossey <stewart.cossey@gmail.com>
marcfischerboschio pushed a commit to bosch-io/openhab-addons that referenced this pull request May 5, 2022
@Cossey
[hccrubbishcollection] HCC Rubbish Collection Binding - Initial Contr…
d57e329 
…ibution (openhab#9975)

Signed-off-by: Stewart Cossey <stewart.cossey@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@fwolter fwolter fwolter approved these changes

Assignees
No one assigned
Labels
new binding If someone has started to work on a binding. For a new binding PR.
Projects
None yet
Milestone
3.1
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@Cossey @fwolter