Loading...
Searching...
No Matches
feetech_writer.h
Go to the documentation of this file.
1/*
2 * Copyright (C) 2017 Inria
3 *
4 * This file is subject to the terms and conditions of the GNU Lesser General
5 * Public License v2.1. See the file LICENSE in the top level directory for more
6 * details.
7 */
8
9#pragma once
10
21
22#include "feetech_protocol.h"
23
24#include <stdint.h>
25#include <stdbool.h>
26#include <stdlib.h>
27
28#ifdef __cplusplus
29extern "C" {
30#endif
31
35typedef struct {
36 uint8_t *buffer;
37 size_t size;
40
48void feetech_writer_init(feetech_writer_t *writer, uint8_t *buffer, size_t buffer_max_size);
49
57const uint8_t *feetech_writer_get_data(const feetech_writer_t *writer);
58
67
76void feetech_writer_response_make(feetech_writer_t *writer, uint8_t id, const uint8_t *buffer, size_t size);
77
84void feetech_writer_ack_make(feetech_writer_t *writer, uint8_t id);
85
93
103void feetech_writer_write_make(feetech_writer_t *writer, uint8_t id, uint8_t reg, const uint8_t *buffer, size_t size);
104
113void feetech_writer_write8_make(feetech_writer_t *writer, uint8_t id, uint8_t reg, uint8_t value);
114
123void feetech_writer_write16_make(feetech_writer_t *writer, uint8_t id, uint8_t reg, uint16_t value);
124
133void feetech_writer_read_make(feetech_writer_t *writer, uint8_t id, uint8_t reg, size_t size);
134
142void feetech_writer_sync_write_begin(feetech_writer_t *writer, uint8_t reg, size_t size);
143
150
159void feetech_writer_sync_write_add(feetech_writer_t *writer, uint8_t id, const uint8_t *buffer, size_t size);
160
168void feetech_writer_sync_write_add_8bits(feetech_writer_t *writer, uint8_t id, uint8_t value);
169
177void feetech_writer_sync_write_add_16bits(feetech_writer_t *writer, uint8_t id, uint16_t value);
178
179#ifdef __cplusplus
180}
181#endif
182
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