Clock Commands

clock-alarm-display

Displays all alarms and their status.

Usage:

clock-alarm-display

clock-alarm-free

Clears existing alarm.

Usage:

clock-alarm-free

clock-alarm-set

Sets alarm to specific time.

Usage:

clock-alarm-set hour/ms_post_12am [minute] [second] [recur_type_id]
Parameter Description
hour/ms_post_12am The hour that the alarm should fire (0-23) or milliseconds after midnight.
[minute] The minute that the alarm should fire (0-59, default: 0).
[second] Optional second that the alarm should fire (0-59, default: 0)
[recur_type_id] Optional recur type. (default: 0 (one-shot))

clock-alarm-set-rel

Sets an alarm N milliseconds in the future.

Usage:

clock-alarm-set-rel ms_til_alarm [recur_type_id]
Parameter Description
ms_til_alarm Milliseconds until the alarm fires (max: 604,800,000 (7days)).
[recur_type_id] Optional recur type. (default: 0 (one-shot))

clock-alarm-type-display

Displays all recurring alarm types.

Usage:

clock-alarm-type-display

clock-display

Displays the system date/time.

Usage:

clock-display

clock-set

Sets the system date/time.

Usage:

clock-set year month day ms_since_midnight
Parameter Description
year 4-digit representation of year to set (min 1980).
month Numeric month to set (1-12).
day Numeric day to set (1-31).
ms_since_midnight Time to set, specified in milliseconds since midnight.

clock-timer-display

Displays all timers and their status.

Usage:

clock-timer-display

clock-timer-free

Stops a running timer.

Usage:

clock-timer-free timer_id
Parameter Description
timer_id The timer id of the running timer to stop. (0-255)

clock-timer-set

Sets a timer N milliseconds in the future.

Usage:

clock-timer-set timer_id ms_til [recur_num]
Parameter Description
timer_id The timer id of the timer to set. There can be a max of 8 running timers.
ms_till Milliseconds until the timer fires (max: 604,800,000 (7days), 0: fire immediately)
[recur_num] Optional number of times the timer should recur. (-1: recur indefinitely, default: 0)

Clock Timers

The Aurora provides 8 distinct timers that can be used simultaneously. When setting a timer, specify a unique id in the range of 0-255 to be used later to disarm or reset that particular timer. The clock-timer-set command will fail if there are already 8 running timers with distinct ids.

Clock Alarm Recur Types

When setting an alarm, it's possible to specify a recur type which allows the alarm to repeat when a particular time match occurs. For instance, if the alarm is set to 9:30am and a "MINUTE" recur type is used, the alarm won't just fire at 9:30am, but on every half hour mark. (i.e. 8:30am, 10:30am, etc).

Id Recur Type Description
0 ONETIME Alarm only fires a single time and is then disarmed.
1 SECOND Alarm fires any time the alarm time seconds match the clock seconds.
2 MINUTE Alarm fires any time the alarm time minutes match the clock minutes.
3 HOURLY Alarm fires any time the alarm time hour matches the clock hour.
4 DAILY Alarm fires any time the alarm day matches the clock day.

results matching ""

    No results matching ""