MATLAB/Octave - Real-Time Clock Bricklet

This is the description of the MATLAB/Octave API bindings for the Real-Time Clock Bricklet. General information and technical specifications for the Real-Time Clock Bricklet are summarized in its hardware description.

An installation guide for the MATLAB/Octave API bindings is part of their general description.

Examples

The example code below is Public Domain (CC0 1.0).

Simple (MATLAB)

Download (matlab_example_simple.m)

 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
function matlab_example_simple()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletRealTimeClock;

    HOST = 'localhost';
    PORT = 4223;
    UID = 'XYZ'; % Change XYZ to the UID of your Real-Time Clock Bricklet

    ipcon = IPConnection(); % Create IP connection
    rtc = handle(BrickletRealTimeClock(UID, ipcon), 'CallbackProperties'); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % Get current date and time
    dateTime = rtc.getDateTime();

    fprintf('Year: %i\n', dateTime.year);
    fprintf('Month: %i\n', dateTime.month);
    fprintf('Day: %i\n', dateTime.day);
    fprintf('Hour: %i\n', dateTime.hour);
    fprintf('Minute: %i\n', dateTime.minute);
    fprintf('Second: %i\n', dateTime.second);
    fprintf('Centisecond: %i\n', dateTime.centisecond);

    if dateTime.weekday == BrickletRealTimeClock.WEEKDAY_MONDAY
        fprintf('Weekday: Monday\n');
    elseif dateTime.weekday == BrickletRealTimeClock.WEEKDAY_TUESDAY
        fprintf('Weekday: Tuesday\n');
    elseif dateTime.weekday == BrickletRealTimeClock.WEEKDAY_WEDNESDAY
        fprintf('Weekday: Wednesday\n');
    elseif dateTime.weekday == BrickletRealTimeClock.WEEKDAY_THURSDAY
        fprintf('Weekday: Thursday\n');
    elseif dateTime.weekday == BrickletRealTimeClock.WEEKDAY_FRIDAY
        fprintf('Weekday: Friday\n');
    elseif dateTime.weekday == BrickletRealTimeClock.WEEKDAY_SATURDAY
        fprintf('Weekday: Saturday\n');
    elseif dateTime.weekday == BrickletRealTimeClock.WEEKDAY_SUNDAY
        fprintf('Weekday: Sunday\n');
    end

    % Get current timestamp
    timestamp = rtc.getTimestamp();
    fprintf('Timestamp: %i ms\n', timestamp);

    input('Press key to exit\n', 's');
    ipcon.disconnect();
end

Callback (MATLAB)

Download (matlab_example_callback.m)

 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
function matlab_example_callback()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletRealTimeClock;

    HOST = 'localhost';
    PORT = 4223;
    UID = 'XYZ'; % Change XYZ to the UID of your Real-Time Clock Bricklet

    ipcon = IPConnection(); % Create IP connection
    rtc = handle(BrickletRealTimeClock(UID, ipcon), 'CallbackProperties'); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % Register date and time callback to function cb_date_time
    set(rtc, 'DateTimeCallback', @(h, e) cb_date_time(e));

    % Set period for date and time callback 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);

    input('Press key to exit\n', 's');
    ipcon.disconnect();
end

% Callback function for date and time callback
function cb_date_time(e)
    fprintf('Year: %i\n', e.year);
    fprintf('Month: %i\n', e.month);
    fprintf('Day: %i\n', e.day);
    fprintf('Hour: %i\n', e.hour);
    fprintf('Minute: %i\n', e.minute);
    fprintf('Second: %i\n', e.second);
    fprintf('Centisecond: %i\n', e.centisecond);

    if e.weekday == com.tinkerforge.BrickletRealTimeClock.WEEKDAY_MONDAY
        fprintf('Weekday: Monday\n');
    elseif e.weekday == com.tinkerforge.BrickletRealTimeClock.WEEKDAY_TUESDAY
        fprintf('Weekday: Tuesday\n');
    elseif e.weekday == com.tinkerforge.BrickletRealTimeClock.WEEKDAY_WEDNESDAY
        fprintf('Weekday: Wednesday\n');
    elseif e.weekday == com.tinkerforge.BrickletRealTimeClock.WEEKDAY_THURSDAY
        fprintf('Weekday: Thursday\n');
    elseif e.weekday == com.tinkerforge.BrickletRealTimeClock.WEEKDAY_FRIDAY
        fprintf('Weekday: Friday\n');
    elseif e.weekday == com.tinkerforge.BrickletRealTimeClock.WEEKDAY_SATURDAY
        fprintf('Weekday: Saturday\n');
    elseif e.weekday == com.tinkerforge.BrickletRealTimeClock.WEEKDAY_SUNDAY
        fprintf('Weekday: Sunday\n');
    end

    fprintf('Timestamp: %i\n', e.timestamp);
    fprintf('\n');
