DYNAMIXEL Driver 0.1.0
API reference
Loading...
Searching...
No Matches
Classes | Namespaces
dynamixel.hpp File Reference

DYNAMIXEL driver: the one header to include. More...

#include <algorithm>
#include <array>
#include <cstddef>
#include <cstdint>
#include <span>
#include "dynamixel_detail.hpp"
#include "dynamixel_protocol.hpp"
#include "dynamixel_tables.hpp"
#include "dynamixel_types.hpp"
#include "dynamixel_uart_interface.hpp"
#include "dynamixel_version.h"
#include "../src/dynamixel.ipp"

Go to the source code of this file.

Classes

class  dynamixel::DYNAMIXEL< Port, FrameBytes >
 Master of one DYNAMIXEL bus on a platform port. More...
 

Namespaces

namespace  dynamixel
 The DYNAMIXEL driver: everything it declares lives here; internals in detail.
 

Detailed Description

DYNAMIXEL driver: the one header to include.

dynamixel::DYNAMIXEL<Port> is the bus master of a DYNAMIXEL servo bus: protocol 1.0 or 2.0 over a half-duplex UART, through a platform port you write (see dynamixel_uart_interface.hpp). The driver has no platform code, allocates nothing, throws nothing, takes no lock and is not thread-safe: give each object one owner, or guard it with one mutex. Every call blocks until its reply is complete or the configured timeouts have passed (docs/architecture.md explains why there is no polling API).

Instruction coverage: Ping, Read, Write, Reg Write, Action, Factory Reset, Reboot, Clear, Control Table Backup, Sync Read, Sync Write, Fast Sync Read, Bulk Read, Bulk Write and Fast Bulk Read (docs/protocol.md has the table with the protocol each instruction needs).