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.

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

Add HioB to latest #3432

Merged
merged 1 commit into from
May 21, 2024
Merged

Add HioB to latest #3432

merged 1 commit into from
May 21, 2024

Conversation

moba15
Copy link
Contributor

@moba15 moba15 commented Mar 27, 2024

No description provided.

@github-actions github-actions bot added auto-checked This PR was automatically checked for obvious criterias must be fixed The Adapter request got review/automatic feedback that is required to be fixed before another review labels Mar 27, 2024
@mcm1957
Copy link
Collaborator

mcm1957 commented Mar 28, 2024

Thanks for spending your time and providing a new adapter for ioBroker.

Your adapter will get a manual review as soon as possible. Please stand by - this might last one or two weeks. Feel free to continue your work and create new releases. You do NOT need to close or update this PR in case of new releases.

In the meantime please check any feedback issues logged by automatic adapter checker and try to fix them.

You will find the results of the review and eventually issues / suggestings as a comment to this PR. So please keep this PR watched.

If you have any urgent questions feel free to ask.

mcm1957

@mcm1957 mcm1957 added the RE-REVIEW pending (by mcm1957) Changes requested by review have been applied, re-review could be done. label Mar 28, 2024
@mcm1957
Copy link
Collaborator

mcm1957 commented Mar 28, 2024

reminder 4.4.2024

@github-actions github-actions bot added 4.3.2024 *📬 a new comment has been added labels Mar 28, 2024
@github-actions github-actions bot deleted a comment from Lucky-ESA Mar 28, 2024
@mcm1957 mcm1957 removed the *📬 a new comment has been added label Mar 29, 2024
@github-actions github-actions bot deleted a comment from mcm1957 Mar 29, 2024
@github-actions github-actions bot added the *📬 a new comment has been added label Mar 29, 2024
@github-actions github-actions bot deleted a comment from moba15 Mar 29, 2024
@mcm1957 mcm1957 removed the *📬 a new comment has been added label Mar 29, 2024
@github-actions github-actions bot added 4.4.2024 and removed 4.3.2024 labels Apr 1, 2024
@mcm1957 mcm1957 removed the must be fixed The Adapter request got review/automatic feedback that is required to be fixed before another review label Apr 4, 2024
@mcm1957
Copy link
Collaborator

mcm1957 commented Apr 5, 2024

First of all - THANK YOU for the time and effort you spend to maintain this adapter.

I would like to give some feedback based on my personal oppinion. @Apollon77 might have additional suggestions or even a different oppinion to one or the other statement. Please feel free to contact him if you cannot follow my suggestions or want to discuss some special aspects.

  • errors reported by adapter checker must be fixed

    Please check W170

  • Readme.md is very short

    The README.md of this adapter is very minimalistic. Please add a short description about the functionality of the adapter. Some text "This adapter enables to control ... using the hiob app, ..." which could be used at the news web page and describing the functionality of the adapter with 3 to 5 sentences.

    The primary documentation is fine and many thangs for providing such an extensive text info.

  • Please use STATE instead of DATA POINT

    The official naming for states of ioBroker is states, So please replace DataPoint at english documentation including README.md with "state" as long as they refer to an ioBroker state.

  • adapter should require up to date js-controller

    Please change "js-controller": ">=3.3.22" at io-package.json to require js-controller 5 (preferred for new adapters) or at least to js-controller 4 if you need por want to support js-controller 4 still. Please note, that no automatic tests are performed againts js-controller 4.

  • github dependabot support seems to be missing

    It looks like you did not yet setup dependabot support; at least .github/dependaboit.yml is missing.

    Please consider setting up dependabot support (and to ease life the workflow auto-merge.yml). Dependabot will ensure that your adapter uses the most recent versions of external packages and avoids problem due to outdted base libraries. Dependabit provides PRs at you repository to update the dependencies. Depending on you setting, especially on auto-merge.yml configuration no or only minor revisions will be outmatically merged into you main branch. All major revisions msiut (ans should) be reviewed by you.

    Read this as a suggestion, using dependabot is not mandatory.

Thanks for reading and evaluating this suggestions.
McM1957

Please add a comment when you have reviewed and fixed the suggestionsor at least commented the suggestions and you think the adapter is ready for a re-review!

@Apollon77
Please check if you have additional suggestions if your time allows

reminder 12.4.2024

@mcm1957 mcm1957 added must be fixed The Adapter request got review/automatic feedback that is required to be fixed before another review REVIEW needed (apollon77) A developer from the ioBroker Team will review the adapter, will provide comments or require changes and removed RE-REVIEW pending (by mcm1957) Changes requested by review have been applied, re-review could be done. labels Apr 5, 2024
@mcm1957 mcm1957 requested a review from Apollon77 April 5, 2024 11:04
@mcm1957
Copy link
Collaborator

mcm1957 commented Apr 12, 2024

@moba15
Any news? Do you need some help / explanation related to remarks from 5.4.2024?

@Apollon77
Just a kind reminder to take a look if possible.

reminder 19.4.2024

@moba15
Copy link
Contributor Author

moba15 commented Apr 12, 2024

Thanks for your feedback. I have now completed my changes. I hope I didn't forget anything.

