Go - Real-Time Clock Bricklet¶

Simple¶

Download (example_simple.go)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

package main

import (
    "fmt"
    "github.com/Tinkerforge/go-api-bindings/ipconnection"
    "github.com/Tinkerforge/go-api-bindings/real_time_clock_bricklet"
)

const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your Real-Time Clock Bricklet.

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    rtc, _ := real_time_clock_bricklet.New(UID, &ipcon) // Create device object.

    ipcon.Connect(ADDR) // Connect to brickd.
    defer ipcon.Disconnect()
    // Don't use device before ipcon is connected.

    // Get current date and time.
    year, month, day, hour, minute, second, centisecond, weekday, _ := rtc.GetDateTime()

    fmt.Printf("Year: %d\n", year)
    fmt.Printf("Month: %d\n", month)
    fmt.Printf("Day: %d\n", day)
    fmt.Printf("Hour: %d\n", hour)
    fmt.Printf("Minute: %d\n", minute)
    fmt.Printf("Second: %d\n", second)
    fmt.Printf("Centisecond: %d\n", centisecond)

    if weekday == real_time_clock_bricklet.WeekdayMonday {
        fmt.Println("Weekday: Monday")
    } else if weekday == real_time_clock_bricklet.WeekdayTuesday {
        fmt.Println("Weekday: Tuesday")
    } else if weekday == real_time_clock_bricklet.WeekdayWednesday {
        fmt.Println("Weekday: Wednesday")
    } else if weekday == real_time_clock_bricklet.WeekdayThursday {
        fmt.Println("Weekday: Thursday")
    } else if weekday == real_time_clock_bricklet.WeekdayFriday {
        fmt.Println("Weekday: Friday")
    } else if weekday == real_time_clock_bricklet.WeekdaySaturday {
        fmt.Println("Weekday: Saturday")
    } else if weekday == real_time_clock_bricklet.WeekdaySunday {
        fmt.Println("Weekday: Sunday")
    }

    // Get current timestamp.
    timestamp, _ := rtc.GetTimestamp()
    fmt.Printf("Timestamp: %d ms\n", timestamp)

    fmt.Print("Press enter to exit.")
    fmt.Scanln()
}

Callback¶

Download (example_callback.go)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57

package main

import (
    "fmt"
    "github.com/Tinkerforge/go-api-bindings/ipconnection"
    "github.com/Tinkerforge/go-api-bindings/real_time_clock_bricklet"
)

const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your Real-Time Clock Bricklet.

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    rtc, _ := real_time_clock_bricklet.New(UID, &ipcon) // Create device object.

    ipcon.Connect(ADDR) // Connect to brickd.
    defer ipcon.Disconnect()
    // Don't use device before ipcon is connected.

    rtc.RegisterDateTimeCallback(func(year uint16, month uint8, day uint8, hour uint8, minute uint8, second uint8, centisecond uint8, weekday real_time_clock_bricklet.Weekday, timestamp int64) {
        fmt.Printf("Year: %d\n", year)
        fmt.Printf("Month: %d\n", month)
        fmt.Printf("Day: %d\n", day)
        fmt.Printf("Hour: %d\n", hour)
        fmt.Printf("Minute: %d\n", minute)
        fmt.Printf("Second: %d\n", second)
        fmt.Printf("Centisecond: %d\n", centisecond)

        if weekday == real_time_clock_bricklet.WeekdayMonday {
            fmt.Println("Weekday: Monday")
        } else if weekday == real_time_clock_bricklet.WeekdayTuesday {
            fmt.Println("Weekday: Tuesday")
        } else if weekday == real_time_clock_bricklet.WeekdayWednesday {
            fmt.Println("Weekday: Wednesday")
        } else if weekday == real_time_clock_bricklet.WeekdayThursday {
            fmt.Println("Weekday: Thursday")
        } else if weekday == real_time_clock_bricklet.WeekdayFriday {
            fmt.Println("Weekday: Friday")
        } else if weekday == real_time_clock_bricklet.WeekdaySaturday {
            fmt.Println("Weekday: Saturday")
        } else if weekday == real_time_clock_bricklet.WeekdaySunday {
            fmt.Println("Weekday: Sunday")
        }

        fmt.Printf("Timestamp: %d\n", timestamp)
        fmt.Println()
    })

    // Set period for date and time receiver to 5s (5000ms).
    // Note: The date and time callback is only called every 5 seconds
    //       if the date and time has changed since the last call!
    rtc.SetDateTimeCallbackPeriod(5000)

    fmt.Print("Press enter to exit.")
    fmt.Scanln()
}

