ASR provides two different facilities for setting and keeping time on an MCU:
The first two attributes sent at link time can be used to set a Real-Time Clock (RTC) on the MCU if there is support for one. If your MCU doesn’t support RTC, you can use the periodic timestamp updates to provide a reasonably accurate clock for your device.
When ASR comes online, it will return two attributes to the MCU. These attributes contain a timestamp and UTC offset data and are always sent. No configuration is required to receive them, although you do have to listen for them in your application’s attribute handler. If you don’t need clock support in your MCU application, you can safely ignore these attributes.
The two attributes are described below:
LINKED_TIMESTAMP (signed 32-bit long)
This is a UNIX Epoch (number of seconds since 00:00:00 1/1/1970) UTC timestamp marking when ASR successfully last linked to the Afero Cloud. The timestamp is returned shortly after ASR reboots and should be reasonably close to actual current time.
The latency from the Cloud back to the MCU is typically less than 1-2 seconds, but don’t rely on this timestamp being more accurate than +/- 10 seconds (worst case). If your time of day (TOD) requirements are not critical, this is a very convenient way of getting TOD with little work.
This byte array contains three pieces of information: the current local timezone offset from UTC, the next UTC offset, and a UNIX Epoch timestamp of when the “next” UTC offset is valid. Specifically:
UTC Offset is determined by the Location attributes set (by you) for ASR and are not dynamic in any way. The UTC Offset can and will be wrong if the Location in the device configuration is incorrect. You can set the correct Location for your Afero device using the Afero mobile app, or by using the Afero Inspector developer tool at https://inspector.afero.io.
Let’s look at examples of these attributes and the meanings of their values. These attribute values:
Link Time: 0x5a2b06c3 (Fri 2017-12-08 21:40:19 GMT) Current UTC Offset: -300 minutes (0xFED4) (Eastern Standard Time, in this example) UTC Offset Change: Sun 2018-03-11 07:00:00 GMT (0x5AA4D3F0) (Spring 2018 USA DST Time Change, 2am local time) Next UTC Offset: -240 minutes (0xFF10) (Eastern Daylight Time, in this example)
Only assume that
LINKED_TIMESTAMP is current when the state of ASR transitions to a connected state. You can use
get_attribute to return the Linked Timestamp at any point, but remember the result returned will be the time ASR first linked or re-linked to the Cloud, which could be significantly in the past if the device has been connected for a long time. We strongly suggest not querying the
LINKED_TIMESTAMP attribute and only handle it when it is sent unsolicited to the MCU.
After ASR comes online, you can receive a periodic timestamp update from ASR via attribute. This attribute is sent to the MCU every 60 seconds starting at the first full minute after link time. This update is disabled by default but you can enable it for your device profile using the Afero Profile Editor as follows: on the Attributes Definition window, MCU Configuration section, select the Receive UTC Time checkbox. You must enable this attribute on a per-profile basis, and the feature requires that your device be running firmware Release 2.0.1 or higher.
ASR_UTC_TIME (signed 32-bit long)
This is a UNIX Epoch (number of seconds since 00:00:00 1/1/1970) UTC timestamp, returned by ASR once per minute, starting the next minute (:00 seconds) after the LINKED_TIMESTAMP.
This timestamp is sent once per minute approximately on the minute (:00 seconds). This time is not synced to any Network Time; however, it is typically within +/- one (1) second of accuracy.
In afLib3, we’ve included the
afero_clock application, which provides a simple method for:
ASR_UTC_TIMEupdates if enabled in your profile.
The example profiles provided in the afero_clock project enable the
ASR_UTC_TIME attribute and will display the value when received.
For best results, use an RTC chip and use the Linked Timestamp and UTC Offset attributes to set the RTC. By doing this you’ll have access to a reasonably accurate clock. Remember, the Linked Timestamp is only sent to the MCU when ASR links or re-links to the Afero Cloud.
The device profile created using the Afero Profile Editor doesn’t need any specific support for Linked Timestamp or UTC Offset attributes, as they are system attributes and will be presented to the MCU as long as the Afero device profile has MCU support enabled. However, in order to receive the periodic
ASR_UTC_TIME attribute updates, you must have selected the Receive UTC Time checkbox for your device profile (using the Profile Editor, Attribute Definition window, MCU Configuration section).
The example code provided in afLib3 includes some code that protects against accepting
LINKED_TIMESTAMP when an MCU application requests that data via
get_attribute. Since the value returned is the timestamp of when ASR last linked to the Afero Cloud, this value will not update except when ASR re-links its connection. If this level of paranoia isn’t needed, all references and checks to “timestamp_read” can be removed.
When ASR first boots, it will send an
SYSTEM_UTC_OFFSET_DATA attribute update to the MCU; however, all data in this attribute will be zero. Since UTC Offset=0 is valid, you should check for the value of the UTC Offset Change Timestamp (the middle four bytes of the attribute value). If this timestamp is zero then the UTC Offset data is invalid and can be ignored. Once ASR links, you will receive the Linked Timestamp attribute and another UTC Offset attribute with valid data. In the case of a device with no Location or local timezone defined, the UTC_OFFSET_DATA attribute will remain all zeroes and can be safely ignored.
It is possible to receive a new
SYSTEM_UTC_OFFSET_DATA attribute update at any time (for example, the passing of a Daylight Saving Time boundary). As long as the Offset Change Time Timestamp is greater than the Linked Timestamp (or the Current Timestamp if you have an RTC), then the update data should be considered valid and the RTC updated accordingly (typically by subtracting the “old” offset and adding the “new” offset to re-adjust the clock to the new timezone).
In C/C++, the
strftime() call can be used to format either timestamp into human-readable forms.
Data types for the timestamp attribute values are: