Add airquality to latest

[raschy]

Please add my adapter ioBroker.airquality to latest.

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

[simatec]

jsonConfig looks good. However, there is not really anything to configure. Is that the intention?

[raschy]

Oh, yes. Under “Stations”, the user can/should enter the station(s) from which he wants to have measured values. That's all you need.

[raschy]

Issue 1 [E254] and [W040] corrected, solved in version 0.0.4

[mcm1957]

Sorry, but due to travel / absence I will not able to do the review before ioBroker Meeting Solingen next weekend.

[mcm1957]

@raschy

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.

• package.json should require up to date js-controller and admin version

  New adapters should request js-controller 5 and admin 6 as minimum if there are no strong reason to support (and test) older releases. So please add / adapt at io-package.json:

        "dependencies": [
            {
                "js-controller": ">=5.0.19"
            }
        ],
        "globalDependencies": [
            {
                "admin": ">=6.17.14"
            }
        ]
  

  As this adapter uses jsonConfig it should require admin v6 at least. Earlier releases have too many missing updates.

• directory 'logs'

  Does the directory "logs" really contain information needed for development or has it been commited by error?

• consider making this adapter a scheduled adapter

  As this adapter executes every 15 minutes only please evaluate whether it shouldn't be converted to a scheduled adapter. It looks like an overhead to let a process wait most of the time.

• object ids and name attribute of objects

  Object Ids must be named in english.

  The "name" attribute of all objects / states must be either a string in english or an i18n multilingual object with all supported languages. The only exception would be if the name attribute is directly delivered by the external system - which isn't he case here. I would suggest to use i18n

• reevaluate state roles

  Only the values specified here (https://github.com/ioBroker/ioBroker.docs/blob/master/docs/en/dev/stateroles.md) may be used as state roles. Do not invent new names as this might disturb the functionalyity of other adapters or vis.

  In addition the roles MUST match the read/write functionality. As an example a role value.* requires that the state is a readable state. Input states (write only) should have roles like level.*. Please read the description carefully. States with role 'button' should (must) have attribute 'common.read=false' set. A button ( "Taster" in german only triggers when you press but else has no state), so it should also be not readable. This is also like HomeMatic does it. A switch has clear states true or false and so can be read.

  Please avoid using general roles (state, value) whenever a dedicated role exists.

Role 'number' does not exist ("Anzahl Messtypen")
Role "state" should only be used if no better role available. At least role value should be ok.
"Letzte Messung" should be role 'date' (eventually convert to make it parseable by new(date). See https://github.com/ioBroker/ioBroker.docs/blob/master/docs/en/dev/stateroles.md

• linter setup

  Please use standard iobroker linter setup. This is located at @iobroker/eslint-config. See migration guide at https://github.com/ioBroker/ioBroker.eslint-config/blob/main/MIGRATION.md

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!

reminder 10.12.2024

[raschy]

Hopefully all bugs fixed and also migrated to ESLint 9.

[github-actions]

Automated adapter checker

ioBroker.airquality

-

• ❗ [E254] Version "0.1.0" listed at common.news at io-package.json does not exist at NPM. Please remove from news section.
• 👀 [W401] Cannot find "airquality" in latest repository
• 👀 [W951] .npmignore found but "files" is used at package.json. Please remove .npmignore.

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

[mcm1957]

RE-REVIEW - work in progress worksheet only - please ignore for now

• package.json should require up to date js-controller and admin version

  New adapters should request js-controller 5 and admin 6 as minimum if there are no strong reason to support (and test) older releases. So please add / adapt at io-package.json:

        "dependencies": [
            {
                "js-controller": ">=5.0.19"
            }
        ],
        "globalDependencies": [
            {
                "admin": ">=6.17.14"
            }
        ]
  

  As this adapter uses jsonConfig it should require admin v6 at least. Earlier releases have too many missing updates.

• directory 'logs'

  Does the directory "logs" really contain information needed for development or has it been commited by error?

• consider making this adapter a scheduled adapter

  As this adapter executes every 15 minutes only please evaluate whether it shouldn't be converted to a scheduled adapter. It looks like an overhead to let a process wait most of the time.

• object ids and name attribute of objects

  Object Ids must be named in english.

  The "name" attribute of all objects / states must be either a string in english or an i18n multilingual object with all supported languages. The only exception would be if the name attribute is directly delivered by the external system - which isn't he case here. I would suggest to use i18n

• reevaluate state roles

  Only the values specified here (https://github.com/ioBroker/ioBroker.docs/blob/master/docs/en/dev/stateroles.md) may be used as state roles. Do not invent new names as this might disturb the functionalyity of other adapters or vis.

  In addition the roles MUST match the read/write functionality. As an example a role value.* requires that the state is a readable state. Input states (write only) should have roles like level.*. Please read the description carefully. States with role 'button' should (must) have attribute 'common.read=false' set. A button ( "Taster" in german only triggers when you press but else has no state), so it should also be not readable. This is also like HomeMatic does it. A switch has clear states true or false and so can be read.

  Please avoid using general roles (state, value) whenever a dedicated role exists.

Role 'number' does not exist ("Anzahl Messtypen")
Role "state" should only be used if no better role available. At least role value should be ok.
"Letzte Messung" should be role 'date' (eventually convert to make it parseable by new(date). See https://github.com/ioBroker/ioBroker.docs/blob/master/docs/en/dev/stateroles.md

• linter setup

[mcm1957]

@raschy
Thanks for fixing most issues. The following issue still exists

• object ids and name attribute of objects

  Object Ids must be named in english.

  It looks like you are using the ids directly provided by UBA. So using english names could be not easy. Please check whether the site can provide english names too. I'll check with apollon if german ids could be accespt as an exception too.

  EDIT: Just check with @Apollon77 - its OK to keep german names as they are retrieved from api an target for users is germany anyway. No nee to be changed any more.

The following issues are new:

• Adapter does not terminate if no stations are configured and causes "already running errors"

  see Adapter does not terminate if no stations selected raschy/ioBroker.airquality#19
  This problem must be fixed

• unneeded ObjectExists

  as setObjectNotExists already included the check whether an object esists an explicit check is not needed
  https://github.com/raschy/ioBroker.airquality/blob/c1aa223da0d0fb51211e392f1d19b20194cdedef/src/main.ts#L352
  (non blocking but should be adapterd)

reminder 29.12.2024