Component: Real Time Clock (ESP32) (Storage)

Author	Matrix TSL
Version	1.0
Category	Storage

Real Time Clock (ESP32) component

Allows an ESP32 device to act as a RTC with NTP type server synchronisation. Requires a WIFI network connection with internet access to synchronise. Provides simulation using local PC system time.

Detailed description

No detailed description exists yet for this component

Examples

A simple example that shows how to connect the ESP device to a network and synchronise the internal clock with an internet based NTP time server every hour.

ESP32 RTC NTP Example

The internal clock can drift over time and so it is important to sync regularily with the NTP time server.

For low power operations or when internet connectivity may be intermittent a 32.768KHz crystal can be used with the ESP32 device to improve the internal clock accuracy over time.

The crystal is fitted between pins IO32 and IO33 and must have 12pF capacitors to ground. The crystal must also be enabled by editing the sdkconfig file in the project compilation directory.

Downloadable macro reference

	GetDateString
Collects the current date and returns it as a string. e.g. "DD/MM/YY" or "MM/DD/YY"
[[File:]] -	USFormat
Select date format: 0=DD/MM/YY, 1=MM/DD/YY
- STRING	Return

	GetHours
Collects the current hour as a numeric value in the range of 0 - 23.
- BYTE	Return

	GetSecs
Collects the current second as a numeric value in the range of 0 - 59.
- BYTE	Return

	GetYear
Collects the year as a numeric value in the range of 0 - 99.
- BYTE	Return

	QueryTimeServer
Attempt to collect the local time from the selected time server. The ESP WIFI must be connected to a network with internet to allow this to work. Returns true if the time server synchronised correctly with the ESP.
[[File:]] -	Return

	ReadTime
- BYTE	Unit
- BYTE	Return

	SetTime
Manually sets the current time. Useful for when WIFI / NTP commnication is not available.
- BYTE	Hour
Hour ranging from 0 to 23
- BYTE	Min
Minute ranging from 0 to 59
- BYTE	Sec
Second ranging from 0 to 59
- VOID	Return

	GetMins
Collects the current minute as a numeric value in the range of 0 - 59.
- BYTE	Return

	GetTimeString
Collects the current time and returns it as a string. e.g. "HH:MM" or "HH:MM:SS"
[[File:]] -	IncludeSeconds
0=Dont Include Seconds, 1=Include Seconds in the String
- STRING	Return

	ReadDate
- BYTE	Unit
- BYTE	Return

	SetDate
Manually sets the current date. Useful for when WIFI / NTP commnication is not available.
- BYTE	Date
Day of the month ranging from 1 to 31
- BYTE	Month
Month ranging from 1 to 12
- BYTE	Year
Year ranging from 0 to 99
- VOID	Return

	GetDate
Collects the day of the month as a numeric value in the range of 1 - 31.
- BYTE	Return

	SetTimeServer
Overwrites the default time server setting allowing for multiple time servers to be queried.
- STRING	TimeServer
e.g. "pool.ntp.org"
- VOID	Return

	GetMonth
Collects the month as a numeric value in the range of 1 - 12.
- BYTE	Return

	Initialise
Configures the timeserver variable as well as sets the timezone offset in seconds.
- VOID	Return

	SetUTCOffset
Allows the UTC Offset to be defined in seconds. e.g. for BST use 3600 or for UTC+2 use 7200 or for UTC-2 use -7200
[[File:]] -	UTCOffset
Time offset in seconds
- VOID	Return

	Initialise
Configures each matching sensor on the bus with the specified conversion bits.
- VOID	Return

	SendBinaryFloat
Sends out a 32-bit binary floating point value split across four bytes.
[[File:]] -	Value
[[File:]] -	MSBfirst
0=Least significant byte first, 1=Most significant byte first
- VOID	Return

	GetProp
Allows the property filter for the COM port list to be copied to a parent component.
- STRING	PropName
- STRING	Return

	ReceiveByteArray
Attempts to receive an array of bytes using the COM port Returns the number of bytes received.
- BYTE	Data
- UINT	MaxLength
Max number of bytes to try and read
- UINT	Timeout
Time to wait for incoming data in milliseconds
- UINT	Return

	ReceiveString
Attempts to receive an string using the COM port Returns the number of bytes received.
- UINT	Timeout
Time to wait for incoming data in milliseconds
- UINT	MaxLength
Max number of bytes to try and read
- STRING	Return

	PWMEnable
Allows pulse width modulated transistor outputs to be switched on or off. Bit 0 = Enable AB Bit 1 = A / Bit 2 = B Bit 3 = C / Bit 4 = D Bit 5 = Enable CD
- BYTE	EnableMask
Range 0-63 or 0b00000 to 0b111111
- VOID	Return

	Initialise
- VOID	Return

	GetProp
Allows the property filter for the COM port list to be copied to a parent component.
- STRING	PropName
- STRING	Return

Property reference

	Properties
	Time Server
Default time server URL. Set as part of the initialise macro. Can be overridden using the SetTimeServer macro.
	UTC Offset
Offset in seconds from UTC. Set as part of the initialise macro. Can be overridden using the SetUTCOffset macro.
	Number of Retries
Sets the number of retries to connect to the SNTP server before giving up
	Connections
	Simulations