IRIS Communications Protocol - Version 1.0

Intra-Rocket Interface System

Overview

This document provides information about the IRIS Communications Protocol, version 1.0. The IRIS Protocol is establishes a command and control interface used to allow communications between nodes within a rocket.

Table of Contents

1. Features
2. Installation
3. Usage
4. Message Format
5. Examples
6. Contributing
7. License

Features

• Efficient Data Transfer: Optimized for minimal bandwidth usage and low-latency communication.
• Reliability: Implements error detection and correction mechanisms to ensure reliable data transmission.
• Scalability: Designed to accommodate a growing number of devices in a network.
• Flexibility: Adaptable to various communication scenarios and use cases.

Installation

To use the IRIS Communications Protocol in your project, follow these steps: Using SSH:
git clone [email protected]:s-park21/IRIS.git
Using HTTPS:
git clone https://github.com/s-park21/IRIS.git

Usage

Packet encoding:

1. Define payload struct and fill with relevent data
2. Define meta data fields
3. Fill buffer with data
4. Calculate 32-bit CRC
5. Transmit data

Packet decoding:

1. Receive incoming data into buffer
2. TODO: Add the other steps

Message Format

TODO: Add image of message format

Examples

STM32 Implementation

Contributing

1. Make proposed changes to protocol specification document
2. Make pull request
3. Make changes to header files
4. Make pull request

License

MIT License

Copyright (c) [2024] [Angus McLennan]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.