Documentation

Overview

Battery-backed real-time clock.

See also the documentation here: https://www.tinkerforge.com/en/doc/Software/Bricklets/RealTimeClock_Bricklet_Go.html.

Index

Constants

View Source
const DeviceDisplayName = "Real-Time Clock Bricklet"
View Source
const DeviceIdentifier = 268

Variables

This section is empty.

Functions

This section is empty.

Types

type AlarmInterval

type AlarmInterval = int32
const (
	AlarmIntervalDisabled AlarmInterval = -1
)

type AlarmMatch

type AlarmMatch = int8
const (
	AlarmMatchDisabled AlarmMatch = -1
)

type Function

type Function = uint8
const (
	FunctionSetDateTime               Function = 1
	FunctionGetDateTime               Function = 2
	FunctionGetTimestamp              Function = 3
	FunctionSetOffset                 Function = 4
	FunctionGetOffset                 Function = 5
	FunctionSetDateTimeCallbackPeriod Function = 6
	FunctionGetDateTimeCallbackPeriod Function = 7
	FunctionSetAlarm                  Function = 8
	FunctionGetAlarm                  Function = 9
	FunctionGetIdentity               Function = 255
	FunctionCallbackDateTime          Function = 10
	FunctionCallbackAlarm             Function = 11
)

type RealTimeClockBricklet

type RealTimeClockBricklet struct {
	// contains filtered or unexported fields
}

func New

Creates an object with the unique device ID `uid`. This object can then be used after the IP Connection `ipcon` is connected.

func (*RealTimeClockBricklet) DeregisterAlarmCallback

func (device *RealTimeClockBricklet) DeregisterAlarmCallback(registrationId uint64)

Remove a registered Alarm callback.

func (*RealTimeClockBricklet) DeregisterDateTimeCallback

func (device *RealTimeClockBricklet) DeregisterDateTimeCallback(registrationId uint64)

Remove a registered Date Time callback.

func (*RealTimeClockBricklet) GetAPIVersion

func (device *RealTimeClockBricklet) GetAPIVersion() [3]uint8

Returns the version of the API definition (major, minor, revision) implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

func (*RealTimeClockBricklet) GetAlarm

func (device *RealTimeClockBricklet) GetAlarm() (month AlarmMatch, day AlarmMatch, hour AlarmMatch, minute AlarmMatch, second AlarmMatch, weekday AlarmMatch, interval AlarmInterval, err error)

Returns the alarm configuration as set by SetAlarm.

.. versionadded:: 2.0.1$nbsp;(Plugin)

Associated constants:

* AlarmMatchDisabled
* AlarmIntervalDisabled

func (*RealTimeClockBricklet) GetDateTime

func (device *RealTimeClockBricklet) GetDateTime() (year uint16, month uint8, day uint8, hour uint8, minute uint8, second uint8, centisecond uint8, weekday Weekday, err error)

Returns the current date (including weekday) and the current time of the real-time clock.

Associated constants:

* WeekdayMonday
* WeekdayTuesday
* WeekdayWednesday
* WeekdayThursday
* WeekdayFriday
* WeekdaySaturday
* WeekdaySunday

func (*RealTimeClockBricklet) GetDateTimeCallbackPeriod

func (device *RealTimeClockBricklet) GetDateTimeCallbackPeriod() (period uint32, err error)

Returns the period as set by SetDateTimeCallbackPeriod.

.. versionadded:: 2.0.1$nbsp;(Plugin)

func (*RealTimeClockBricklet) GetIdentity

func (device *RealTimeClockBricklet) GetIdentity() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, firmwareVersion [3]uint8, deviceIdentifier uint16, err error)

Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.

The position can be 'a', 'b', 'c', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an `Isolator Bricklet <isolator_bricklet>` is always at position 'z'.

The device identifier numbers can be found `here <device_identifier>`. |device_identifier_constant|

func (*RealTimeClockBricklet) GetOffset

func (device *RealTimeClockBricklet) GetOffset() (offset int8, err error)

Returns the offset as set by SetOffset.

func (*RealTimeClockBricklet) GetResponseExpected

func (device *RealTimeClockBricklet) GetResponseExpected(functionID Function) (bool, error)

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by SetResponseExpected. For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

See SetResponseExpected for the list of function ID constants available for this function.

func (*RealTimeClockBricklet) GetTimestamp

func (device *RealTimeClockBricklet) GetTimestamp() (timestamp int64, err error)

Returns the current date and the time of the real-time clock. The timestamp has an effective resolution of hundredths of a second and is an offset to 2000-01-01 00:00:00.000.

func (*RealTimeClockBricklet) RegisterAlarmCallback

func (device *RealTimeClockBricklet) RegisterAlarmCallback(fn func(uint16, uint8, uint8, uint8, uint8, uint8, uint8, Weekday, int64)) uint64

This callback is triggered every time the current date and time matches the configured alarm (see SetAlarm). The parameters are the same as for GetDateTime and GetTimestamp combined.

.. versionadded:: 2.0.1$nbsp;(Plugin)

func (*RealTimeClockBricklet) RegisterDateTimeCallback

