2021-12-08 22:17:40 WARNING (MainThread) [homeassistant.components.statistics.sensor] The configuration parameter 'state_characteristic' will become mandatory in a future release of the statistics integration. Please add 'state_characteristic: mean' to the configuration of sensor "outside stats" to keep the current behavior. Read the documentation for further details: https://www.home-assistant.io/integrations/statistics/
#devs_documentation-archived
1 messages ยท Page 13 of 1
https://rc.home-assistant.io/integrations/statistics/ are beta docs
i think its normal, because i'm on 2021.12b which is still beta
thank you
that is what im looking for
Maybe I'm blind but do the release doc include information about the device_state_attributes -> extra_state_attributes change? Took me a while to figure out what the warning meant. ๐
I don't think so? That was deprecated like a year ago or something
Haven't been in my logs until today.
Yeah I only started seeing it in the 2021.12 beta.
@south ginkgo 24 likes on your comment for panel-redirect and counting. I remember I used to have a custom component log just to have quick access to logs. Then it became broken and I was very sad. Finally I'm happy again. ๐
Hi guys. I need assistance with getting https working in home assistant. Which channel would be the best to ask? I tried frontend but got no response
That's nothing to do with developing the docs - start in #general-archived if you don't know where to ask
In this case though, #integrations-archived is the right starting point
I know it's probably not dev. I was hoping someone would point me in the right direction. Thank you for helping๐
question on the warning language at the bottom of this page:
https://www.home-assistant.io/docs/configuration/customizing-devices
Does "...the next time the state of the entity gets updated" typically mean a state change, e.g. "on" to "off"? Or does HA update entity states that have not changed for a long time?
If yes, mentioning that you can disable and re-enable the entity to change customize information may be helpful here for devices that don't easily change states.
It has to update based on the integration either being told to update or doing it itself as part of a polling operation or similar. Disable/enable is a heavy-handed way, but homeassistant.update_entity is a less intrusive way to force an update.
If you feel that it could be clearer, please provide feedback or suggested wording via the buttons at the bottom of the page
Great info and thank you for the clarification. I had a feedback tab open before realizing my assumption about entity updates could be wrong. homeassistant.update_entity seems very useful. Is it instant when compared to disabling/enabling entities?
Any suggestion I would make would consider "what can the user do from the UI outside of developer tools?" but for most users I'd also favor including anything which answers "yes" to "does it appear to make stuff work instantly?"
It directly triggers the update method of the entity
I recently overhauled the nest setup and now the number one problem I see is users on an old version of home assistant following the docs that don't work for old HA versions
I can add a note at the top that says "hey go upgrade first" but was also considering if it makes sense to reflect this more generally on the home assistant docs. Basically: "you are looking at docs for version 2021.12" somewhere
There's already an indicator of when an integration was introduced, having an indicator of the minimum version for the docs makes sense IMO
documentation always reflects the current version
Given that only 40% of those reporting stats run the current version, that means that the docs don't apply to 60% of the user base ๐
With that math you imply 100% of the documentation has changed.
It hasn't? 
haha ๐ That would have been one hell of a breaking change ๐
^All automations are now in COBOL*
Now that's just cruel... 
Is that the one where indentation is important? I remember thinking that when I was first exposed to YAML
โComments on column 60โ or some such
Would allow for more advanced automations compared to what we have now ๐ฌ
Pretty sure you are thinking of FORTRAN - edit I checked and it appears COBOL does too! I honestly did not think it was.
This could just be nest specific.. you have context on the changes I introduced.. they are more extreme than most.
๐คทโโ๏ธsince I have contextโฆ I donโt think so.
i get one or two confused users per day, so i'm going to add a nest specific note about what version the documentation reflects
What's the best way to document that at least one of two config fields is required? https://github.com/home-assistant/home-assistant.io/pull/20862#discussion_r775252582
So just list them as both optional
And the user should figure out from the rest of the documentation than one of them is necessary
Alternatively extend https://github.com/home-assistant/home-assistant.io/blob/current/plugins/configuration.rb to support exclusive options ๐
๐
Actually... required: exclusive seems to be there
Actually in this case they're not exclusive either
It's just that at least one is required
Hmm, I don't even know what 'inclusive' and 'exclusive' mean there
I'm just going to make them both optional
That can only be solved in descriptions
when does current get downmerged to next?
when needed / when I think about it / when requested
@dawn lava Are you in need of it?
yes that would be appreciated
just want to rebase my next PR which is dependent on the changes that were just merged
thanks
Done ๐
Ty!
Working on a new integration - do I make that THEN add documentation? Part of the docs calls out what version of HA the integration was added i believe
Use whatever is next for that version (2022.2 now) and adjust later if needed
The #integrations-archived channel could help with that - do please read the channel section and topic (top of the window on desktop, swipe in from the side on mobile)
Hi team! I need to make some changes to an open PR but it appears my folk has been deleted. Does anyone know how i can make changes? https://github.com/home-assistant/home-assistant.io/pull/20809
@tame root The only solution is to make a new PR
Thanks Frenck! That will teach me a lesson... "Do not delete folks until PR is merged!"
Hi all
I think this is the correct channel to post this question about documentation.
In the process of making a several pull requests on documentation recently I have tried to find out if there is a standard for documenting the navigation of the HA UI. I have looked at the standards here: https://developers.home-assistant.io/docs/documenting/standards and I don't think this is covered. The committed pull request I made was to page https://www.home-assistant.io/integrations/zwave_js/. Within that page there are now three variations on the way navigation of the UI is described, as per the following.
- Configuration -> Integrations -> Z-Wave JS -> Configure (no formatting)
- Configuration -> Integrations -> Z-Wave JS -> Configure -> Download a dump of your network to help diagnose issues (formatted with ** in markdown)
- Configuration -> Devices & Services -> Integrations(tab) -> Z-Wave JS (CONFIGURE) -> Logs(tab) (formatted with ** in markdown)
If there is a standard could someone point me in the right direction.
There is no standard for that currently
Additionally the menu navigation in general for Home Assistant changed last release. Most of the documentation has been updated to reflect that, but things can be missed. Feel free to submit a PR to correct it
Thanks for replying. However, I'm not sure what is correct. My thoughts are:
- that capitalisation should match what's in the interface (e.g. 'CONFIGURE' rather than 'Configure')
- that the navigation identifies the order and what the user needs to click on (e.g. 'Configuration -> Devices & Services -> Integrations' rather than 'Configuration -> Integrations')
- where additional information would be helpful to indicate what is selected it is added in brackets (e.g. 'Integrations(tab)' rather than just 'Integrations')
- that where particular tab needs to be selected that it be included in the navigation , even if it is the default (e.g. 'Devices & Services -> Integrations(tab) -> Z-Wave JS (CONFIGURE)' rather than 'Devices & Services -> Z-Wave JS (CONFIGURE)')
- that each step separated by a '->' indicates what needs to be selected (e.g. 'Z-Wave JS (CONFIGURE)' rather than 'Z-Wave JS -> Configure')
- because markdown appears to display H4 in similar text as bold it may be better that navigation strings either have no formatting or are in italics and not in bold.
Happy to submit a PR, but I'd need some guidance as to whether my thoughts on navigation are in line with the general intent.
There is no guideline on this
Imho we only should fix 2
I honestly personally do not agree with most other points
Thanks for getting back.
hi guys... i want to develop custom component, but struggling to find official documentation on how to develop one. can some one point in right direction?
@south ginkgo doh ... thank you ๐
hello, i'm reading this https://www.home-assistant.io/docs/mqtt/discovery/
is it up to date?
From examples, i'm trying to create auto discovery config
mosquitto_pub -h 127.0.0.1 -p 1883 -t "homeassistant/binary_sensor/garden/config" -m ...
But it does not work, i'm seeing message on mqtt, but no sensor created
Others have mentioned you need a unique_id - but that's more a topic for #integrations-archived
yeah.. i'm just asking if documenation is up to date, or there is another requirements, so uniquie_id is mandatory now
thank you, will try
I'm working on a documentation change relative to a new feature.
The 'Preview' on Github works fine except for the 'configuration' section which is displayed '{% configuration %} api_version: type: string description: API version ...{% endconfiguration %} without any rendering.
Any mean to get a complete preview (I tried with VScode and home-assistant.io devcontainer but didn't find a solution...)?
I eventually made it work with VScode (task: run Tasks -> Preview)
2 tricks:
- using 'find' to find a page in the doc send to the home-assistant.io website and not to the local rendered page...
- new line in a configuration section using a standard YAML > or | doesn't work (without error in VSCode) but lead to fail check in PR
How can I find out in which version a certain configuration entrs was added to an integration ? For example, when was the configuration 'expire_in' added to the MQTT sensor ?
The history of edits for the page
I'm currently investigating EnOcean devices and feel I can contribute stuff this integration's documentation. How can I do that?
At the bottom of each page is an edit link, where you can create a Pull Request with your proposed changes/additions.
Maybe not the right place to ask, but my "Dark Reader" extension doesn't do anything on home-assistant.io . I don't think this is an issue on my side, can anyone else confirm this?
The doc Standards (https://developers.home-assistant.io/docs/documenting/standards) talks about Configuration Variables for integrations that still use YAML. Is there any specific guidance on how to list or explain Configuration Options (via config_flow) in the documentation?
We generally donโt, as the interface should be explain that already
You'd think so, but I've had to answer forum questions like "What do I put in the Host IP address box?" ๐
documentation would not help with that
If it was there it would only state: "The IP of the host"
Ha, yeah that's true.
Thanks. So to restate this to make sure I understand, the intent is for the user interface to explain everything (via config flow and strings.json) to the extent possible.
Correct.
@grizzled grove typo in the blog post today: https://www.home-assistant.io/blog/2022/02/02/release-20222/#new-integrations
HomeWizard Energy, added by @DCSBL
points to https://www.home-assistant.io/integrations/homewizard_energy/ but is 404. ๐
And https://www.home-assistant.io/integrations/diagnostics/ is also broken ๐
seems like this page is missing. https://www.home-assistant.io/integrations/diagnostics/
really?
hahha. you beat me to it
If only we had some diagnostics to debug that...
Seems like this is as good a forum has any to draw attention to this, but can the team work on having the โhome assistant โrelease notes reflect all of home assistant and not just the core repository?
What do you mean by more than just core? Are you talking Community Addons, Cards, etc? Because that would be impossible to compile. They have their own release notes that are now embed into the platform when you are upgrading that addon
Custom components are impossible for the core team to track too
The release is for core.
Iโm not talking about add-ons or custom components. Iโm mainly talking about the frontend repository, which currently gets rolled up into a single bullet point in the release notes. The changes within that single point ought to be expanded for higher visibility. For example, there was a breaking change that deserved attention directly in the blog post.
which one?
The first one of the list of breaking changes are from the frontend repo
The frontend repo is gone through the same as core
Is this about the energy dashboard settings having moved?
Who knows ๐คทโโ๏ธ
I wish I could find my configuration directory after reading this. https://www.home-assistant.io/docs/configuration/
Could there maybe pretty please be documentation that arrives in knowing the configuration path, without the use of the word "maybe"? Or "if"?
Is that documentation attributable to an individual?
That's only true for the top heading items and the list that is deemed "noteworthy". For the lists that appears to be automatically generated from a list of PRs, the frontend repo is condensed into a single bullet point like: "Update frontend to 20220203.0 (@worthy copper - #65572) (frontend docs) (breaking-change)". All I'm suggesting is replacing that with the PR list from the frontend repo. It's not a 3rd party package and deserves the same visibility as the list coming from core.
There are three supported ways of installing Home Assistant - because people like different things. Do you have a suggestion how we can cover all those cases (and the many custom ones) without assuming the user knows which one they used?
Otherwise an "if" is probably necessary.
Yes, make the documentation what the hacs.xyz script does to find the configuration file.
The script that has three different instructions on how to run it?
If I read that documentation, I end up with a series of maybes.
One for each installation type
If I use that script, it eliminates the probable locations, which is actually useful.
Otherwise, I'm guessing as to how and why the intent some specific install exists. That's unreasonable, do as the script does, and eliminate the locations it isn't, at least.
I'm back because of the My integration documentation, which has no way to test the integration has been activated.
Which is this thing. Why do all these docs leave me with more questions than answers, after I've taken the time to carefully read them?
For my installation, it was eventually found in a hidden directory for the user running HomeAssistant, but the binary could have told me where it was looking for that file.
A script could have looked in likely places.
But you would be back in the exact same position. If you use Home Assistant Container, run the script like this. If you use Home Assistant Operating System run the script like this, if you use Home Assistant Core run the script this way. Exactly like hacs
Right, your documentation should simply have a process of elimination to find the configuration, exactly as hacs does.
Instead, it's a nebulous cloud of maybes, honestly.
I would be back in the same position, had it failed.
It wouldn't have. I got better information about finding the configuration file, when I read the hacs script, over your docs.
And that's a shortcoming that should be humbly addressed, as it obviously hasn't been.
https://www.home-assistant.io/docs/configuration/#editing-configurationyaml
The path to your configuration directory can be found in the Home Assistant frontend by going to Configuration -> Settings -> Info
Where "Configuration -> Settings -> Info" is a my link pointing to the same place
There's three options. Right above the three options it shows you how to find which one you are using - and also a different way to find the configuration directory - with a helpful picture.
Right, and now I'm onto something different, because the script was better info than the docs. And that awful.
That's*. How can I check the My integration is on? I don't want to know the answer, I want it in the docs.
Did you put the line in configuration.yaml? Then it's on
Unless you get a big error message.
The documentation has no access to your installation, so it can never know
I click the link, I get a 404. Doesn't that mean it's not?
yes
I click the FAQ link, I do as it says. It remains 404.
but it does not matter, as all my links in our docs also say where to navigate manually
It's practically impossible, oh dear friends, to search for information about a thing called "My" as a proper noun. Firstly.
Or you configured your instance url incorrectly on my.home-assistant.io.
Nope, the link works otherwise. It wouldn't 404.
I'm looking to install the OctoPrint integration, which doesn't have manual install steps. https://www.home-assistant.io/integrations/octoprint/
Use #integrations-archived for help with setting up integrations
Which I'd otherwise stumble through, because stumbling through this by the docs would be a brick wall.
No, this a documentation issue.
no
I'm reading what you wrote.
If it isn't good enough, I come here to Discord and waste some user's time. And that's awful.
If I add "My:", and it doesn't work, why don't the docs tell me what next?
Because it could be... anything?
If it is not good enough, click the "Provide feedback" link at the bottom on any page
The topic of this channel is:
Development of the documentation, and you can find the documentation on writing documentation at https://developers.home-assistant.io/docs/documenting, and there's a guide at https://community.home-assistant.io/t/editing-the-documentation-and-creating-a-pull-request-on-github/9573/.
No support!
Command '.topic' was invoked by: Ludeeus
I agree, no support.
And this is the second time I've not asked for support.
I want that addressed in the documentation. You could just say, "hey, this script is where HomeAssistant looks for config files, by default".
I think I see what you mean about the manual steps missing. They are covered in the "Getting Started" section, though.
Wait, I'm sorry, a second ago I just couldn't read the steps. Are you sure they're not there?
Come on, I'm trying to use this in good faith by the documentation, and I just keep getting let down.
Huh? I didn't even say anything after you mentioned octoprint doesn't have manual install steps. I went away to check it and see what could be improved.
Do you know how crazy it is to give the integration that needs to be activated "My"?
Then I came back and agreed with you
Use #integrations-archived for help with setting up integrations
And not the tens of thousands of people asking about "my integrations"?
Ludeeus, still not asking for support in this channel. That breaks the rules. I'm asking for docs.
This channel is for those that needs help with writing the documentation, that is not you
Click the "Provide feedback" link at the bottom on any page, if you have problems using it
This channel is full of people who need help with writing the documentation. Did you not see the article I already identified as broken?
Did you not read that I suggested a script should take the place of a series of nebulous maybes for finding the configuration.yaml file?
That's not support requests.
Could the "My" integration be renamed for search purposes at least?
You are now breaking rule 4
Ludeeus, you're the issue. Go fix the docs.
Stop trying to push your work off on support. I was being perfectly respectable to your channel organization.
And instead of making constructive work, you want to find a rule violation. That's the docs problem, isn't it? Busy with doing whatever you're doing now.
Are you actually interesting in solving this issue? If so back off and we can discuss this from the start. If not I suggest you leave before you're silenced.
This isn't the place for solving the issue. It's for generating the documentation. It's not fair to blow your time for one person.
I was asking why it's not there, when I RTFM'ed as one is supposed to do.
And you were told it was and moved the goal posts.
I was told it was there! I was told there were manual install steps in the OctoPrint article.
We were talking about the documentation on how to find your configuration directory.
Then you are running an outdated version of Home Assistant. The documentation covers the latest release.
And since the smart home ecosystem changes so rapidly and the majority of it is outside of Home Assistants control, supporting old versions in any way is impossible and a waste of volunteers time.
I installed it from pip, as the docs suggested.
That includes keeping a change log
Something I'll take away from this discussion: Add a note to the front page of the documentation about the current version.
With a link to updating instructions (for each of the three installation methods ๐)
So installing HomeAssistant from pip gives me the old version?
I followed this. https://www.home-assistant.io/installation/raspberrypi
Are you joking?
The current version, that I would get from pip is, 2021.1.5?
And I'd somehow have to update beyond that, following those instructions, to get a HomeAssistant version up-to-date with the documentation?
If that's what you're telling me, I just want to make sure.
So then, why would those instructions install old HomeAssistant? I just installed it a month or two ago.
#551864459891703809 can help you with updating
Ludeeus, that's not what I asked. Did the docs install old HA, that needed to be updated? That's it.
Let's focus on the documentation. If it did, upgrading should be a step for sure.
Maybe it installed an old version because #devs_documentation-archived message
The docs does not install, you do that.
And you get the latest possible version based on your system
So, I would have already had to have been on Discord to know that.
No... that's a screenshot from the article you linked
and again... this whole conversation has nothing to do with writing documentation, since you are clearly not doing that.
So move this to proper channels.
Ludeeus, down. It clearly does. I read the docs.
And that's proof enough for me you don't actually read anything I say before reacting. Good night! Hope you solve your issues.
OK, I totally understand. Please write more thorough documentation, gentlement.
Hi, could someone with merge powers on the home-assistant.io repo please merge https://github.com/home-assistant/home-assistant.io/pull/21619 (after any final checks, of course). The parent commit got merged into core, I think this PR just slipped through the cracks
Will be fine, will definitely be merged for Wednesday's release ๐
I sure hope so, but I suppose it's not critical if it misses the deadline
If is has the milestone and/or parent-merged label, it will be picked up
No need to "hope" for that ๐
I believe I found a mistake in the documentation online
I believe the word underlined and in "" should be can't but I am not certain but wanted to bring it up as I am not sure how to report it.
https://www.home-assistant.io/integrations/scene/
"you have to specify the entity_id of all entities you want to take a snapshot of. entities and snapshot_entities __"can" __be combined but you have to use at least one of them."
At the bottom of each page there is an "Edit" button to propose a correction (or see any pending provided feedback that might already cover it).
I thought so but did not notice it, however I was in a hurry earlier. I will take another look later today.
Thanks
I am trying to add to / edit an existing document. When I finished and tried to create the PR I get a missing code language flag error. I have no idea what this means or how to fix it.
Examples and some clarifications home-assistant.io Test #25968
when you add code to the documentation it's required that you specify a text flag for it
that's why the bot is complaining
that page already has some code. You can compare that to yours to see what's different/missing ๐
I don't understand. I didn't add code( unless you consider yaml code).
it's the documentation website I mean a block of code yes
could be yaml could be anything else
this:
- is a block
- of code without
- a text flag
this:
- is a block
- of code with
- yaml flag
you can see this in your specific page
it already has an example that has highlighting
So how do I get to the page to fix this? The link I got from the bot goes to the failure.
I see how to edit it but nothing on code.
You sent me the raw document. Not sure what I need to do with this? I had found the document I edited. What I am asking is what do I need to do to edit the code so this passes? I just wanted to add some examples and pass them on the the author and see if he wanted to add them.
I sent you the raw document so you can see for yourself the difference and compare with the already existing yaml
I could give you the answer yes, but it's also better to understand what's wrong yourself
unless you don't want that ๐
Something that I thought would take 10 minutes is now taking several hours. I have no idea what the Lint Markdown wants or where to change it
I received an email that links to the doc, but not saying what is wrong
By the way, I copied and pasted my working scripts and yaml with " added"
This is the error
source/_integrations/waze_travel_time.markdown
67:1-77:4 warning Missing code language flag fenced-code-flag remark-lint
79:1-105:4 warning Missing code language flag fenced-code-flag remark-lint
107:1-120:4 warning Missing code language flag fenced-code-flag remark-lint
โ 3 warnings
Error: Process completed with exit code 1.
Where do I put this?
I'm going through the PR now and request changes there so it's easier
give me a few minutes
I see some other issues too
Thanks. My intent was to try an add examples to make it easier for others. I really didn't think it would be this difficult. Thanks for helping.
It's always difficult at first till you try a few times ๐
I've had several struggles with PRs
and still do ๐
Tell me when you are ready as I have several questions
I've submitted it
What are you telling me?
I received the email with your changes. How do I get to the PR?
Look through my comments to make the changes and make a new commit
same way you made a second commit 1h ago
The way it is on my screen is clear as mud. I have no idea what I need to do. By the time I figure it out, I will not care.
Do I need to accept something?
As far as I can tell the merging is still blocked.
Here is what I did. I hit edit on the original doc. I added a sentence early in the doc and I had some yaml examples. I have no idea what I need to change to make it work.
I've left comments exactly where it needs changing
so where do I change this?
I also do not understand the ID reference. I did not put either in
Yes that was just an extra thing I noticed. That's why I said since you opened the PR you could also fix that. Not that you did this. Just for consistency and all
You'd have to edit the file. You already did this by changing people to users
how did you do that?
No idea!
If you go to Files changed you should be able to hit Edit File from the 3 dots on the right
I added this for all the examples I used. When does the code check run
as we speak
Looks like it is fixed.
already passed
By the way do you use this waze integration?
Unfortunately I don't
you'd also need to fix the other issue on line 35
the ID is minor but the config.yaml line you added is incorrect
I didn't until recently and I found the document was geared to people that already knew how to use it.
What is wrong with line 35?
Also I can't get back to it.
can't get back?
This is text, what do I need to change on it?
I added the input select per the docs in my configuration.yaml file
yes and that is correct
but in a split configuration you wouldn't be adding it in a sensor yaml file
it's not a sensor
neither is the second part under it
it's a template
I'll remove the word sensor.
in my opinion the whole thing should be removed but can see what the big guys say when they review it
I had lots of questions when I was first setting it up as the docs do not say what to do. The google travel has some and the forums had other examples.
Thanks again. I don't think this is an easy process unless you are doing it all the time.
I would have rather been able to message the author with ideas on changing his document rather than me changing it.
You can
github can be very confusing at first
I did not see how on this integration.
That is where I started this morning.
Provide feedback
Not edit? So provide feedback goes to the author
It generates an issue
I'll try this next time
Follow it and see
Follow what?
That link
View pending feedback will take you to open issues regarding said integration
I got there directly from the ha integration
Can someone pls update the documentation
The nabu casa account link is not working every time
It keep report 429
Only the self creds way worked
Look at the post directly above yours.
This is available at the bottom of every documentation page.
Also try to be a lot clearer in what you are describing when you provide feedback.
1 wire
since we can not iterate over nested light groups (in light groups) like we can with 'Old style' groups, which imho is a core and much used feature, this https://next.home-assistant.io/integrations/group/#old-style-groups is a bit too negative really. https://github.com/home-assistant/core/issues/68836
A paragraph of sorts could be added to explain that (unless nesting light groups is in the works ofc...) anyone around 'owning' that section of the core group code?
I do
and I still stand by it (was also discussed with some other core members)
old style groups have some advantages and some disadvantages, however, for most user and use cases, its better not to use them; as the newer groups will general have a better advantage
If old style groups are a better fit for you, feel free to keep using them.
(last shows some before and after)
I think it looks pretty clean
LOL wrong channel
Hey Frenck, thanks. Id love to migrate completely to lights groups completely, no mistake there. I just need the expand on nested groups. Will await response on the issue first then.
less than 24 hours... wow. thanks for fixing that. pretty amazing
would you be open to a new page containing all the non-mobile companion apps, eg. the client apps for windows/linux/macos? I'm the developer of HASS.Agent, a Windows client, and I noticed that it's hard to find which one are actively being developed. my 'fear' is that either I'm putting hours into something that has already been developed, or some other developer does the same for something I built.
so I figured it could be beneficial for both users and devs if home-assistant.io/docs had a page dedicated to those tools. let me know if that'd be ok and I'll design one
Our companion apps are documented
and also have their dedicated documentation found here: https://companion.home-assistant.io/
(which is linked from the main documentation on many places)
Please note, we only document app maintained by the Home Assistant project itself
yea, I was talking about external apps. so there's no room for a 'these are the available external applications, note that they are not maintained by Home Assistant' page?
We don't support or advertise third-party projects in our official documentation, as we don't want to imply endorsement
well it's all non-profit opensource, developed by HA users, just like integrations/addons? but okay, that's too bad
We don't set those up in the documentation either
We have our community forums to discuss, promote and document third-party projects
of course, and that's a great place to start! but those posts fall behind, and you can't keep bumping your own ๐ so I thought it'd be nice for new users to have a list of clients for their os of choice. but oh well, maybe somewhere else some day - if something like that comes up, I've made a small list already ๐
Hi there, I am absolutey new here. So, where do I start? I just want to add a line in a file of an integration (kostal core/homeassistant/components/kostal_plenticore/const.py). **Can I do that on my running HA installation? Or do I need to go through the whole process with a development platform? **
This channel is about writing documentation (please read the channel descriptions).
In an Solar-inverter integrations documentation, should we add yaml examples on how to configure template and integration sensors to get energy from the provided power entities to be used in the energy panel?
https://github.com/home-assistant/home-assistant.io/pull/22320/files
Do the docs support embedding media (images)? Specifically I wanted to document some error dialogs
yes
Ok i'll look at the structure and figure out the best storage location ... should be obvious i'm assuming
images/integrations folder
Here is a recent example https://github.com/home-assistant/home-assistant.io/pull/22203
Thank you, that solves my issue. I don't need to add the class information in the integration, I can use a template to generate a new entity that has the correct class information.
Hello Devs,
Documentation pages seem to have some issue
it crashes the browser
I will share a screen recording in sometime, First I thought it must be my browser then I tried another browser and it is exactly the same issue
which link?
Mostly this and documentation pages
I cannot share a short screen recording video here
First I tried on Opera then on vivaldi both gets stuck and i had to force close them
I turned inspect on to see whats causing it and then it does not happen as the page is loaded in responsive ui
behaves normally for me in the latest Chrome and Safari
https://www.home-assistant.io/blog/2016/02/12/classifying-the-internet-of-things
As soon as I open this page and click on anywhere it start flickering
ok let me try on firefox
Interesting, behaving nicely on firefox
Is there anyway I can share the screen recording just for your understanding ?
Please use imgur or other image sharing web sites, and share the link here.
Image posting is blocked in most channels to discourage people from sharing text as images. Sharing text as images assumes that everybody sees the world as you do, which isn't the case. Some people are colour blind, or have visual impairment that means they can't make sense of an image of text.
Command '~images' was invoked by: RobC
I have uploaded it to youtube and its unlisted so cannot be searched
I found another website which seem to have similar issue
Hi. There doesn't seem to be any documentation on 2022.5's new device_class duration -- what unit_of_measurement does it take and how do I change the displayed units in the frontend?
There are a lot of these manual integration configuration steps that need updating from "Configuration" to "Settings". Can a bulk change be done?
what's the proper way to include an example jinja template code block in documentation? i'm fighting with the linters in this PR: https://github.com/home-assistant/home-assistant.io/pull/22642
ah right, the raw tag
That docs section should already be dynamically built everywhere. I created this PR that should cover it: https://github.com/home-assistant/home-assistant.io/pull/22644
Streamlining idea: How difficult would it be to procedurally generate a table of states for each core integration from the codebase? I see a lot of people asking for this information to be included in the documentation.
How difficult would it be to procedurally generate a table of states for each core integration from the codebase?
Difficult, we don't know ๐
The codebase doesn't have this information either
(hence e.g., the frontend doesn't offer a selector for the trigger/conditions states either)
Do all integrations not have this sort of thing? https://github.com/home-assistant/core/blob/dev/homeassistant/components/alarm_control_panel/strings.json#L29
Ah.
The state could come straight from the device or service
One might be able to manually compile a complete list of states for certain platform entity base classes like vacuum, light, switch, alarm control panel, etc. Which might still be worth doing and adding to the documentation. But some have unbounded set of states, like numeric sensors. Most generally, we have unbounded set of states for general sensors, not to mention integrations that use custom entity classes.
Hello , i would like to change IP of home assistant os 7.4 , i have only the CLI how can i do it ? Thank you
#general-archived for that
The topic of this channel is:
Development of the documentation, and you can find the documentation on writing documentation at https://developers.home-assistant.io/docs/documenting, and there's a guide at https://community.home-assistant.io/t/editing-the-documentation-and-creating-a-pull-request-on-github/9573/.
No support!
Command '.topic' was invoked by: RobC
Hi. https://community.home-assistant.io/t/introducing-hass-io-ingress/111502 has a link to ingress developer docs that broken. Namely here: https://i.imgur.com/jNFYqjm.png
And it links here:
https://developers.home-assistant.io/docs/hassio_addon_presentation.html#ingress
Forum posts aren't updated
its history / point in time
Check the original blog post, it will work ๐
In the Shell Command documentation, the paragraph under the note here https://www.home-assistant.io/integrations/shell_command/#execution How do you get access to the {{value}}? What sensor? Has this perhaps been confused with the command line sensor?
from reading the code of the two modules, I think that is the case. Especially as there is only a service created for the shell_command, and there is no associated sensor
Hi, could the yale smart living documentation specify the compatible devices? I was trying to set up my Yale assure lock for a while before I noticed I should be using the August integration. Could be cause I'm a beginner but there's probably others like me.
yale docs
Is there a reason why tap-action action documentation lists data as a valid option when it's not? service_data is required. Or was this changed between 2022.6.6 and 2022.6.7?
It was added in 2022.6 I believe
well, it's not working with variables then
I just helped a guy who was passing variables to a script. data did not pass the information when service_data does. He claims he's on 2022.6.6
he was passing
action: call-service
service: script.xyz
data:
myvariable: abc
no template, just myvariable did not pass through
changed it to
action: call-service
service: script.xyz
service_data:
myvariable: abc
and it worked
I'm taking his word on it, that's why I'm not too sure about writing an issue up
twas a custom card
Is there a way to add 'virtual switch' in the search bar to show template switch or template on the website?
Email should be mine or GitHub in cla
What do you mean?
In the cla signing site
Should I use my email
Or the GitHub nonreply one
You authorize Github to read out your own email address.
I use the non reply one frequently
And it auto filled it out
Daren this has nothing to do with documentation development. Please stop posting here.