Basic Functions¶

func real_time_clock_bricklet.New(uid string, ipcon *IPConnection) (device RealTimeClockBricklet, err error)¶

Parameters:	uid – Type: string ipcon – Type: *IPConnection
Returns:	device – Type: RealTimeClockBricklet err – Type: error

Creates a new RealTimeClockBricklet object with the unique device ID uid and adds it to the IPConnection ipcon:

device, err := real_time_clock_bricklet.New("YOUR_DEVICE_UID", &ipcon)

This device object can be used after the IPConnection has been connected.

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

Parameters:	year – Type: uint16, Range: [2000 to 2099] month – Type: uint8, Range: [1 to 12] day – Type: uint8, Range: [1 to 31] hour – Type: uint8, Range: [0 to 23] minute – Type: uint8, Range: [0 to 59] second – Type: uint8, Range: [0 to 59] centisecond – Type: uint8, Range: [0 to 99] weekday – Type: uint8, Range: See constants
Returns:	err – Type: 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.

The following constants are available for this function:

For weekday:

• real_time_clock_bricklet.WeekdayMonday = 1
• real_time_clock_bricklet.WeekdayTuesday = 2
• real_time_clock_bricklet.WeekdayWednesday = 3
• real_time_clock_bricklet.WeekdayThursday = 4
• real_time_clock_bricklet.WeekdayFriday = 5
• real_time_clock_bricklet.WeekdaySaturday = 6
• real_time_clock_bricklet.WeekdaySunday = 7

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

Returns:	year – Type: uint16, Range: [2000 to 2099] month – Type: uint8, Range: [1 to 12] day – Type: uint8, Range: [1 to 31] hour – Type: uint8, Range: [0 to 23] minute – Type: uint8, Range: [0 to 59] second – Type: uint8, Range: [0 to 59] centisecond – Type: uint8, Range: [0 to 99] weekday – Type: uint8, Range: See constants err – Type: error

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

The following constants are available for this function:

For weekday:

• real_time_clock_bricklet.WeekdayMonday = 1
• real_time_clock_bricklet.WeekdayTuesday = 2
• real_time_clock_bricklet.WeekdayWednesday = 3
• real_time_clock_bricklet.WeekdayThursday = 4
• real_time_clock_bricklet.WeekdayFriday = 5
• real_time_clock_bricklet.WeekdaySaturday = 6
• real_time_clock_bricklet.WeekdaySunday = 7

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

Returns:	timestamp – Type: int64, Unit: 1 ms, Range: [-263 to 263 - 1] err – Type: 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.

Advanced Functions¶

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

Parameters:	offset – Type: int8, Unit: 217/100 ppm, Range: [-128 to 127]
Returns:	err – Type: 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) GetOffset() (offset int8, err error)¶

Returns:	offset – Type: int8, Unit: 217/100 ppm, Range: [-128 to 127] err – Type: error

Returns the offset as set by SetOffset().

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

Returns:

uid – Type: string, Length: up to 8 connectedUid – Type: string, Length: up to 8 position – Type: rune, Range: ['a' to 'h', 'z'] hardwareVersion – Type: [3]uint8 0: major – Type: uint8, Range: [0 to 255] 1: minor – Type: uint8, Range: [0 to 255] 2: revision – Type: uint8, Range: [0 to 255] firmwareVersion – Type: [3]uint8 0: major – Type: uint8, Range: [0 to 255] 1: minor – Type: uint8, Range: [0 to 255] 2: revision – Type: uint8, Range: [0 to 255] deviceIdentifier – Type: uint16, Range: [0 to 216 - 1] err – Type: 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 is always at position 'z'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

Callback Configuration Functions¶

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

Parameters:	period – Type: uint32, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
Returns:	err – Type: error

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

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

New in version 2.0.1 (Plugin).

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

Returns:	period – Type: uint32, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 err – Type: error

Returns the period as set by SetDateTimeCallbackPeriod().

New in version 2.0.1 (Plugin).

func (*RealTimeClockBricklet) SetAlarm(month int8, day int8, hour int8, minute int8, second int8, weekday int8, interval int32) (err error)¶

Parameters:

month – Type: int8, Range: [-1, 1 to 12] with constants day – Type: int8, Range: [-1, 1 to 31] with constants hour – Type: int8, Range: [-1, 0 to 23] with constants minute – Type: int8, Range: [-1, 0 to 59] with constants second – Type: int8, Range: [-1, 0 to 59] with constants weekday – Type: int8, Range: [-1, 1 to 7] with constants interval – Type: int32, Unit: 1 s, Range: [-1, 1 to 231 - 1] with constants

Returns:

err – Type: error

Configures a repeatable alarm. The AlarmCallback 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.

The following constants are available for this function:

For month:

• real_time_clock_bricklet.AlarmMatchDisabled = -1

For day:

• real_time_clock_bricklet.AlarmMatchDisabled = -1

For hour:

• real_time_clock_bricklet.AlarmMatchDisabled = -1

For minute:

• real_time_clock_bricklet.AlarmMatchDisabled = -1

For second:

• real_time_clock_bricklet.AlarmMatchDisabled = -1

For weekday:

• real_time_clock_bricklet.AlarmMatchDisabled = -1

For interval:

• real_time_clock_bricklet.AlarmIntervalDisabled = -1

New in version 2.0.1 (Plugin).

func (*RealTimeClockBricklet) GetAlarm() (month int8, day int8, hour int8, minute int8, second int8, weekday int8, interval int32, err error)¶

Returns:

month – Type: int8, Range: [-1, 1 to 12] with constants day – Type: int8, Range: [-1, 1 to 31] with constants hour – Type: int8, Range: [-1, 0 to 23] with constants minute – Type: int8, Range: [-1, 0 to 59] with constants second – Type: int8, Range: [-1, 0 to 59] with constants weekday – Type: int8, Range: [-1, 1 to 7] with constants interval – Type: int32, Unit: 1 s, Range: [-1, 1 to 231 - 1] with constants err – Type: error

Returns the alarm configuration as set by SetAlarm().

The following constants are available for this function:

For month:

• real_time_clock_bricklet.AlarmMatchDisabled = -1

For day:

• real_time_clock_bricklet.AlarmMatchDisabled = -1

For hour:

• real_time_clock_bricklet.AlarmMatchDisabled = -1

For minute:

• real_time_clock_bricklet.AlarmMatchDisabled = -1

For second:

• real_time_clock_bricklet.AlarmMatchDisabled = -1

For weekday:

• real_time_clock_bricklet.AlarmMatchDisabled = -1

For interval:

• real_time_clock_bricklet.AlarmIntervalDisabled = -1

New in version 2.0.1 (Plugin).

Callbacks¶

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the corresponding Register*Callback function, which returns a unique callback ID. This ID can be used to deregister the callback later with the corresponding Deregister*Callback function.

func (*RealTimeClockBricklet) RegisterDateTimeCallback(func(year uint16, month uint8, day uint8, hour uint8, minute uint8, second uint8, centisecond uint8, weekday uint8, timestamp int64)) (registrationId uint64)¶

Callback Parameters:	year – Type: uint16, Range: [2000 to 2099] month – Type: uint8, Range: [1 to 12] day – Type: uint8, Range: [1 to 31] hour – Type: uint8, Range: [0 to 23] minute – Type: uint8, Range: [0 to 59] second – Type: uint8, Range: [0 to 59] centisecond – Type: uint8, Range: [0 to 99] weekday – Type: uint8, Range: See constants timestamp – Type: int64, Unit: 1 ms, Range: [-263 to 263 - 1]
Returns:	registrationId – Type: uint64

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

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

The following constants are available for this function:

For weekday:

• real_time_clock_bricklet.WeekdayMonday = 1
• real_time_clock_bricklet.WeekdayTuesday = 2
• real_time_clock_bricklet.WeekdayWednesday = 3
• real_time_clock_bricklet.WeekdayThursday = 4
• real_time_clock_bricklet.WeekdayFriday = 5
• real_time_clock_bricklet.WeekdaySaturday = 6
• real_time_clock_bricklet.WeekdaySunday = 7

New in version 2.0.1 (Plugin).

func (*RealTimeClockBricklet) RegisterAlarmCallback(func(year uint16, month uint8, day uint8, hour uint8, minute uint8, second uint8, centisecond uint8, weekday uint8, timestamp int64)) (registrationId uint64)¶

Callback Parameters:	year – Type: uint16, Range: [2000 to 2099] month – Type: uint8, Range: [1 to 12] day – Type: uint8, Range: [1 to 31] hour – Type: uint8, Range: [0 to 23] minute – Type: uint8, Range: [0 to 59] second – Type: uint8, Range: [0 to 59] centisecond – Type: uint8, Range: [0 to 99] weekday – Type: uint8, Range: See constants timestamp – Type: int64, Unit: 1 ms, Range: [-263 to 263 - 1]
Returns:	registrationId – Type: uint64

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

The following constants are available for this function:

For weekday:

• real_time_clock_bricklet.WeekdayMonday = 1
• real_time_clock_bricklet.WeekdayTuesday = 2
• real_time_clock_bricklet.WeekdayWednesday = 3
• real_time_clock_bricklet.WeekdayThursday = 4
• real_time_clock_bricklet.WeekdayFriday = 5
• real_time_clock_bricklet.WeekdaySaturday = 6
• real_time_clock_bricklet.WeekdaySunday = 7

New in version 2.0.1 (Plugin).

Virtual Functions¶

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

func (*RealTimeClockBricklet) GetAPIVersion() (apiVersion [3]uint8, err error)¶

Returns:	apiVersion – Type: [3]uint8 0: major – Type: uint8, Range: [0 to 255] 1: minor – Type: uint8, Range: [0 to 255] 2: revision – Type: uint8, Range: [0 to 255] err – Type: error

Returns the version of the API definition 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) GetResponseExpected(functionId uint8) (responseExpected bool, err error)¶

Parameters:	functionId – Type: uint8, Range: See constants
Returns:	responseExpected – Type: bool err – Type: 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.

The following constants are available for this function:

For functionId:

• real_time_clock_bricklet.FunctionSetDateTime = 1
• real_time_clock_bricklet.FunctionSetOffset = 4
• real_time_clock_bricklet.FunctionSetDateTimeCallbackPeriod = 6
• real_time_clock_bricklet.FunctionSetAlarm = 8

func (*RealTimeClockBricklet) SetResponseExpected(functionId uint8, responseExpected bool) (err error)¶

Parameters:	functionId – Type: uint8, Range: See constants responseExpected – Type: bool
Returns:	err – Type: 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.

The following constants are available for this function:

For functionId:

• real_time_clock_bricklet.FunctionSetDateTime = 1
• real_time_clock_bricklet.FunctionSetOffset = 4
• real_time_clock_bricklet.FunctionSetDateTimeCallbackPeriod = 6
• real_time_clock_bricklet.FunctionSetAlarm = 8

func (*RealTimeClockBricklet) SetResponseExpectedAll(responseExpected bool) (err error)¶

Parameters:	responseExpected – Type: bool
Returns:	err – Type: error

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

Constants¶

real_time_clock_bricklet.DeviceIdentifier¶

This constant is used to identify a Real-Time Clock Bricklet.

The GetIdentity() function and the (*IPConnection) RegisterEnumerateCallback callback of the IPConnection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

real_time_clock_bricklet.DeviceDisplayName¶

This constant represents the human readable name of a Real-Time Clock Bricklet.