end

Simple (Octave)

Download (octave_example_simple.m)

 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
function octave_example_simple()
    more off;

    HOST = "localhost";
    PORT = 4223;
    UID = "XYZ"; % Change XYZ to the UID of your Real-Time Clock Bricklet

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    rtc = javaObject("com.tinkerforge.BrickletRealTimeClock", UID, ipcon); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % Get current date and time
    dateTime = rtc.getDateTime();

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

    if java2int(dateTime.weekday) == 1
        fprintf("Weekday: Monday\n");
    elseif java2int(dateTime.weekday) == 2
        fprintf("Weekday: Tuesday\n");
    elseif java2int(dateTime.weekday) == 3
        fprintf("Weekday: Wednesday\n");
    elseif java2int(dateTime.weekday) == 4
        fprintf("Weekday: Thursday\n");
    elseif java2int(dateTime.weekday) == 5
        fprintf("Weekday: Friday\n");
    elseif java2int(dateTime.weekday) == 6
        fprintf("Weekday: Saturday\n");
    elseif java2int(dateTime.weekday) == 7
        fprintf("Weekday: Sunday\n");
    end

    % Get current timestamp
    timestamp = rtc.getTimestamp();
    fprintf("Timestamp: %d ms\n", java2int(timestamp));

    input("Press key to exit\n", "s");
    ipcon.disconnect();
end

function int = java2int(value)
    if compare_versions(version(), "3.8", "<=")
        int = value.intValue();
    else
        int = value;
    end
end

Callback (Octave)

Download (octave_example_callback.m)

 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
58
59
60
61
62
function octave_example_callback()
    more off;

    HOST = "localhost";
    PORT = 4223;
    UID = "XYZ"; % Change XYZ to the UID of your Real-Time Clock Bricklet

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    rtc = javaObject("com.tinkerforge.BrickletRealTimeClock", UID, ipcon); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % Register date and time callback to function cb_date_time
    rtc.addDateTimeCallback(@cb_date_time);

    % Set period for date and time callback 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);

    input("Press key to exit\n", "s");
    ipcon.disconnect();
end

% Callback function for date and time callback
function cb_date_time(e)
    fprintf("Year: %d\n", e.year);
    fprintf("Month: %d\n", java2int(e.month));
    fprintf("Day: %d\n", java2int(e.day));
    fprintf("Hour: %d\n", java2int(e.hour));
    fprintf("Minute: %d\n", java2int(e.minute));
    fprintf("Second: %d\n", java2int(e.second));
    fprintf("Centisecond: %d\n", java2int(e.centisecond));

    if java2int(e.weekday) == 1
        fprintf("Weekday: Monday\n");
    elseif java2int(e.weekday) == 2
        fprintf("Weekday: Tuesday\n");
    elseif java2int(e.weekday) == 3
        fprintf("Weekday: Wednesday\n");
    elseif java2int(e.weekday) == 4
        fprintf("Weekday: Thursday\n");
    elseif java2int(e.weekday) == 5
        fprintf("Weekday: Friday\n");
    elseif java2int(e.weekday) == 6
        fprintf("Weekday: Saturday\n");
    elseif java2int(e.weekday) == 7
        fprintf("Weekday: Sunday\n");
    end

    fprintf("Timestamp: %d\n", java2int(e.timestamp));
    fprintf("\n");
end

function int = java2int(value)
    if compare_versions(version(), "3.8", "<=")
        int = value.intValue();
    else
        int = value;
    end
end

API

Generally, every method of the MATLAB bindings that returns a value can throw a TimeoutException. This exception gets thrown if the device did not respond. If a cable based connection is used, it is unlikely that this exception gets thrown (assuming nobody unplugs the device). However, if a wireless connection is used, timeouts will occur if the distance to the device gets too big.

Beside the TimeoutException there is also a NotConnectedException that is thrown if a method needs to communicate with the device while the IP Connection is not connected.

