Skip to content

Commit

Permalink
Fixed documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
gabryelreyes committed Nov 22, 2023
1 parent 6d2189e commit f144226
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 7 deletions.
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ typedef union _Frame
/** Channel ID */
uint8_t m_channel;

/** Channel ID */
/** Channel DLC */
uint8_t m_dlc;

/** Frame Checksum */
Expand Down Expand Up @@ -100,15 +100,13 @@ typedef union _Frame
- The Application can publish or subscribe to any of these channels using the channel's name.
- Client suscribes to a channel using [Channel 0](#control-channel-channel-0).

#### DLC Field
#### Data Length Code (DLC) Field

- Contains the size of the payload contained by the frame.

#### Checksum Field

- Simple Checksum.
- Applied to previous fields.
- checksum = sum(Channel + Data Bytes) % UINT8_MAX
- checksum = sum(Channel + DLC + Data Bytes) % UINT8_MAX

### Payload Field

Expand Down
4 changes: 2 additions & 2 deletions examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ The following example is written for testing the SerialMuxProt with two microcon
## Installation

- Install the library, depending on your IDE.
- Compile `main.cpp` from SideA and flash it onto the first board.
- Compile `main.cpp` from SideB and flash it onto the second board.
- Compile `main.cpp` from ServerA and flash it onto the first board.
- Compile `main.cpp` from ServerB and flash it onto the second board.
- Connect the UART peripherals of both boards with each other:
- Rx from Board 1 with Tx from Board 2
- Tx from Board 1 with Rx from Board 2
Expand Down

0 comments on commit f144226

Please sign in to comment.