rtcst

Documentation

Overview

Package rtcst implements tickless system timer using real time clock/counter. RTC system timer uses up to 20 bytes from first backup registers to preserve its state. 8 bytes are used to implement rtos.Nanosec. If SetTime function is used to set current calendar time, a further 12 bytes are used to preserve RTC start time.

Index

• func ISR()
• func SetTime(t time.Time, ns int64)
• func Setup(freqHz uint)
• func Status() (ok, set bool)

Functions

func ISR

func ISR()

ISR should be set as irq.RTCAlarm interrupt handler.

func SetTime

func SetTime(t time.Time, ns int64)

SetTime works like time.Set but also updates RTC.

func Setup

func Setup(freqHz uint)

Stetup setups RTC as system timer using LSE as clock source. FreqHz should be set to LSE frequency.

func Status

func Status() (ok, set bool)

Status returns status of RTC. Ok informs whether RTC is configured and works properly, set informs whether callendar time was set.