Since the MATLAB bindings are based on Java and Java does not support multiple return values and return by reference is not possible for primitive types, we use small classes that only consist of member variables. The member variables of the returned objects are described in the corresponding method descriptions.

The package for all Brick/Bricklet bindings and the IP Connection is com.tinkerforge.*

All methods listed below are thread-safe.

Basic Functions

class BrickletRealTimeClock(String uid, IPConnection ipcon)
Parameters:
  • uid – Type: String
  • ipcon – Type: IPConnection
Returns:
  • realTimeClock – Type: BrickletRealTimeClock

Creates an object with the unique device ID uid.

In MATLAB:

import com.tinkerforge.BrickletRealTimeClock;

realTimeClock = BrickletRealTimeClock('YOUR_DEVICE_UID', ipcon);

In Octave:

realTimeClock = java_new("com.tinkerforge.BrickletRealTimeClock", "YOUR_DEVICE_UID", ipcon);

This object can then be used after the IP Connection is connected (see examples above).

void BrickletRealTimeClock.setDateTime(int year, short month, short day, short hour, short minute, short second, short centisecond, short weekday)
Parameters:
  • year – Type: int, Range: [2000 to 2099]
  • month – Type: short, Range: [1 to 12]
  • day – Type: short, Range: [1 to 31]
  • hour – Type: short, Range: [0 to 23]
  • minute – Type: short, Range: [0 to 59]
  • second – Type: short, Range: [0 to 59]
  • centisecond – Type: short, Range: [0 to 99]
  • weekday – Type: short, Range: See constants

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:

  • BrickletRealTimeClock.WEEKDAY_MONDAY = 1
  • BrickletRealTimeClock.WEEKDAY_TUESDAY = 2
  • BrickletRealTimeClock.WEEKDAY_WEDNESDAY = 3
  • BrickletRealTimeClock.WEEKDAY_THURSDAY = 4
  • BrickletRealTimeClock.WEEKDAY_FRIDAY = 5
  • BrickletRealTimeClock.WEEKDAY_SATURDAY = 6
  • BrickletRealTimeClock.WEEKDAY_SUNDAY = 7
BrickletRealTimeClock.DateTime BrickletRealTimeClock.getDateTime()
Return Object:
  • year – Type: int, Range: [2000 to 2099]
  • month – Type: short, Range: [1 to 12]
  • day – Type: short, Range: [1 to 31]
  • hour – Type: short, Range: [0 to 23]
  • minute – Type: short, Range: [0 to 59]
  • second – Type: short, Range: [0 to 59]
  • centisecond – Type: short, Range: [0 to 99]
  • weekday – Type: short, Range: See constants

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:

  • BrickletRealTimeClock.WEEKDAY_MONDAY = 1
  • BrickletRealTimeClock.WEEKDAY_TUESDAY = 2
  • BrickletRealTimeClock.WEEKDAY_WEDNESDAY = 3
  • BrickletRealTimeClock.WEEKDAY_THURSDAY = 4
  • BrickletRealTimeClock.WEEKDAY_FRIDAY = 5
  • BrickletRealTimeClock.WEEKDAY_SATURDAY = 6
  • BrickletRealTimeClock.WEEKDAY_SUNDAY = 7
long BrickletRealTimeClock.getTimestamp()
Returns:
  • timestamp – Type: long, Unit: 1 ms, Range: [-263 to 263 - 1]

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

void BrickletRealTimeClock.setOffset(byte offset)
Parameters:
  • offset – Type: byte, Unit: 217/100 ppm, Range: [-128 to 127]

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.

byte BrickletRealTimeClock.getOffset()
Returns:
  • offset – Type: byte, Unit: 217/100 ppm, Range: [-128 to 127]

Returns the offset as set by setOffset().

short[] BrickletRealTimeClock.getAPIVersion()
Return Object:
  • apiVersion – Type: short[], Length: 3
    • 1: major – Type: short, Range: [0 to 255]
    • 2: minor – Type: short, Range: [0 to 255]
    • 3: revision – Type: short, Range: [0 to 255]

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.

boolean BrickletRealTimeClock.getResponseExpected(short functionId)
Parameters:
  • functionId – Type: short, Range: See constants
Returns:
  • responseExpected – Type: boolean

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 send and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For functionId:

  • BrickletRealTimeClock.FUNCTION_SET_DATE_TIME = 1
  • BrickletRealTimeClock.FUNCTION_SET_OFFSET = 4
  • BrickletRealTimeClock.FUNCTION_SET_DATE_TIME_CALLBACK_PERIOD = 6
  • BrickletRealTimeClock.FUNCTION_SET_ALARM = 8
void BrickletRealTimeClock.setResponseExpected(short functionId, boolean responseExpected)
Parameters:
  • functionId – Type: short, Range: See constants
  • responseExpected – Type: boolean

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 send and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For functionId:

  • BrickletRealTimeClock.FUNCTION_SET_DATE_TIME = 1
  • BrickletRealTimeClock.FUNCTION_SET_OFFSET = 4
  • BrickletRealTimeClock.FUNCTION_SET_DATE_TIME_CALLBACK_PERIOD = 6
  • BrickletRealTimeClock.FUNCTION_SET_ALARM = 8
void BrickletRealTimeClock.setResponseExpectedAll(boolean responseExpected)
Parameters:
  • responseExpected – Type: boolean

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

BrickletRealTimeClock.Identity BrickletRealTimeClock.getIdentity()
Return Object:
  • uid – Type: String, Length: up to 8
  • connectedUid – Type: String, Length: up to 8
  • position – Type: char, Range: ['a' to 'h', 'i', 'z']
  • hardwareVersion – Type: short[], Length: 3
    • 1: major – Type: short, Range: [0 to 255]
    • 2: minor – Type: short, Range: [0 to 255]
    • 3: revision – Type: short, Range: [0 to 255]
  • firmwareVersion – Type: short[], Length: 3
    • 1: major – Type: short, Range: [0 to 255]
    • 2: minor – Type: short, Range: [0 to 255]
    • 3: revision – Type: short, Range: [0 to 255]
  • deviceIdentifier – Type: int, Range: [0 to 216 - 1]

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). The Raspberry Pi HAT (Zero) Brick is always at position 'i' and the Bricklet connected to an Isolator Bricklet is always as 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

void BrickletRealTimeClock.setDateTimeCallbackPeriod(long period)
Parameters:
  • period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

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).

long BrickletRealTimeClock.getDateTimeCallbackPeriod()
Returns:
  • period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by setDateTimeCallbackPeriod().

New in version 2.0.1 (Plugin).

void BrickletRealTimeClock.setAlarm(byte month, byte day, byte hour, byte minute, byte second, byte weekday, int interval)
Parameters:
  • month – Type: byte, Range: [-1, 2000 to 2099] with constants
  • day – Type: byte, Range: [-1, 1 to 12] with constants
  • hour – Type: byte, Range: [-1, 1 to 31] with constants
  • minute – Type: byte, Range: [-1 to 23] with constants
  • second – Type: byte, Range: [-1 to 59] with constants
  • weekday – Type: byte, Range: [-1 to 59] with constants
  • interval – Type: int, Unit: 1 s, Range: See constants

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:

  • BrickletRealTimeClock.ALARM_MATCH_DISABLED = -1

For day:

  • BrickletRealTimeClock.ALARM_MATCH_DISABLED = -1

For hour:

  • BrickletRealTimeClock.ALARM_MATCH_DISABLED = -1

For minute:

  • BrickletRealTimeClock.ALARM_MATCH_DISABLED = -1

For second:

  • BrickletRealTimeClock.ALARM_MATCH_DISABLED = -1

For weekday:

  • BrickletRealTimeClock.ALARM_MATCH_DISABLED = -1

For interval:

  • BrickletRealTimeClock.ALARM_INTERVAL_DISABLED = -1

New in version 2.0.1 (Plugin).

BrickletRealTimeClock.Alarm BrickletRealTimeClock.getAlarm()
Return Object:
  • month – Type: byte, Range: [-1, 2000 to 2099] with constants
  • day – Type: byte, Range: [-1, 1 to 12] with constants
  • hour – Type: byte, Range: [-1, 1 to 31] with constants
  • minute – Type: byte, Range: [-1 to 23] with constants
  • second – Type: byte, Range: [-1 to 59] with constants
  • weekday – Type: byte, Range: [-1 to 59] with constants
  • interval – Type: int, Unit: 1 s, Range: See constants

Returns the alarm configuration as set by setAlarm().

The following constants are available for this function:

For month:

  • BrickletRealTimeClock.ALARM_MATCH_DISABLED = -1

For day:

  • BrickletRealTimeClock.ALARM_MATCH_DISABLED = -1

