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 documentation for fields/entities #375

Open
TheEmperor1k opened this issue Dec 1, 2024 · 8 comments
Open

Add documentation for fields/entities #375

TheEmperor1k opened this issue Dec 1, 2024 · 8 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@TheEmperor1k
Copy link

TheEmperor1k commented Dec 1, 2024

Issue:
As a user, I want to understand what available entities stand for. Most entities are self-explanatory, some might not be for all users.
As a developer, I want users to use my integration as self-sufficient as possible and reduce explanation issues as far as possible.

Solution:
Provide a wiki which enables users to self-study.

Suggested MVP:
Clear-text explanation of what an entity stands for.

Possible future improvements:

  • Example automations provided by users
@TheEmperor1k
Copy link
Author

@prvakt I ran across the new configuration options you added in v.1.12.0, but I am struggling with understanding what AC when Unlocked means/does or whether there are any known conditions/limits, e.g., a time limit.

Same as for Reduced Current, which I am assuming could be used to lower the car's charge rate, but who knows?

Thanks for the integration itself, it's working great so far on my Enyaq.

@WebSpider WebSpider added the documentation Improvements or additions to documentation label Dec 1, 2024
@prvakt
Copy link
Collaborator

prvakt commented Dec 1, 2024

@TheEmperor1k: I don't have AC when Unlocked feature in my car (Superb iV) so honestly I don't know what is it used for - but its just the very same feature you can set using mobile app where its using exactly same name.

Reduced current is self explanatory in my opinion - when charging with AC, it will not use maximum provided current, but it will lower the current so the fuse will not blow in case you are charging with wall socket and there are more appliances connected to the same fuse.. For example my Superb can be charged with only 1 phase and max 16A (~3,8kW). When I enable reduced current it goes down to 6A (1,4kW)

edit: to be clear - everything which can be set via this integration is equal to the settings you can made in MySkoda mobile app (and In most cases name of the setting is same or almost same as in mobile app)... Also all sensors are coming from MySkoda mobile app

@chodorenko
Copy link
Contributor

I have a similar issue, and I don't know how to translate "AC when Unlocked" correctly.
Does it refer to alternating current or an air conditioner?

The same question applies to "AC without External Power" what does it mean, and under what conditions should it occur?

@prvakt
Copy link
Collaborator

prvakt commented Dec 2, 2024

AC means Air Condition..

AC without External Power is probably used only by PHEVs and Citigo where you can disable air conditioning from battery and enable it only when charging cable is connected. In new MySkoda app this feature is called "Use battery for climate control when battery is not charging". But that description is not very accurate because if I disable this option on my car, and charging cable is connected, AC can be started no matter if battery is charging or not, its enough that cable is connected..
AC when Unlocked - found this with google -> "I have noticed when ever I open a door including the tailgate on my Enyaq, the heating / climate control comes on" - so whenever you unlock your car air conditioning will be started automatically
Seat heating with AC -> enable seat heating together with air condition. So if you start air conditioning, seat heating will be started as well
Window heating with AC -> enable window heating together with air condition. So if you start air conditioning, window heating will be started as well

@prvakt
Copy link
Collaborator

prvakt commented Dec 2, 2024

seems like its called Quick A/C in old SkodaConnect app (as I dont have this feature, I was using same name as used by MySkoda in API request)
image

@TheEmperor1k
Copy link
Author

@prvakt Thanks for the answers, I found your answers really useful. They also explain my observations of the AC activating when just going to grab something from the car.

I'll test and report back what I can observe regarding the Reduced Current on the Enyaq in combination with a 11kW AC charger.

Do you agree that adding your points to some central wiki/documentation is a good idea?

@dvx76
Copy link
Member

dvx76 commented Dec 3, 2024

AC when Unlocked

This is a feature on Enyaq (and maybe other models). When enabled the AC will start as soon as the car is unlocked (as opposed to starting as soon the car is started)

Regarding the initial request in this issue, documenting what the different entities do is a great idea. But I would prefer it directly in the project (README or another markdown file linked from the README) and not the wiki as this makes it much easier for anyone to open a PR and contribute.

@WebSpider
Copy link
Contributor

Regarding the initial request in this issue, documenting what the different entities do is a great idea. But I would prefer it directly in the project (README or another markdown file linked from the README) and not the wiki as this makes it much easier for anyone to open a PR and contribute.

Agree. I tried wiki, but prefer a markdown file. Easier to change, and can be converted into github pages (or another publishing format, such as readthedocs) quite easily.

@WebSpider WebSpider added the good first issue Good for newcomers label Dec 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

5 participants