func (device *RealTimeClockBricklet) RegisterDateTimeCallback(fn func(uint16, uint8, uint8, uint8, uint8, uint8, uint8, Weekday, int64)) uint64

This callback is triggered periodically with the period that is set by SetDateTimeCallbackPeriod. The parameters are the same as for GetDateTime and GetTimestamp combined.

The RegisterDateTimeCallback callback is only triggered if the date or time changed since the last triggering.

.. versionadded:: 2.0.1$nbsp;(Plugin)

func (*RealTimeClockBricklet) SetAlarm

func (device *RealTimeClockBricklet) SetAlarm(month AlarmMatch, day AlarmMatch, hour AlarmMatch, minute AlarmMatch, second AlarmMatch, weekday AlarmMatch, interval AlarmInterval) (err error)

Configures a repeatable alarm. The RegisterAlarmCallback callback is triggered if the current date and time matches the configured alarm.

Setting a parameter to -1 means that it should be disabled and doesn't take part in the match. Setting all parameters to -1 disables the alarm completely.

For example, to make the alarm trigger every day at 7:30 AM it can be configured as (-1, -1, 7, 30, -1, -1, -1). The hour is set to match 7 and the minute is set to match 30. The alarm is triggered if all enabled parameters match.

The interval has a special role. It allows to make the alarm reconfigure itself. This is useful if you need a repeated alarm that cannot be expressed by matching the current date and time. For example, to make the alarm trigger every 23 seconds it can be configured as (-1, -1, -1, -1, -1, -1, 23). Internally the Bricklet will take the current date and time, add 23 seconds to it and set the result as its alarm. The first alarm will be triggered 23 seconds after the call. Because the interval is not -1, the Bricklet will do the same again internally, take the current date and time, add 23 seconds to it and set that as its alarm. This results in a repeated alarm that triggers every 23 seconds.

The interval can also be used in combination with the other parameters. For example, configuring the alarm as (-1, -1, 7, 30, -1, -1, 300) results in an alarm that triggers every day at 7:30 AM and is then repeated every 5 minutes.

.. versionadded:: 2.0.1$nbsp;(Plugin)

Associated constants:

* AlarmMatchDisabled
* AlarmIntervalDisabled

func (*RealTimeClockBricklet) SetDateTime

func (device *RealTimeClockBricklet) SetDateTime(year uint16, month uint8, day uint8, hour uint8, minute uint8, second uint8, centisecond uint8, weekday Weekday) (err error)

Sets the current date (including weekday) and the current time.

If the backup battery is installed then the real-time clock keeps date and time even if the Bricklet is not powered by a Brick.

The real-time clock handles leap year and inserts the 29th of February accordingly. But leap seconds, time zones and daylight saving time are not handled.

Associated constants:

* WeekdayMonday
* WeekdayTuesday
* WeekdayWednesday
* WeekdayThursday
* WeekdayFriday
* WeekdaySaturday
* WeekdaySunday

func (*RealTimeClockBricklet) SetDateTimeCallbackPeriod

func (device *RealTimeClockBricklet) SetDateTimeCallbackPeriod(period uint32) (err error)

Sets the period with which the RegisterDateTimeCallback callback is triggered periodically. A value of 0 turns the callback off.

The RegisterDateTimeCallback Callback is only triggered if the date or time changed since the last triggering.

.. versionadded:: 2.0.1$nbsp;(Plugin)

func (*RealTimeClockBricklet) SetOffset

func (device *RealTimeClockBricklet) SetOffset(offset int8) (err error)

Sets the offset the real-time clock should compensate for in 2.17 ppm steps between -277.76 ppm (-128) and +275.59 ppm (127).

The real-time clock time can deviate from the actual time due to the frequency deviation of its 32.768 kHz crystal. Even without compensation (factory default) the resulting time deviation should be at most ±20 ppm (±52.6 seconds per month).

This deviation can be calculated by comparing the same duration measured by the real-time clock (“rtc_duration“) an accurate reference clock (“ref_duration“).

For best results the configured offset should be set to 0 ppm first and then a duration of at least 6 hours should be measured.

The new offset (“new_offset“) can be calculated from the currently configured offset (“current_offset“) and the measured durations as follow::

new_offset = current_offset - round(1000000 * (rtc_duration - ref_duration) / rtc_duration / 2.17)

If you want to calculate the offset, then we recommend using the calibration dialog in Brick Viewer, instead of doing it manually.

The offset is saved in the EEPROM of the Bricklet and only needs to be configured once.

func (*RealTimeClockBricklet) SetResponseExpected

func (device *RealTimeClockBricklet) SetResponseExpected(functionID Function, responseExpected bool) error

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

func (*RealTimeClockBricklet) SetResponseExpectedAll

func (device *RealTimeClockBricklet) SetResponseExpectedAll(responseExpected bool)

Changes the response expected flag for all setter and callback configuration functions of this device at once.

type Weekday

type Weekday = uint8
const (
	WeekdayMonday    Weekday = 1
	WeekdayTuesday   Weekday = 2
	WeekdayWednesday Weekday = 3
	WeekdayThursday  Weekday = 4
	WeekdayFriday    Weekday = 5
	WeekdaySaturday  Weekday = 6
	WeekdaySunday    Weekday = 7
)