API Documentation

Usage of this Page

This page is intended for the developers of the communication protocol that will enable our interfacing microcontrollers to speak to our computers (both onboard and shoreside).

It describes the message structure to be followed and defines an exhaustive set of commands that are used to communicate between devices. Further, each command has an inherent payload structure for each direction of data transfer which is also described here.

Development of this page is being discussed in this issue.

Table of Contents

1. Protocol Syntax

• Message Structure
• Start Indicator Byte
• Command Number Byte
• Payload
• CRC-16 Checksum

2. Wireless Communication Commands

• 0x00 - Reset Wireless Module
• 0x01 - Set Wireless Configuration
• 0x02 - Get Wireless Configuration
• 0x03 - Wireless Receive
• 0x04 - Wireless Transmit

3. Propulsion Module Commands

• 0x10 - Reset Propulsion Module
• 0x11 - Set Propulsion Configuration
• 0x12 - Get Propulsion Configuration
• 0x13 - Set Motor Speeds