-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #29 from BlueAndi/dev
Documentation and cleaning
- Loading branch information
Showing
8 changed files
with
175 additions
and
249 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,105 @@ | ||
| /* MIT License | ||
| * | ||
| * Copyright (c) 2023 Andreas Merkle <[email protected]> | ||
| * | ||
| * 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. | ||
| */ | ||
|
|
||
| /******************************************************************************* | ||
| DESCRIPTION | ||
| *******************************************************************************/ | ||
| /** | ||
| * @brief Channel structure definition for the SerialMuxProt. | ||
| * @author Gabryel Reyes <[email protected]> | ||
| */ | ||
|
|
||
| #ifndef SERIAL_MUX_CHANNELS_H_ | ||
| #define SERIAL_MUX_CHANNELS_H_ | ||
|
|
||
| /****************************************************************************** | ||
| * Includes | ||
| *****************************************************************************/ | ||
|
|
||
| #include <Arduino.h> | ||
|
|
||
| /****************************************************************************** | ||
| * Macros | ||
| *****************************************************************************/ | ||
|
|
||
| /** Maximum number of SerialMuxProt Channels. */ | ||
| #define MAX_CHANNELS (10U) | ||
|
|
||
| /** Name of Channel to send Commands to. */ | ||
| #define COMMAND_CHANNEL_NAME "CMD" | ||
|
|
||
| /** DLC of Command Channel. */ | ||
| #define COMMAND_CHANNEL_DLC (sizeof(Command)) | ||
|
|
||
| /** Name of Channel to receive Command Responses from. */ | ||
| #define COMMAND_RESPONSE_CHANNEL_NAME "CMD_RSP" | ||
|
|
||
| /** DLC of Command Response Channel. */ | ||
| #define COMMAND_RESPONSE_CHANNEL_DLC (sizeof(CommandResponse)) | ||
|
|
||
| /** Name of Channel to send Motor Speed Setpoints to. */ | ||
| #define SPEED_SETPOINT_CHANNEL_NAME "SPEED_SET" | ||
|
|
||
| /** DLC of Speedometer Channel */ | ||
| #define SPEED_SETPOINT_CHANNEL_DLC (sizeof(SpeedData)) | ||
|
|
||
| /** Name of the Channel to receive Line Sensor Data from. */ | ||
| #define LINE_SENSOR_CHANNEL_NAME "LINE_SENS" | ||
|
|
||
| /** DLC of Line Sensor Channel */ | ||
| #define LINE_SENSOR_CHANNEL_DLC (sizeof(LineSensorData)) | ||
|
|
||
| /****************************************************************************** | ||
| * Types and Classes | ||
| *****************************************************************************/ | ||
|
|
||
| /** Struct of the "Command" channel payload. */ | ||
| typedef struct _Command | ||
| { | ||
| uint8_t commandId; | ||
| } __attribute__((packed)) Command; | ||
|
|
||
| /** Struct of the "Command Response" channel payload. */ | ||
| typedef struct _CommandResponse | ||
| { | ||
| uint8_t response; | ||
| } __attribute__((packed)) CommandResponse; | ||
|
|
||
| /** Struct of the "Speed" channel payload. */ | ||
| typedef struct _SpeedData | ||
| { | ||
| int16_t left; | ||
| int16_t right; | ||
| } __attribute__((packed)) SpeedData; | ||
|
|
||
| /** Struct of the "Line Sensor" channel payload. */ | ||
| typedef struct _LineSensorData | ||
| { | ||
| uint16_t lineSensorData[5U]; | ||
| } __attribute__((packed)) LineSensorData; | ||
|
|
||
| /****************************************************************************** | ||
| * Functions | ||
| *****************************************************************************/ | ||
|
|
||
| #endif /* SERIAL_MUX_CHANNELS_H_ */ |
Oops, something went wrong.