Matt Briggs
Fork to see if I can get working
Dependencies: BufferedSerial OneWire WinbondSPIFlash libxDot-dev-mbed5-deprecated
Fork of
xDotBridge_update_test20180823
by 
Matt Briggs
Diff: xDotBridge/README.md
- Revision:
- 67:2115a2f1b945
- Parent:
- 62:9751a8504c82
--- a/xDotBridge/README.md Wed Mar 15 11:46:40 2017 -0600
+++ b/xDotBridge/README.md Tue Mar 21 13:04:31 2017 -0600
@@ -1,5 +1,5 @@
# xDotBridge Documentation {#mainpage}
-# Introduction
+## Introduction
This project is intended to support multiple products including Wireless
Bridge, MTS comm board, and camera comm board. The stretch goal of using a
single binary and intuiting all the different configurations. At a minimum it
@@ -87,29 +87,24 @@
TODO
#### Brute force alert message
-==============================================
-= Offset | Size (in Bytes) | Name =
-==============================================
-= 0x00 | 2 Bytes | Alert Msg Flag (0xEF10) =
-==============================================
-= 0x02 | 8 Bytes | xDot EUI =
-==============================================
-= 0x0A | 2 Bytes | Alert Data =
-==============================================
-= 0x0C | 4 Bytes | Alert Sequence Number =
-==============================================
+
+ Offset | Size (in Bytes) | Name
+------- | --------------- |-----------------
+ 0x00 | 2 Bytes | Alert Msg Flag (0xEF10)
+ 0x02 | 8 Bytes | xDot EUI
+ 0x0A | 2 Bytes | Alert Data
+ 0x0C | 4 Bytes | Alert Sequence Number
+
Total of 16 bytes
#### Brute force pair request message
-==============================================
-= Offset | Size (in Bytes) | Name =
-==============================================
-= 0x00 | 2 Bytes | Pair Request Flag (0xFE01)=
-==============================================
-= 0x02 | 8 Bytes | xDot EUI (requester) =
-==============================================
-= 0x0A | 6 Bytes | Reserved =
-==============================================
+
+ Offset | Size (in Bytes) | Name
+------- | --------------- |-----------------
+ 0x00 | 2 Bytes | Pair Request Flag (0xFE01)
+ 0x02 | 8 Bytes | xDot EUI (requester)
+ 0x0A | 6 Bytes | Reserved
+
* Total of 16 Bytes
Ideas for reserved:
@@ -117,21 +112,16 @@
* Messages generated
#### Brute force pair accept message
-==============================================
-= Offset | Size (in Bytes) | Name =
-==============================================
-= 0x00 | 2 Bytes | Pair Accept Flag (0xFD02) =
-==============================================
-= 0x02 | 8 Bytes | xDot EUI (RX Master) =
-==============================================
-= 0x0A | 4 Bytes | Reserved for Frequency =
-==============================================
-= 0x0E | 4 Bytes | Network Address =
-==============================================
-= 0x12 | 16 Bytes | Network Session Key =
-==============================================
-= 0x22 | 16 Bytes | Data session Key =
-==============================================
+
+ Offset | Size (in Bytes) | Name
+------- | --------------- | -----------------
+ 0x00 | 2 Bytes | Pair Accept Flag (0xFD02)
+ 0x02 | 8 Bytes | xDot EUI (RX Master)
+ 0x0A | 4 Bytes | Reserved for Frequency
+ 0x0E | 4 Bytes | Network Address
+ 0x12 | 16 Bytes | Network Session Key
+ 0x22 | 16 Bytes | Data session Key
+
* Total of 34 Bytes
## Peer to Peer Pair
@@ -192,44 +182,31 @@
* ULC
## Protocol Parameters
-==============================================
-= Dot Relative Addr | Size (in Bytes) | Name =
-==============================================
-= 0x1000 | 02 Bytes | Protocol Flag =
-==============================================
-= 0x1002 | 02 Bytes | Protocol Rev =
-==============================================
-= 0x1004 | 04 Bytes | Reserved for Frequency =
-==============================================
-= 0x1008 | 04 Bytes | Network Address =
-==============================================
-= 0x1010 | 16 Bytes | Network Session Key =
-==============================================
-= 0x1020 | 16 Bytes | Data Session Key =
-==============================================
-= 0x1030 | 02 Bytes | Logical Address Serial =
-==============================================
-= 0x1032 | 04 Bytes | Last Message SeqNum =
-==============================================
-Space needed is 54 bytes. Spaced used is 50 bytes
+
+ Dot Relative Addr | Size (in Bytes) | Name
+ ----------------- | --------------- | ---------
+ 0x1000 | 02 Bytes | Protocol Flag
+ 0x1002 | 02 Bytes | Protocol Rev
+ 0x1004 | 04 Bytes | Reserved for Frequency
+ 0x1008 | 04 Bytes | Network Address
+ 0x1010 | 16 Bytes | Network Session Key
+ 0x1020 | 16 Bytes | Data Session Key
+ 0x1030 | 02 Bytes | Logical Address Serial
+ 0x1032 | 04 Bytes | Last Message SeqNum
+
+Space needed is 50 bytes. Spaced used is 54 bytes
for better word alignment.
## IO Baseboard Parameters
-==============================================
-= Dot Relative Addr | Size (in Bytes) | Name =
-==============================================
-= 0x1100 | 2 Bytes | Baseboard Flag =
-==============================================
-= 0x1102 | 2 Bytes | Baseboard Rev =
-==============================================
-= 0x1104 | 2 Bytes | Baseboard Serial =
-==============================================
-= 0x1106 | 2 Bytes | Baseboard Configuration =
-==============================================
-= 0x1110 | 8 Bytes | PortEx0 64 bit ROM Addr =
-==============================================
-= 0x1118 | 8 Bytes | PortEx1 64 bit ROM Addr =
-==============================================
+
+ Dot Relative Addr | Size (in Bytes) | Name
+ ----------------- | --------------- | ---------
+ 0x1100 | 2 Bytes | Baseboard Flag
+ 0x1102 | 2 Bytes | Baseboard Rev
+ 0x1104 | 2 Bytes | Baseboard Serial
+ 0x1106 | 2 Bytes | Baseboard Configuration
+ 0x1110 | 8 Bytes | PortEx0 64 bit ROM Addr
+ 0x1118 | 8 Bytes | PortEx1 64 bit ROM Addr
Space needed is 24 bytes. Space used is 32 bytes.