Skip to content

Commit e2f567c

Browse files
Add RX8130 RTC Component Documentation (#5315)
* Added RX8130 Component Documentation RX8130 RTC documentation. * Corrected file name for RX8130 renamed rx1830.md to rx8130.md --------- Co-authored-by: Jonathan Swoboda <154711427+swoboda1337@users.noreply.github.com>
1 parent adb7cda commit e2f567c

File tree

3 files changed

+94
-0
lines changed

3 files changed

+94
-0
lines changed

content/automations/all_actions.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ title: ""
2323
- **dfrobot_sen0395:** `reset`, `settings`
2424
- **display_menu:** `down`, `enter`, `hide`, `left`, `right`, `show`, `show_main`, `up`
2525
- **ds1307:** `read_time`, `write_time`
26+
- **rx8130:** `read_time`, `write_time`
2627
- **esp32_ble_tracker:** `start_scan`, `stop_scan`
2728
- **event:** `trigger`
2829
- **ezo_pmp:** `arbitrary_command`, `change_i2c_address`, `clear_calibration`, `clear_total_volume_dosed`, `dose_continuously`, `dose_volume`, `dose_volume_over_time`, `dose_with_constant_flow_rate`, `find`, `pause_dosing`, `set_calibration_volume`, `stop_dosing`

content/components/_index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -998,6 +998,7 @@ at the {{< docref "light/fastled" "FastLED Light" >}}.
998998
{{< imgtable >}}
999999
"Time Core","components/time/index","clock-outline.svg","dark-invert"
10001000
"DS1307 RTC","components/time/ds1307","clock-outline.svg","dark-invert"
1001+
"RX8130 RTC","components/time/rx8130","clock-outline.svg","dark-invert"
10011002
"GPS Time","components/time/gps","crosshairs-gps.svg","dark-invert"
10021003
"Home Assistant Time","components/time/homeassistant","home-assistant.svg","dark-invert"
10031004
"PCF85063 RTC","components/time/pcf85063","clock-outline.svg","dark-invert"

content/components/time/rx8130.md

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
---
2+
description: "RX8130 Time Source"
3+
title: "RX8130 Time Source"
4+
---
5+
6+
You first need to set up the {{< docref "/components/i2c" "I2C" >}} component.
7+
8+
```yaml
9+
# Example configuration entry
10+
time:
11+
- platform: rx8130
12+
id: rx8130_time
13+
```
14+
15+
## Configuration variables
16+
17+
- **address** (*Optional*, int): Manually specify the I²C address of the RTC. Defaults to `0x32`.
18+
- All other options from [Base Time Configuration](#base_time_config).
19+
20+
{{< anchor "rx8130-write_time_action" >}}
21+
22+
## `rx8130.write_time` Action
23+
24+
This [Action](#config-action) triggers a synchronization of the current system time to the RTC hardware.
25+
26+
{{< note >}}
27+
The RX8130 component will *not* write to the RTC clock if not triggered *explicitly* by this action.
28+
29+
{{< /note >}}
30+
31+
```yaml
32+
on_...:
33+
- rx8130.write_time
34+
35+
# in case you need to specify the RX8130 id
36+
- rx8130.write_time:
37+
id: rx8130_time
38+
```
39+
40+
{{< anchor "rx8130-read_time_action" >}}
41+
42+
## `rx8130.read_time` Action
43+
44+
This [Action](#config-action) triggers a synchronization of the current system time from the RTC hardware.
45+
46+
{{< note >}}
47+
The RX8130 component will automatically read the RTC clock every 15 minutes by default and synchronize the
48+
system clock when a valid timestamp is read from the RTC. (The `update_interval` can be changed.)
49+
This action can be used to trigger *additional* synchronizations.
50+
51+
{{< /note >}}
52+
53+
```yaml
54+
on_...:
55+
- rx8130.read_time
56+
57+
# in case you need to specify the RX8130 id
58+
- rx8130.read_time:
59+
id: rx8130_time
60+
```
61+
62+
{{< anchor "rx8130-config_example" >}}
63+
64+
## Full Configuration Example
65+
66+
In a typical setup, you will have at least one additional time source to synchronize the RTC with. Such an
67+
external time source might not always be available e.g. due to a limited network connection.
68+
In order to have a valid, reliable system time, the system should read the RTC once at start and then try to
69+
synchronize with an external reliable time source.
70+
When a synchronization to another time source was successful, the RTC can be resynchronized.
71+
72+
```yaml
73+
esphome:
74+
on_boot:
75+
then:
76+
# read the RTC time once when the system boots
77+
rx8130.read_time:
78+
79+
time:
80+
- platform: rx8130
81+
# repeated synchronization is not necessary unless the external RTC
82+
# is much more accurate than the internal clock
83+
update_interval: never
84+
- platform: homeassistant
85+
# instead try to synchronize via network repeatedly ...
86+
on_time_sync:
87+
then:
88+
# ... and update the RTC when the synchronization was successful
89+
rx8130.write_time:
90+
```
91+
92+
## See Also

0 commit comments

Comments
 (0)