Skip to content

Update documentation for the sun component to describe the offset option #6288

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.

Sign up for GitHub

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

Open
ilikecake wants to merge 1 commit into
base: next
Choose a base branch
from
+8 −2
Open

Update documentation for the sun component to describe the offset option #6288

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions src/content/docs/components/sun.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ The `sun` component allows you to track the sun's position in the sky. Calculati
sun:
latitude: 48.8584°
longitude: 2.2945°
offset: 1d

# At least one time source is required
time:
Expand All @@ -27,6 +28,7 @@ time:

- **latitude** (**Required**, float): The latitude for performing the calculation.
- **longitude** (**Required**, float): The longitude for performing the calculation.
- **offset** (*optional*, time period): A time duration to offset the current time for sunrise/sunset calculations. Must be 1 second or more, and may be negative.
- **id** (*Optional*, [ID](/guides/configuration-types#id)): Manually specify the ID used for code generation.

## Triggers
Expand Down Expand Up @@ -99,14 +101,18 @@ text_sensor:
- platform: sun
name: Sun Next Sunset
type: sunset
- platform: sun
name: Sun Time
type: time
format: "%c"
```

<Image src={sunTextSensorUiImg} layout="constrained" alt="" />

### Configuration variables

- **type** (**Required**, string): The type of value to track. One of `sunrise` and
`sunset`.
- **type** (**Required**, string): The type of value to track. One of `sunrise`, `sunset`,
or `time`.

- **elevation** (*Optional*, float): The elevation to calculate the next sunrise/sunset event
for. Defaults to -0.833° (the horizon, slightly less than 0° to compensate for atmospheric refraction).
Expand Down
Loading