For hour:

  • BrickletRealTimeClock.ALARM_MATCH_DISABLED = -1

For minute:

  • BrickletRealTimeClock.ALARM_MATCH_DISABLED = -1

For second:

  • BrickletRealTimeClock.ALARM_MATCH_DISABLED = -1

For weekday:

  • BrickletRealTimeClock.ALARM_MATCH_DISABLED = -1

For interval:

  • BrickletRealTimeClock.ALARM_INTERVAL_DISABLED = -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 "set" function of MATLAB. The parameters consist of the IP Connection object, the callback name and the callback function. For example, it looks like this in MATLAB:

function my_callback(e)
    fprintf('Parameter: %s\n', e.param);
end

set(device, 'ExampleCallback', @(h, e) my_callback(e));

Due to a difference in the Octave Java support the "set" function cannot be used in Octave. The registration is done with "add*Callback" functions of the device object. It looks like this in Octave:

function my_callback(e)
    fprintf("Parameter: %s\n", e.param);
end

device.addExampleCallback(@my_callback);

It is possible to add several callbacks and to remove them with the corresponding "remove*Callback" function.

The parameters of the callback are passed to the callback function as fields of the structure e, which is derived from the java.util.EventObject class. The available callback names with corresponding structure fields are described below.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

callback BrickletRealTimeClock.DateTimeCallback
Event Object:
  • year – Type: int, Range: [2000 to 2099]
  • month – Type: short, Range: [1 to 12]
  • day – Type: short, Range: [1 to 31]
  • hour – Type: short, Range: [0 to 23]
  • minute – Type: short, Range: [0 to 59]
  • second – Type: short, Range: [0 to 59]
  • centisecond – Type: short, Range: [0 to 99]
  • weekday – Type: short, Range: See constants
  • timestamp – Type: long, Unit: 1 ms, Range: [-263 to 263 - 1]

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 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:

  • BrickletRealTimeClock.WEEKDAY_MONDAY = 1
  • BrickletRealTimeClock.WEEKDAY_TUESDAY = 2
  • BrickletRealTimeClock.WEEKDAY_WEDNESDAY = 3
  • BrickletRealTimeClock.WEEKDAY_THURSDAY = 4
  • BrickletRealTimeClock.WEEKDAY_FRIDAY = 5
  • BrickletRealTimeClock.WEEKDAY_SATURDAY = 6
  • BrickletRealTimeClock.WEEKDAY_SUNDAY = 7

New in version 2.0.1 (Plugin).

In MATLAB the set() function can be used to register a callback function to this callback.

In Octave a callback function can be added to this callback using the addDateTimeCallback() function. An added callback function can be removed with the removeDateTimeCallback() function.

callback BrickletRealTimeClock.AlarmCallback
Event Object:
  • year – Type: int, Range: [2000 to 2099]
  • month – Type: short, Range: [1 to 12]
  • day – Type: short, Range: [1 to 31]
  • hour – Type: short, Range: [0 to 23]
  • minute – Type: short, Range: [0 to 59]
  • second – Type: short, Range: [0 to 59]
  • centisecond – Type: short, Range: [0 to 99]
  • weekday – Type: short, Range: See constants
  • timestamp – Type: long, Unit: 1 ms, Range: [-263 to 263 - 1]

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.

The following constants are available for this function:

For weekday:

  • BrickletRealTimeClock.WEEKDAY_MONDAY = 1
  • BrickletRealTimeClock.WEEKDAY_TUESDAY = 2
  • BrickletRealTimeClock.WEEKDAY_WEDNESDAY = 3
  • BrickletRealTimeClock.WEEKDAY_THURSDAY = 4
  • BrickletRealTimeClock.WEEKDAY_FRIDAY = 5
  • BrickletRealTimeClock.WEEKDAY_SATURDAY = 6
  • BrickletRealTimeClock.WEEKDAY_SUNDAY = 7

New in version 2.0.1 (Plugin).

In MATLAB the set() function can be used to register a callback function to this callback.

In Octave a callback function can be added to this callback using the addAlarmCallback() function. An added callback function can be removed with the removeAlarmCallback() function.

Constants

int BrickletRealTimeClock.DEVICE_IDENTIFIER

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

The getIdentity() function and the IPConnection.EnumerateCallback callback of the IP Connection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

String BrickletRealTimeClock.DEVICE_DISPLAY_NAME

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