Loading...
Searching...
No Matches
feetech_writer.h
Go to the documentation of this file.
1/*
2 * SPDX-FileCopyrightText: 2017 Inria
3 * SPDX-License-Identifier: LGPL-2.1-only
4 */
5
6#pragma once
7
18
19#include "feetech_protocol.h"
20
21#include <stdint.h>
22#include <stdbool.h>
23#include <stdlib.h>
24
25#ifdef __cplusplus
26extern "C" {
27#endif
28
32typedef struct {
33 uint8_t *buffer;
34 size_t size;
37
45void feetech_writer_init(feetech_writer_t *writer, uint8_t *buffer, size_t buffer_max_size);
46
54const uint8_t *feetech_writer_get_data(const feetech_writer_t *writer);
55
64
73void feetech_writer_response_make(feetech_writer_t *writer, uint8_t id, const uint8_t *buffer, size_t size);
74
81void feetech_writer_ack_make(feetech_writer_t *writer, uint8_t id);
82
90
100void feetech_writer_write_make(feetech_writer_t *writer, uint8_t id, uint8_t reg, const uint8_t *buffer, size_t size);
101
110void feetech_writer_write8_make(feetech_writer_t *writer, uint8_t id, uint8_t reg, uint8_t value);
111
120void feetech_writer_write16_make(feetech_writer_t *writer, uint8_t id, uint8_t reg, uint16_t value);
121
130void feetech_writer_read_make(feetech_writer_t *writer, uint8_t id, uint8_t reg, size_t size);
131
139void feetech_writer_sync_write_begin(feetech_writer_t *writer, uint8_t reg, size_t size);
140
147
156void feetech_writer_sync_write_add(feetech_writer_t *writer, uint8_t id, const uint8_t *buffer, size_t size);
157
165void feetech_writer_sync_write_add_8bits(feetech_writer_t *writer, uint8_t id, uint8_t value);
166
174void feetech_writer_sync_write_add_16bits(feetech_writer_t *writer, uint8_t id, uint16_t value);
175
176#ifdef __cplusplus
177}
178#endif
179
Feetech protocol definitions.
void feetech_writer_write16_make(feetech_writer_t *writer, uint8_t id, uint8_t reg, uint16_t value)
Build a WRITE packet (16 bits)
void feetech_writer_sync_write_end(feetech_writer_t *writer)
End the building of a SYNC_WRITE packet.
void feetech_writer_sync_write_add_8bits(feetech_writer_t *writer, uint8_t id, uint8_t value)
Add an item to a SYNC_WRITE packet (8 bits)
void feetech_writer_response_make(feetech_writer_t *writer, uint8_t id, const uint8_t *buffer, size_t size)
Build a response packet.
void feetech_writer_sync_write_add(feetech_writer_t *writer, uint8_t id, const uint8_t *buffer, size_t size)
Add an item to a SYNC_WRITE packet.
void feetech_writer_write_make(feetech_writer_t *writer, uint8_t id, uint8_t reg, const uint8_t *buffer, size_t size)
Build a WRITE packet.
size_t feetech_writer_get_size(const feetech_writer_t *writer)
Get the data buffer's size to send.
void feetech_writer_sync_write_begin(feetech_writer_t *writer, uint8_t reg, size_t size)
Begin to build a SYNC_WRITE packet.
void feetech_writer_ack_make(feetech_writer_t *writer, uint8_t id)
Build an ack packet.
void feetech_writer_ping_make(feetech_writer_t *writer, uint8_t id)
Build a PING packet.
void feetech_writer_read_make(feetech_writer_t *writer, uint8_t id, uint8_t reg, size_t size)
Build a READ packet.
const uint8_t * feetech_writer_get_data(const feetech_writer_t *writer)
Get the data buffer to send.
void feetech_writer_init(feetech_writer_t *writer, uint8_t *buffer, size_t buffer_max_size)
Initialize the Feetech packet writer.
void feetech_writer_write8_make(feetech_writer_t *writer, uint8_t id, uint8_t reg, uint8_t value)
Build a WRITE packet (8 bits)
void feetech_writer_sync_write_add_16bits(feetech_writer_t *writer, uint8_t id, uint16_t value)
Add an item to a SYNC_WRITE packet (16 bits)
Feetech packet writer struct.
uint8_t * buffer
data buffer
size_t size
packet's size
size_t buffer_max_size
data buffer's size