@github-actions github-actions bot added the *📬 a new comment has been added label Apr 12, 2024
@Apollon77
Copy link
Collaborator

Ok, also a short review from my side ...

@mcm1957 mcm1957 added must be fixed The Adapter request got review/automatic feedback that is required to be fixed before another review and removed *📬 a new comment has been added must be fixed The Adapter request got review/automatic feedback that is required to be fixed before another review labels Apr 20, 2024
@mcm1957
Copy link
Collaborator

mcm1957 commented Apr 20, 2024

@moba15
Please note comments from Apollon77

reminder 4.5.2024

@moba15
Copy link
Contributor Author

moba15 commented Apr 24, 2024

Thanks for your feedback.
Short Update from my side:

Any news? Do you need some help / explanation related to remarks from 5.4.2024?

I should have fixed them all

Now it is only created once.

I now only subscribe to "*"

I don't really know if I've understood that correctly. But in the following I describe shortly what have done to "fix" this problem:
Every time the user requests to get notified about certain state changes, I look if I already subscribed to this state.
If not, I look if I have already subscribed to 50 or more states within the same instance. If so, I subscribe to the complete instance and unsubscribe the single states. I also added a check if it is a alias state. You mentioned that it could be problematic to subscribe to alias.0.*, so I did a check for this as well.
See implementation: https://github.com/moba15/ioBroker.hiob/blob/77fb2eaead13cde143f6b12cd0c013a6931e45eb/src/listener/listener.ts#L68

@github-actions github-actions bot added the *📬 a new comment has been added label Apr 24, 2024
@mcm1957
Copy link
Collaborator

mcm1957 commented Apr 25, 2024

@Apollon77 FYI

Please comment. I leave the ltgm marking to you for this adapter as it is ruther complex and you have the better knowledge if somethiung need to be changes or is ok as it is. Please either mark lgtm or merge yourself

@mcm1957 mcm1957 removed the *📬 a new comment has been added label Apr 26, 2024
@mcm1957 mcm1957 added RE-REVIEW pending (by mcm1957) Changes requested by review have been applied, re-review could be done. and removed REVIEW needed (apollon77) A developer from the ioBroker Team will review the adapter, will provide comments or require changes must be fixed The Adapter request got review/automatic feedback that is required to be fixed before another review labels May 17, 2024
@github-actions github-actions bot deleted a comment from mcm1957 May 21, 2024
Copy link

Automated adapter checker

ioBroker.hiob

Downloads Number of Installations (latest) - Test and Release
NPM

👍 No errors found

  • 👀 [W184] "common.main" is deprecated and ignored. Please remove from io-package.json. Use "main" at package.json instead.
  • 👀 [W400] Cannot find "hiob" in latest repository

Add comment "RE-CHECK!" to start check anew

@mcm1957
Copy link
Collaborator

mcm1957 commented May 21, 2024

Re-Review

  • errors reported by adapter checker must be fixed

    Please check W170

  • Readme.md is very short

    The README.md of this adapter is very minimalistic. Please add a short description about the functionality of the adapter. Some text "This adapter enables to control ... using the hiob app, ..." which could be used at the news web page and describing the functionality of the adapter with 3 to 5 sentences.

    The primary documentation is fine and many thangs for providing such an extensive text info.

  • Please use STATE instead of DATA POINT

    The official naming for states of ioBroker is states, So please replace DataPoint at english documentation including README.md with "state" as long as they refer to an ioBroker state.

  • [c] adapter should require up to date js-controller

    Please change "js-controller": ">=3.3.22" at io-package.json to require js-controller 5 (preferred for new adapters) or at least to js-controller 4 if you need por want to support js-controller 4 still. Please note, that no automatic tests are performed againts js-controller 4.

  • github dependabot support seems to be missing

    It looks like you did not yet setup dependabot support; at least .github/dependaboit.yml is missing.

    Please consider setting up dependabot support (and to ease life the workflow auto-merge.yml). Dependabot will ensure that your adapter uses the most recent versions of external packages and avoids problem due to outdted base libraries. Dependabit provides PRs at you repository to update the dependencies. Depending on you setting, especially on auto-merge.yml configuration no or only minor revisions will be outmatically merged into you main branch. All major revisions msiut (ans should) be reviewed by you.

    Read this as a suggestion, using dependabot is not mandatory.

@mcm1957
Copy link
Collaborator

mcm1957 commented May 21, 2024

As @Apollon77 does not have any addition comments this adapter will be released to lates repository.

@mcm1957 mcm1957 removed the RE-REVIEW pending (by mcm1957) Changes requested by review have been applied, re-review could be done. label May 21, 2024
@mcm1957 mcm1957 merged commit f9bad65 into ioBroker:master May 21, 2024
41 checks passed
@mcm1957
Copy link
Collaborator

mcm1957 commented May 21, 2024

@moba15
This adapter has been released to latest repository and should be visible within 24h maximum.

Please create a thread at https://forum.iobroker.net/category/91/tester titled like "Test Adapter " to collect some user feedback and provide a link to this topic when requesting addition to stable repository later.

Note: If an other testing topic already exists, it' OK to continue using this topic too.

@mcm1957 mcm1957 added the lgtm Looks Good To Me label May 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-checked This PR was automatically checked for obvious criterias lgtm Looks Good To Me
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants