From 7d3c283918e4c89a627a5dc4e1e9575e858005f7 Mon Sep 17 00:00:00 2001 From: xtof Date: Mon, 21 Feb 2022 12:05:10 +0100 Subject: [PATCH 01/11] Upload New File --- SPECIFICATIONS/FailsafeMode.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 SPECIFICATIONS/FailsafeMode.md diff --git a/SPECIFICATIONS/FailsafeMode.md b/SPECIFICATIONS/FailsafeMode.md new file mode 100644 index 0000000..e95b673 --- /dev/null +++ b/SPECIFICATIONS/FailsafeMode.md @@ -0,0 +1,26 @@ + +| Last modification | Status | +|-------------------- |--------- | +| 21/02/2022 | Draft | + + +# Failsafe mode + +## scope + +When the board start or if a reset is received, the software goes in failsafe mode. Only telemetry is sent. All other functionality of the Spino card is on idle mode or power off. + +## Communication mode + +- Failsafe FSK 2400bd modulation + +After communications to the community via WEBsite and Twitter, other modulations will be tested..) + + +## Usage + +### system reset (Service Message) + +### setting of modulations used (Service Message) + +### activation / deactivation of a beacon mode and periodicity (Service Message) \ No newline at end of file -- GitLab From b1bb1ad7f3998417cca02d5da121fde5b7efcfef Mon Sep 17 00:00:00 2001 From: xtof Date: Mon, 21 Feb 2022 12:06:57 +0100 Subject: [PATCH 02/11] Upload New File --- SPECIFICATIONS/MailboxMode.md | 79 +++++++++++++++++++++++++++++++++++ 1 file changed, 79 insertions(+) create mode 100644 SPECIFICATIONS/MailboxMode.md diff --git a/SPECIFICATIONS/MailboxMode.md b/SPECIFICATIONS/MailboxMode.md new file mode 100644 index 0000000..3b69cfb --- /dev/null +++ b/SPECIFICATIONS/MailboxMode.md @@ -0,0 +1,79 @@ +| Last modification | Status | +|-------------------- |--------- | +| 21/02/2022 | Draft | + +# Short message mailbox mode + +## Scope + +Allows to the users to create a temporary dedicated mailbox to a user and allow him to store short messages for other users + + +## Maibox Capability + +- up to 64 mailbox available in the same time (64 users) +- up to 16 messages per mailboxes +- Message size limited to 242 bytes (message limited to 242 bytes (dest_call_7_bytes + ref_count_7_bytes + 242 = 256) +- Automatic setup of a new mailbox when an unknown destination station is assessed +- Automatic expiration of messages after 72h +- Automatic expiration of users as soon as the mailbox is empty +- Messages are managed like a FIFO stack + +## Usage + +### Sending a message + +Scenario to send a message (AX25 header ignored, the considered protocol layer is encapsulated in the payload): +The "ARSxyz" station sends a message to the "ARSuvw" station +-> sending "ARSxyz" station identified by its call in the AX25 header +-> AX25 payload consisting of : call destination station + reference counter + message (424 bytes max) +<- ACK from SPINO (or NACK : limit of the destination mailbox exceeded, or impossible to create a new mailbox) + + + +### viewing the list of messages of a box + +- (list of 16 messages identified by sender and number) + + +### viewing a message + +(identified by its number) + +### delete a message + +(identified by its number) + +### viewing the list of active mailboxes + +- viewing the list of active mailboxes (list of max 64 active mailboxes at a given time) + + +### flush of mailboxes (Service Message) + + + +## Activation + +- +- based on AX25 protocol +- Service message (protected by a private key as head of the payload) are read/write of configuration registers allowing : + + + + + + + + + + + + + + + + + + + -- GitLab From c608b28ca10da3afee6d300737ab861e53a3a51b Mon Sep 17 00:00:00 2001 From: xtof Date: Mon, 21 Feb 2022 13:51:02 +0100 Subject: [PATCH 03/11] Upload New File --- SPECIFICATIONS/States.md | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 SPECIFICATIONS/States.md diff --git a/SPECIFICATIONS/States.md b/SPECIFICATIONS/States.md new file mode 100644 index 0000000..83999a5 --- /dev/null +++ b/SPECIFICATIONS/States.md @@ -0,0 +1,9 @@ + +| Last modification | Status | +|-------------------- |--------- | +| 21/02/2022 | Draft | + + +# States diagram + +![State diagram](./States.svg) \ No newline at end of file -- GitLab From 6c49ce53154af0c69d5ee0bce9122aad6aea2b49 Mon Sep 17 00:00:00 2001 From: xtof Date: Mon, 21 Feb 2022 13:51:26 +0100 Subject: [PATCH 04/11] Upload New File --- SPECIFICATIONS/States.svg | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 SPECIFICATIONS/States.svg diff --git a/SPECIFICATIONS/States.svg b/SPECIFICATIONS/States.svg new file mode 100644 index 0000000..f0eee17 --- /dev/null +++ b/SPECIFICATIONS/States.svg @@ -0,0 +1,4 @@ + + + +

Failsafe

Failsafe

Short Message Mailbox

Short Message Mailbox

Digital Transponder

Digital Transponder
MailBoxCommande
MailBoxCommande
TransponderCommande
TransponderCommande
TranspondeurCommandeOFF
TranspondeurCommandeOFF
PowerOn
PowerOnText is not SVG - cannot display \ No newline at end of file -- GitLab From acd893821fc4b10da4287b7b5097ce6f663aa969 Mon Sep 17 00:00:00 2001 From: xtof Date: Mon, 21 Feb 2022 13:58:11 +0100 Subject: [PATCH 05/11] Update States.md --- SPECIFICATIONS/States.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/SPECIFICATIONS/States.md b/SPECIFICATIONS/States.md index 83999a5..c627a5b 100644 --- a/SPECIFICATIONS/States.md +++ b/SPECIFICATIONS/States.md @@ -1,4 +1,3 @@ - | Last modification | Status | |-------------------- |--------- | | 21/02/2022 | Draft | @@ -6,4 +5,7 @@ # States diagram -![State diagram](./States.svg) \ No newline at end of file +![State diagram](./States.svg) + +- [Failsafe Mode](.Failsafe.md) +- \ No newline at end of file -- GitLab From 3366c7900509566f14520586fd74780bcd5b3207 Mon Sep 17 00:00:00 2001 From: xtof Date: Mon, 21 Feb 2022 13:59:29 +0100 Subject: [PATCH 06/11] Update States.md --- SPECIFICATIONS/States.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/SPECIFICATIONS/States.md b/SPECIFICATIONS/States.md index c627a5b..fec039a 100644 --- a/SPECIFICATIONS/States.md +++ b/SPECIFICATIONS/States.md @@ -7,5 +7,5 @@ ![State diagram](./States.svg) -- [Failsafe Mode](.Failsafe.md) +- [Failsafe Mode](./Failsafe.md) - \ No newline at end of file -- GitLab From a6af1dc5a2a574de22ee7cf30278166bd35d88f2 Mon Sep 17 00:00:00 2001 From: xtof Date: Tue, 22 Feb 2022 22:15:22 +0100 Subject: [PATCH 07/11] Upload New File --- ...rt_message_mailbox_messages_description.md | 30 +++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 SPECIFICATIONS/Short_message_mailbox_messages_description.md diff --git a/SPECIFICATIONS/Short_message_mailbox_messages_description.md b/SPECIFICATIONS/Short_message_mailbox_messages_description.md new file mode 100644 index 0000000..400299a --- /dev/null +++ b/SPECIFICATIONS/Short_message_mailbox_messages_description.md @@ -0,0 +1,30 @@ +| Last modification | Status | +|-------------------- |--------- | +| 22/02/2022 | Draft | + +# Short message mailbox messages description + + + +## Command message +### AX25 UI Frame +| Flag | Destination Calssign | Destination SSID | Source Address | Source SSID | Control Bits | Protocol | Mailbox commandes | Mailbox Parameters | Frame Check Sequence | Flag | +|------|----------------------|-------------------|----------------|--------------|-------------|----------|-------------------|-------------------|-----------------------------|------| +| 8 | 48 | 8 | 48 | 8 | 8 | 8 | 8 | 0-242 | 16 | 8 | + +#### Commands + + + +| Command Name | Commande value | parameters | comment | +|:-----------------------------:|:--------------:|:--------------------------------------------------------:|:-------:| +| Add Message | 0 | Message contents [0-242] bytes | | +| Delette message | 1 | Mailbox Name : (Callsign) 6 byte | | +| | | Message ID : 1 byte | | +| Delette mailbox | 2 | Mailbox Name : (Callsign) 6 byte | | +| List all mailbox | 3 | | | +| List all message in a mailbox | 4 | Mailbox Name : (Callsign) 6 byte | | +| Flush all mailbox | 5 | secure word : 4 bytes | | +| | | | | + + -- GitLab From 2a630060cdde77314fe82bab2cd5669d4d868b0f Mon Sep 17 00:00:00 2001 From: xtof Date: Tue, 22 Feb 2022 22:15:59 +0100 Subject: [PATCH 08/11] Upload New File --- SPECIFICATIONS/AX25_Usage_on_Spino.md | 83 +++++++++++++++++++++++++++ 1 file changed, 83 insertions(+) create mode 100644 SPECIFICATIONS/AX25_Usage_on_Spino.md diff --git a/SPECIFICATIONS/AX25_Usage_on_Spino.md b/SPECIFICATIONS/AX25_Usage_on_Spino.md new file mode 100644 index 0000000..7ded5d4 --- /dev/null +++ b/SPECIFICATIONS/AX25_Usage_on_Spino.md @@ -0,0 +1,83 @@ +| Last modification | Status | +|-------------------- |--------- | +| 22/02/2022 | Draft | + +# AX25 Usage on Spino +## References +### Applicable document +(AX.25 Protocol Specification) [http://www.tapr.org/pdf/AX25.2.2.pdf] +## AX25 : unnumbered frame +### Description +As described in the protocol, the unnumbered frame (U frame) is structured as follows : + +| Flag | Address | Control | Info | FCS | Flag | +|----------|---------|---------|------|-----|----------| +| 01111110 | 112 | 16 | N*8 | 16 | 01111110 | + +In the spino use, the frame is used as : + +| Flag | Destination Address | Source Address | Control Bits | Protocol | Information Field | Frame Check Sequence | Flag | +|------|----------------------|----------------|--------------|----------|-------------------|-----------------------|------| +| 8 | 56 | 56 | 8 | 8 | 0-2048 | 16 | 8 | + + +#### Flag + +The flag field is one octet long. Because the flag delimits frames, it occurs at both the beginning and end of each frame. Two frames may share one flag, which would denote the end of the first frame and the start of the next frame. +A flag consists of a zero followed by six ones followed by another zero, or 01111110 (0x7E). + +In order to ensure that the flag bit sequence mentioned above does not appear accidentally anywhere else in a frame, bit stuffing is applied. The sender monitors the bit sequence for a group of five or more contiguous '1' bits. Any time five contiguous '1' bits are sent, the sending station inserts a '0' bit after the fifth '1' bit. During frame reception, any time five contiguous '1' bits are received, a '0' bit immediately following five '1' bits is discarded. + +### Source - Destination address +Adress consists of the callsign and the Secondary Station Identifier (SSID). +The callsign is made up of 6 upper-case letters, numbers or space ASCII characters only (7 bits). +The SSID is a four-bit integer that uniquely identifies multiple stations using the same amateur callsign + +The 6 characters of the callsign are placed in the first 6 octets of the field (C1 to C6). Each character bits are shifted one bit on the left and the least significant bit is set to '0'. The SSID is placed in the bits 3-6. The other bits of the field have a fixed value +#### Control Bits (8 bits) +The control field identifies the type of frame being passed and controls several attributes of the Layer 2 connection. For an AX.25 Unnumbered Information Frame, its value is always 00000011 (0x03). +#### Protocol Identifier (8 bits) +Shall be 11110000 (0xF0) + +### Frame-Check Sequence (16 bits) +The Frame-Check Sequence is a 16-bit number calculated by both the sender and the receiver of a frame. It ensures that the frame was not corrupted by the transmission medium. The Frame-Check Sequence is a CRC calculated using polynomial x16 + x12 + x5 + 1 (also +called CRC-CITT + +### Information Field (0 to 2048 bits) + +The Information Field contains the data specific to the usage of the AX.25 Transfer Frame. +The maximum size of the Information Field is 2048 bits. + +## SPINO usage + +Spino allows two usages : +- Hamradio experimentation +- Telecomand/telemetry management for satellite + +#### Hamradio experimentation + + A dedicated callsign is defined for Hamradio experimentation. + If the associated capability of the spino is not active all packet with the correponding SSID are droped + + | SSID | Usage | Comments | link to the description | +|------|-----------------------|---------------------------------------------------------------------|-------------------------| +| 0 | Not used | | | +| 1 | Telemetry | used for Spino telemetry | | +| 2 | Short message mailbox | Used for Short message mailbox capability | | +| 3 | | | | +| 4 | | | | +| 5 | | | | +| 6 | | | | +| 7 | | | | +| 8 | | | | +| 9 | | | | +| 10 | | | | +| 11 | | | | +| 12 | | | | +| 13 | | | | +| 14 | | | | +| 15 | SPINO TM/TC | Reserved to team in charge of Spino experiment (Command & Control) | | + +#### Telecomand/telemetry management for satellite + +TBD -- GitLab From 70f973c1dcf1036dbafa3b3dccb481b20289fe82 Mon Sep 17 00:00:00 2001 From: xtof Date: Tue, 22 Feb 2022 22:20:38 +0100 Subject: [PATCH 09/11] Update States.md --- SPECIFICATIONS/States.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/SPECIFICATIONS/States.md b/SPECIFICATIONS/States.md index fec039a..6efb6a9 100644 --- a/SPECIFICATIONS/States.md +++ b/SPECIFICATIONS/States.md @@ -7,5 +7,5 @@ ![State diagram](./States.svg) -- [Failsafe Mode](./Failsafe.md) +- [Failsafe Mode](./FailsafeMode.md) - \ No newline at end of file -- GitLab From 9812e5189781e07a3e7b6cc4d7e2e8879cd4d429 Mon Sep 17 00:00:00 2001 From: xtof Date: Tue, 22 Feb 2022 22:24:50 +0100 Subject: [PATCH 10/11] Upload New File --- SPECIFICATIONS/README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 SPECIFICATIONS/README.md diff --git a/SPECIFICATIONS/README.md b/SPECIFICATIONS/README.md new file mode 100644 index 0000000..9f3e257 --- /dev/null +++ b/SPECIFICATIONS/README.md @@ -0,0 +1,14 @@ + + +# Summary + +## Mode + +- [Spino Mode and state] (./States.md) +- [Failsafe Mode](./FailsafeMode.md) +- [Short Message Mailbox Mode](./MailboxMode.md) + +## Messages + +- [AX25 Usage on Spino](./AX25_Usage_on_Spino.md) +- [Short message Mailbox messages] (./Short_message_mailbox_messages_description.md) -- GitLab From c3e96aaf8d931e39f914adef67a24219077de04a Mon Sep 17 00:00:00 2001 From: xtof Date: Tue, 22 Feb 2022 22:25:29 +0100 Subject: [PATCH 11/11] Update README.md --- SPECIFICATIONS/README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/SPECIFICATIONS/README.md b/SPECIFICATIONS/README.md index 9f3e257..18fd767 100644 --- a/SPECIFICATIONS/README.md +++ b/SPECIFICATIONS/README.md @@ -1,14 +1,13 @@ - # Summary ## Mode -- [Spino Mode and state] (./States.md) +- [Spino Mode and state](./States.md) - [Failsafe Mode](./FailsafeMode.md) - [Short Message Mailbox Mode](./MailboxMode.md) ## Messages - [AX25 Usage on Spino](./AX25_Usage_on_Spino.md) -- [Short message Mailbox messages] (./Short_message_mailbox_messages_description.md) +- [Short message Mailbox messages](./Short_message_mailbox_messages_description.md) -- GitLab