Upstream/esphome-docs
1
0
Fork 0
mirror of https://github.com/esphome/esphome-docs.git synced 2024-11-05 09:20:08 +01:00
Code Issues Projects Releases Wiki Activity

Change datetime id names in examples (#3777)

Browse Source
This commit is contained in:
RFDarter 2024-05-30 00:07:25 +02:00 committed by GitHub
parent 83c29b6c74
commit 0138eca827
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
components/datetime/index.rst
View File

@ -103,12 +103,12 @@ The ``date`` provided can be in one of 3 formats:
# String date
- datetime.date.set:
id: my_date
id: my_datetime_date
date: "2023-12-04"
# Individual date parts
- datetime.date.set:
id: my_date
id: my_datetime_date
date:
year: 2023
month: 12
@ -116,7 +116,7 @@ The ``date`` provided can be in one of 3 formats:
# Using a lambda
- datetime.date.set:
id: my_date
id: my_datetime_date
date: !lambda |-
// Return an ESPTime struct
return {.day_of_month: 4, .month: 12, .year: 2023};
@ -142,7 +142,7 @@ advanced stuff (see the full API Reference for more info).
.. code-block:: cpp
// Within lambda, set the date to 2024-02-25
auto call = id(my_date).make_call();
auto call = id(my_datetime_date).make_call();
call.set_date("2024-02-25");
call.perform();
@ -174,12 +174,12 @@ The ``time`` provided can be in one of 3 formats:
# String time
- datetime.time.set:
id: my_time
id: my_datetime_time
time: "12:34:56"
# Individual time parts
- datetime.time.set:
id: my_time
id: my_datetime_time
time:
hour: 12
minute: 34
@ -187,7 +187,7 @@ The ``time`` provided can be in one of 3 formats:
# Using a lambda
- datetime.time.set:
id: my_time
id: my_datetime_time
time: !lambda |-
// Return an ESPTime struct
return {.second: 56, .minute: 34, .hour: 12};
@ -212,7 +212,7 @@ advanced stuff (see the full API Reference for more info).
.. code-block:: cpp
// Within lambda, set the time to 12:34:56
auto call = id(my_time).make_call();
auto call = id(my_datetime_time).make_call();
call.set_time("12:34:56");
call.perform();
@ -227,7 +227,7 @@ advanced stuff (see the full API Reference for more info).
.. code-block:: cpp
// For example, create a custom log message when a value is received:
ESP_LOGI("main", "Value of my datetime: %0d:%02d:%02d", id(my_time).hour, id(my_time).minute, id(my_time).second);
ESP_LOGI("main", "Value of my datetime: %0d:%02d:%02d", id(my_datetime_time).hour, id(my_datetime_time).minute, id(my_datetime_time).second);
DateTime Automation

4
components/datetime/template.rst
View File

@ -13,7 +13,7 @@ using :ref:`lambdas <config-lambda>`.
datetime:
# Example Date
- platform: template
id: my_date
id: my_datetime_date
type: date
name: Pick a Date
optimistic: yes
@ -22,7 +22,7 @@ using :ref:`lambdas <config-lambda>`.
# Example Time
- platform: template
id: my_time
id: my_datetime_time
type: time
name: Pick a Time
optimistic: yes