Magicseaweed sensor documentation #5598
Conversation
frenck
added
the
new-integration
There was a problem hiding this comment.
Hi @jcconnell,
I've reviewed your documentation PR. Could you take a look at the comments? 👍
| logo: magicseaweed.png | ||
| ha_category: Sensor | ||
| featured: false | ||
| ha_release: "0.72" |
There was a problem hiding this comment.
0.72 is already out. You might want to up this to 0.73 ⬆️
| - max_breaking_swell | ||
| ``` | ||
|
|
||
| Configuration variables: |
There was a problem hiding this comment.
Please use the configuration tags, for more information please see:
https://home-assistant.io/developers/documentation/create_page/#configuration
| # Example configuration.yaml entry | ||
| sensor: | ||
| - platform: magicseaweed | ||
| name: Hurricane Spot |
There was a problem hiding this comment.
We try to keep all configuration samples minimal. Thus, no optional requirement in the default sample. This helps a user to get started quickly by copy-&-paste the sample without worrying about optional parameters which they most likely not need. If required, insert a full configuration sample later that covers special setups or alike.
| comments: false | ||
| sharing: true | ||
| footer: true | ||
| logo: magicseaweed.png |
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
|
@jcconnell Thanks for the updates, nevertheless, the builds are failing. |
frenck
added
in-progress
|
Hello @frenck, I apologize for the delay. I was asked to write a library to supplement this sensor. Now that it's finished, I'm revisiting this error with the documentation. Jekyll is reporting an error on line 9 column 25 regarding mapping values on sensor.magicseaweed.markdown. I've reviewed the file and searched for similar problems, but I'm still unable to find the issue. Do you see anything I might be missing? |
|
Ok, it seems that I have addressed all the problems with my file, sensor.magicseaweed.markdown. It is now complaining about a filename for MQTT logging:
|
frenck
added
the
needs-rebase
|
@jcconnell Rebase this PR onto |
|
Sorry, I'm not very familiar with this workflow. What would be the process to rebase this onto origin/next? Can it be completed through a web browser? |
|
Did anyone have any luck with this? Tell us if help is needed... |
Not sure I did this correctly but I followed the docs: https://www.home-assistant.io/developers/documentation/create_page/#configuration
Transparent background version not available. API Documentation requests that this logo be used.
jcconnell
force-pushed
the
msw_documentation
branch
from
ad7fec5
to
e191863
Compare
| 12AM: | ||
| description: Display forecast for 12AM. | ||
| spot_id: | ||
| description: Surf spot ID to monitor surf forecast of.Details for getting spot id available at [Magicseaweed](https://magicseaweed.com/developer/forecast-api) |
There was a problem hiding this comment.
There's a missing space after the period before "Details". But maybe rewrite the description somewhat? It reads a bit weird when ending with the preposition in the first sentence.
| required: true | ||
| type: string | ||
| monitored_conditions: | ||
| description: Conditions to display in the frontend. |
There was a problem hiding this comment.
This isn't dependent on the frontend per se, but decides what entities to create, ie what data to make available.
|
Can be merged when build passes. |
|
Yes! Thanks everyone for the help and patience. |
arsaboo
dismissed
frenck’s stale review
Comments addressed and approved by Martin
ghost
removed
the
frenck
removed
the
needs-rebase
Description:
Documentation for the magicseaweed sensor.
Pull request in home-assistant (if applicable): home-assistant/core#15132
Checklist:
current. New documentation for platforms/components and features should go tonext.