From 44f74859551988b74cd1f94a9159e4b6b5348147 Mon Sep 17 00:00:00 2001 From: Wojciech Kaczmarski <44336093+sp5wwp@users.noreply.github.com> Date: Sat, 13 Aug 2022 10:53:33 +0200 Subject: [PATCH] Update README.md --- README.md | 49 +++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 45 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 01a65f4..c742888 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,49 @@ # M17_spec -Protocol specification for the [M17 Project](http://m17project.org/). +[M17 Project](http://m17project.org/) is a modern, digital radio protocol built by hams, for hams. +This repository contains the specification describing it exhaustively, from top to bottom. It is still a work in progress, meaning that this repository is meant to be updated now and then. After a few years of development, almost all of the changes are just to supplement the specification with new functions or improve the document. -M17 is a modern, digital radio protocol built by hams, for hams. -It is still a work in progress, and this is the living specification of the protocol. +The specification can be conveniently browsed [here](https://spec.m17project.org/). -The specification can be viewed [here](https://spec.m17project.org/). +# Table of contents +**Part I - Air Interface** +* M17 RF Protocol: Summary +* Glossary +* Physical Layer + * 4FSK generation + * Preamble + * Bit types + * Error correction coding schemes and bit type conversion +* Data Link Layer + * Stream Mode + * Packet Mode + * BERT Mode +* Application Layer + * Amateur Radio Voice Application + * Packet Application + +**Part II - Internet Interface** +* M17 Internet Protocol (IP) Networking + * Standard IP Framing + * Control Packets + +**Appendix** +* Address Encoding + * Callsign Encoding: base40 + * Callsign Formats +* Randomizer sequence +* Convolutional Encoder +* Golay Encoder +* Code Puncturing +* Interleaving +* BERT Details +* KISS Protocol + * References + * Glossary + * M17 Protocols + * KISS Basics + * Packet Protocols + * Stream Protocol + * Mixing Modes + * Implementation Details +* File Formats