Ce module offre une interface standardisée permettant de gérer les horloges temps réel matérielle ou logicielle. Une horloge temps réel entretient une heure et une date de façon permanente et peut suivant l'implémentation permettre de programmer des alarmes.
|
|
typedef struct xRtcTime | xRtcTime |
| | Structure Temps Permet le stockage d'une date et d'une heure.
|
| |
Ecrit la chaîne de caractères associée à une date sur stdout.
- Paramètres
-
| dest | pointeur vers le buffer qui contiendra le résultat DD/MM/YY |
- Renvoie
- le nombre de caractères écrits dans
dest, sans compter le caractère nul `\0' final.
- Exemples:
- rtc/demo_rtc.c.
Définition à la ligne 186 du fichier rtc.h.
Ecrit la chaîne de caractères associée à une heure sur stdout.
- Paramètres
-
| dest | pointeur vers le buffer qui contiendra le résultat HH:MM:SS |
- Renvoie
- le nombre de caractères écrits dans
dest, sans compter le caractère nul `\0' final.
- Exemples:
- rtc/demo_rtc.c.
Définition à la ligne 194 du fichier rtc.h.
Jours de la semaine Ces constantes permettent d'assigner un jour de la semaine
| Valeurs énumérées |
|---|
| MONDAY |
Lundi
|
| TUESDAY |
Mardi
|
| WEDNESDAY |
Mercredi
|
| THURSDAY |
Jeudi
|
| FRIDAY |
Vendredi
|
| SATURDAY |
Samedi
|
| SUNDAY |
Dimanche
|
Définition à la ligne 53 du fichier rtc.h.
| int iRtcDateToStr |
( |
char * |
pcStr, |
|
|
const xRtcTime * |
pxDate |
|
) |
| |
Renvoie la chaîne de caractères associée à une date.
- Paramètres
-
| dest | pointeur vers le buffer qui contiendra le résultat DD/MM/YY |
- Renvoie
- le nombre de caractères écrits dans
dest, sans compter le caractère nul `\0' final.
| int iRtcGetAlm |
( |
int8_t |
index, |
|
|
xRtcTime * |
pxTime |
|
) |
| |
Lecture d'une alarme.
- Paramètres
-
| index | index le l'alarme à lire |
| time | pointeur sur la date et l'heure de l'alarme |
- Renvoie
- 0 succès. -1 erreur
Lecture de l'horloge RTC.
- Paramètres
-
| time | pointeur sur la date et l'heure actuelle |
- Renvoie
- 0 succès. -1 erreur
- Exemples:
- rtc/demo_rtc.c.
| int iRtcInit |
( |
int |
iArg1 | ) |
|
Initialise le module RTC.
- Renvoie
- 0 succès. -1 erreur
- Exemples:
- rtc/demo_rtc.c.
| int iRtcPrintDateToStream |
( |
FILE * |
pxStream, |
|
|
const xRtcTime * |
pxDate |
|
) |
| |
Ecrit la chaîne de caractères associée à une date sur un flux.
- Paramètres
-
| dest | pointeur vers le buffer qui contiendra le résultat DD/MM/YY |
- Renvoie
- le nombre de caractères écrits dans
dest, sans compter le caractère nul `\0' final.
| int iRtcPrintTimeToStream |
( |
FILE * |
pxStream, |
|
|
const xRtcTime * |
pxTime |
|
) |
| |
Ecrit la chaîne de caractères associée à une heure sur un flux.
- Paramètres
-
| dest | pointeur vers le buffer qui contiendra le résultat HH:MM:SS |
- Renvoie
- le nombre de caractères écrits dans
dest, sans compter le caractère nul `\0' final.
| int iRtcSetAlm |
( |
int8_t |
index, |
|
|
const xRtcTime * |
pxTime |
|
) |
| |
Arme une alarme.
- Paramètres
-
| index | index le l'alarme à armer |
| time | pointeur sur la date et l'heure de l'alarme |
- Renvoie
- 0 succès. -1 erreur
| int iRtcSetTime |
( |
const xRtcTime * |
pxTime | ) |
|
Mets à l'heure de l'horloge RTC.
- Paramètres
-
| time | pointeur sur la nouvelle date et heure |
- Renvoie
- 0 succès. -1 erreur
- Exemples:
- rtc/demo_rtc.c.
| int iRtcTimeToStr |
( |
char * |
pcStr, |
|
|
const xRtcTime * |
pxTime |
|
) |
| |
Renvoie la chaîne de caractères associée à une heure.
- Paramètres
-
| dest | pointeur vers le buffer qui contiendra le résultat HH:MM:SS |
- Renvoie
- le nombre de caractères écrits dans
dest, sans compter le caractère nul `\0' final.
| const char* pcRtcWeekdayToStr |
( |
uint8_t |
wd | ) |
|
Renvoie la chaîne de caractères associée à un jour de la semaine.
- Paramètres
-
| wd | jour de la semaine rtcWeekDay |
- Renvoie
- la chaîne de caractères associée au jour de la semaine
| xMutex* pxRtcAlmMutex |
( |
int8_t |
index | ) |
|
Renvoie un pointeur sur le mutex de déclenchement d'une alarme.
- Paramètres
-
- Renvoie
- Le mutex renvoyé passe à 1 lors du déclenchement de l'alarme permettant à un processus en utilisant les fonctions
xMutexLock() ou xMutexTryLock()
| xMutex* pxRtcHeartBeatsMutex |
( |
void |
| ) |
|
Renvoie un pointeur sur le mutex indiquant la cadence des secondes.
- Renvoie
- Le mutex renvoyé passe à 1 à chaque seconde et permet de synchroniser un processus en utilisant les fonctions
xMutexLock() ou xMutexTryLock()
| bool xRtcYearIsLeap |
( |
int |
usYear | ) |
|
Indique si une année est bisextile.
- Paramètres
-
- Renvoie
- true si bisextile.
1.8.11