Référence du fichier cart_proto.h

API d’encodage du protocole Cart Bus (inspiré du XVA1). Plus de détails...

#include <stddef.h>
#include <stdint.h>

Aller au code source de ce fichier.

Fonctions
size_t	cart_proto_build_set (uint16_t param, uint8_t value, uint8_t out[4])
	Construit une trame “set param value” prête à envoyer sur UART.
size_t	cart_proto_build_get (uint16_t param, uint8_t out[4])
	Construit une trame “get param” prête à envoyer sur UART.

Description détaillée

API d’encodage du protocole Cart Bus (inspiré du XVA1).

Fournit les fonctions d’encodage des trames UART pour le protocole Cart Bus, dérivé du protocole historique XVA1. Compatible avec toute cartouche utilisant la même structure d’adressage de paramètres.

Documentation des fonctions

cart_proto_build_get()

size_t cart_proto_build_get	(	uint16_t	param,
		uint8_t	out[4]
	)

Construit une trame “get param” prête à envoyer sur UART.

Paramètres

param	Identifiant du paramètre à lire (0–511)
out	Buffer de sortie (min. 4 octets)

Renvoie

Taille de la trame (2 ou 3 octets)

Construit une trame “get param” prête à envoyer sur UART.

Encode la commande dans un buffer out[] au format du protocole Cart Bus :

• Si param < 255 → ‘'g’ param<tt>(2 octets)
• Siparam >= 255→'g' 255 (param-256)` (3 octets)

Paramètres

param	Identifiant du paramètre à lire (0–511)
out	Buffer de sortie (min. 4 octets)

Renvoie

Taille de la trame (2 ou 3 octets)

cart_proto_build_set()

size_t cart_proto_build_set	(	uint16_t	param,
		uint8_t	value,
		uint8_t	out[4]
	)

Construit une trame “set param value” prête à envoyer sur UART.

Paramètres

param	Identifiant du paramètre (0–511)
value	Valeur à envoyer (0–255)
out	Buffer de sortie (min. 4 octets)

Renvoie

Taille de la trame (3 ou 4 octets)

Construit une trame “set param value” prête à envoyer sur UART.

Encode la commande dans un buffer out[] au format du protocole Cart Bus :

• Si param < 255 → trame courte (‘'s’ param value, 3 octets)
• Siparam >= 255→ trame étendue ('s' 255 (param-256) value`, 4 octets)

Paramètres

param	Identifiant du paramètre (0–511)
value	Valeur à envoyer (0–255)
out	Buffer de sortie (min. 4 octets)

Renvoie

Taille de la trame (3 ou 4 octets)