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 jablotron to latest #3016

Merged
merged 2 commits into from
Dec 8, 2023
Merged

Conversation

DEV2DEV-DE
Copy link
Contributor

Please add my adapter ioBroker.jablotron to latest.

This pull request was created by https://www.iobroker.dev c0726ff.

@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 Nov 30, 2023
Copy link

Automated adapter checker

ioBroker.bosesoundtouch

Downloads Number of Installations (latest) Number of Installations (stable)
NPM

  • ❗ [E114] No adapter are allowed in the repo without admin support (set "common.noConfig = true" and "common.adminUI.config = none" if adapter has no configuration)
  • ❗ [E605] No actual year found in copyright. Please add "Copyright (c) 2019-2023 sven_s_ter [email protected]" at the end of README.md
  • ❗ [E701] No actual year found in LICENSE. Please add "Copyright (c) 2019-2023 sven_s_ter [email protected]" at the start of LICENSE
  • 👀 [W171] "common.title" is deprecated in io-package.json
  • 👀 [W105] "common.titleLang" should be translated into all supported languages (en, de, ru, pt, nl, fr, it, es, pl, uk, zh-cn)
  • 👀 [W109] "common.desc" should be translated into all supported languages (en, de, ru, pt, nl, fr, it, es, pl, uk, zh-cn)
  • 👀 [W156] Adapter should support admin 5 UI (jsonConfig) if you do not use a React based UI
  • 👀 [W145] Each "common.news" should be translated into all supported languages (en, de, ru, pt, nl, fr, it, es, pl, uk, zh-cn)
  • 👀 [W145] Each "common.news" should be translated into all supported languages (en, de, ru, pt, nl, fr, it, es, pl, uk, zh-cn)
  • 👀 [W145] Each "common.news" should be translated into all supported languages (en, de, ru, pt, nl, fr, it, es, pl, uk, zh-cn)
  • 👀 [W145] Each "common.news" should be translated into all supported languages (en, de, ru, pt, nl, fr, it, es, pl, uk, zh-cn)
  • 👀 [W145] Each "common.news" should be translated into all supported languages (en, de, ru, pt, nl, fr, it, es, pl, uk, zh-cn)
  • 👀 [W145] Each "common.news" should be translated into all supported languages (en, de, ru, pt, nl, fr, it, es, pl, uk, zh-cn)
  • 👀 [W145] Each "common.news" should be translated into all supported languages (en, de, ru, pt, nl, fr, it, es, pl, uk, zh-cn)

ioBroker.jablotron

Downloads Number of Installations (latest)
NPM

👍 No errors found

  • 👀 [W400] Cannot find "jablotron" in latest repository

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

@mcm1957 mcm1957 added RE-REVIEW pending (by mcm1957) Changes requested by review have been applied, re-review could be done. and removed must be fixed The Adapter request got review/automatic feedback that is required to be fixed before another review labels Nov 30, 2023
@ticaki
Copy link
Contributor

ticaki commented Dec 3, 2023

In order to relieve mcm, I have looked at the adapter and the following points need to be corrected first:

Optional not required for lastest:

  • as i told u in chat. common.type=object not really exist. A datapoint with this common type is not used by anything in iobroker. The correct way to write a Json-Object into data points is common.type=string common.role=json
    https://github.com/ioBroker/ioBroker.docs/blob/master/docs/en/dev/stateroles.md#common

  • I think there will probably be states you want to react to in the future, otherwise this.on('stateChange', this.onStateChange.bind(this)); (and onStateChange()) would have to be removed.

@github-actions github-actions bot added the *📬 a new comment has been added label Dec 3, 2023
@DEV2DEV-DE
Copy link
Contributor Author

@ticaki
All mentioned improvements have been implemented.
You are right with the last topic. There will be states to react on in the future. Therefore, the binding to 'stateChange' has been prepared.

@mcm1957 mcm1957 removed the *📬 a new comment has been added label Dec 3, 2023
@mcm1957
Copy link
Collaborator

mcm1957 commented Dec 6, 2023

@DEV2DEV-DE

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.

  • sensitive information, especially passwords should be stored encrypted

    You configuration seems to contain passwords (or other sensitive information) which is not stored encrypted. As long as those information is not stored inside a table you can encrypt and secure this infomation simply by adding the following configuration to io-package.json. The iob runtime will encrypt / decrypt the data as required; no addition programming effort is required. Note that users will need to reenter this info one time after adding encryption, so drop a note at release notes.

    "encryptedNative": [
      "password",
      "data2"
    ],
    "protectedNative": [
      "password",
      "data2"
    ],
    
  • info.connection does not need to be created
    info.connection is normally defined at iio-package.json and hence need not be created within code. You should add the state at io-pacge.json (see template or other adapters for an example) and remove the code part.
    https://github.com/DEV2DEV-DE/ioBroker.jablotron/blob/569fe788b4ebc6a5a69d9f0f3ccd0b92d7239ea2/main.js#L397C39-L397C43

  • unused onStateChange handler

    You configred an onStateChange handler but it looks like this handler does not do any important tasks. Please remove the handler if the adapter does not react on state changes.

    If you plan to use it later, its ok the comment it out only.

  • add minimum (and eventully maximum) limits to pollintervall
    adding a lower (and opionally an upper) limit to pollintervall at jsonConfig reduces the chance that a user will enter an invalid value and run into an exception at adapter start.

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!

@mcm1957 mcm1957 added must be fixed The Adapter request got review/automatic feedback that is required to be fixed before another review ⚠️check Issue/PR needs attention and removed RE-REVIEW pending (by mcm1957) Changes requested by review have been applied, re-review could be done. ⚠️check Issue/PR needs attention labels Dec 6, 2023
@DEV2DEV-DE
Copy link
Contributor Author

DEV2DEV-DE commented Dec 6, 2023

All mentioned improvements have been fixed/implemented.

@mcm1957
Bin ja selbst ein Verfechter von "auskommentierter Code hat im Release nix verloren".
Wozu hat man schließlich eine Versionsverwaltung? Kann man sich ja später wieder zurückholen.

@github-actions github-actions bot added the *📬 a new comment has been added label Dec 6, 2023
@mcm1957 mcm1957 added lgtm Looks Good To Me and removed must be fixed The Adapter request got review/automatic feedback that is required to be fixed before another review *📬 a new comment has been added labels Dec 8, 2023
@mcm1957 mcm1957 merged commit 2f1ab94 into ioBroker:master Dec 8, 2023
18 checks passed
@mcm1957
Copy link
Collaborator

mcm1957 commented Dec 8, 2023

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 " (if not already done) 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, ist OK to continue using this topic too.

@DEV2DEV-DE DEV2DEV-DE deleted the jablotron-to-latest branch December 8, 2023 08:27
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.

4 participants