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 ai-assistant to latest #4441

Merged
merged 2 commits into from
Jan 31, 2025
Merged

Conversation

ToGe3688
Copy link
Contributor

@ToGe3688 ToGe3688 commented Jan 4, 2025

Please add my adapter ioBroker.ai-assistant to latest.

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

@github-actions github-actions bot added the auto-checked This PR was automatically checked for obvious criterias label Jan 4, 2025
@mcm1957
Copy link
Collaborator

mcm1957 commented Jan 4, 2025

reminder 11.1.2025

@ToGe3688
Copy link
Contributor Author

Hi mcm1957, do i need to do anything or are further informations needed for the release in the beta repo? Thank you in advance!

@github-actions github-actions bot added the *📬 a new comment has been added label Jan 18, 2025
@mcm1957
Copy link
Collaborator

mcm1957 commented Jan 18, 2025

Thnaks for your poll. The only problem is that I'm missing free time currently. Please stand by.

@mcm1957 mcm1957 removed the *📬 a new comment has been added label Jan 18, 2025
@mcm1957
Copy link
Collaborator

mcm1957 commented Jan 22, 2025

@ToGe3688

To verify the Object structure of this adapter during REVIEW please export the object structure of a working installation and attach the file i. You find a guide how to export the object struture here: https://github.com/ioBroker/ioBroker.repochecker/blob/master/OBJECTDUMP.md

Thanks

@mcm1957 mcm1957 added the obj-json missing The reuqsted dump obj objects in json format is missing label Jan 24, 2025
@ToGe3688
Copy link
Contributor Author

Here is the export you requested!
ai-assistant.0.json

@github-actions github-actions bot added the *📬 a new comment has been added label Jan 27, 2025
@mcm1957 mcm1957 removed *📬 a new comment has been added obj-json missing The reuqsted dump obj objects in json format is missing labels Jan 27, 2025
@mcm1957
Copy link
Collaborator

mcm1957 commented Jan 28, 2025

@ToGe3688

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.

  • onStateChange handler ignores ack flag

    The adapter must honor the ack flag when processing onStateChange events. Whenever the onStateChange handler is called for an own state (a state owned by the processing instance of the adapter) it must ignore this event if the ack flags is set. Only stateChanges with ack==false are allowed to be processed.

    When processing foreign states which are output of another adapter processing must only occure if the ack flag is true.

  • object types hirarchy is invalid

    Object types require the general hirarchy device -> channel -> state. Device and channel are optional. The must be at most one object with type device within a tree leave. Multiple channels ('subchannels') are OK. Channels mut be below device if a device is present, no device is allowed below a channel. At every place Objects of type folder can be present. States must not have any children.

    So you either can use folder for top level, device for the models and channel or folder for lower directories or use channel / folder only.

  • 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) whnever a dedicated role exists.

    i.e. role indicator requires a readonly boolean state, so it is not allowed for your usage. States containing json Data most likely should use role 'json'

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!

Please a new object.json dump after fixing roles / types.

reminder 10.2.2025

@mcm1957 mcm1957 added must be fixed The Adapter request got review/automatic feedback that is required to be fixed before another review and removed REVIEW pending (by mcm1957) 11.1.2025 labels Jan 28, 2025
@ToGe3688
Copy link
Contributor Author

I worked through all your suggestions and think they should be fixed now. Attached is a new export of the JSON structure.
ai-assistant.1.json

@github-actions github-actions bot added the *📬 a new comment has been added label Jan 29, 2025
@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 *📬 a new comment has been added labels Jan 31, 2025

This comment was marked as outdated.

Copy link

Automated adapter checker

ioBroker.ai-assistant

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

👍 No errors found

  • 👀 [W401] Cannot find "ai-assistant" in latest repository

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

@github-actions github-actions bot deleted a comment from mcm1957 Jan 31, 2025
@mcm1957 mcm1957 merged commit aebcb1a into ioBroker:master Jan 31, 2025
3 checks passed
@mcm1957
Copy link
Collaborator

mcm1957 commented Jan 31, 2025

@ToGe3688

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.

If you do not have write access to TESTER Section of forum, please contact HOMORAN at forum using PN/CHAT

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 new at LATEST RE-REVIEW pending (by mcm1957) Changes requested by review have been applied, re-review could be done.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants