Skip to content

Commit 5be294d

Browse files
xchrishawkxchrishawk
committed
Update configuration.cmake for consistency with documentation.
1 parent a4c046b commit 5be294d

2 files changed

Lines changed: 48 additions & 36 deletions

File tree

‎configuration.cmake‎

Lines changed: 45 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,21 @@
66
# @date 2025-08-19
77
# @cpyrt © 2025 by Chris Vig. Licensed under the GNU General Public License v3 (GPLv3).
88
#
9+
# @details
10+
# This file defines the various configuration options for the application's build. This allows enabling and disabling
11+
# features, changing configuration defaults, setting device pinout, etc. In most cases, this file should not be
12+
# modified - instead, modify `build/CMakeCache.txt` (once the build system has been initialized) to make any
13+
# modifications required.
14+
#
15+
# @note
16+
# Please update the Developer's Guide if anything in this file changes.
17+
#
918

1019
# -- Feature Enablement --
1120

1221
# Define values
1322
set(FEATURE_ENABLE_DEBUG_PORT _FEATURE_ON
14-
CACHE STRING "Set to _FEATURE_ON to enable the debug port.")
23+
CACHE STRING "Set to _FEATURE_OFF to omit the debug port from the build.")
1524

1625
# Set compile definitions
1726
add_compile_definitions(
@@ -22,9 +31,9 @@ add_compile_definitions(
2231

2332
# Define values
2433
set(FEATURE_OPT_INTF_PORT_BAUD USART_BAUD_19200
25-
CACHE STRING "Baud rate for interface port. (usart_baud_t)")
34+
CACHE STRING "Baud rate for the interface serial port. (usart_baud_t)")
2635
set(FEATURE_OPT_DEBUG_PORT_BAUD USART_BAUD_19200
27-
CACHE STRING "Baud rate for debug port. (usart_baud_t)")
36+
CACHE STRING "Baud rate for the debug serial port. (usart_baud_t)")
2837

2938
# Set compile definitions
3039
add_compile_definitions(
@@ -36,53 +45,53 @@ add_compile_definitions(
3645

3746
# Define values
3847
set(CONFIG_DFLT_WPM 20.0f
39-
CACHE STRING "Default words per minute. (1.0f - 100.0f)")
48+
CACHE STRING "Default words-per-minute setting. (wpm_t)")
4049
set(CONFIG_DFLT_WPM_ELEMENT_SCALE 1.0f
41-
CACHE STRING "Default Morse code element scale. (0.1f - 10.f)")
50+
CACHE STRING "Default element scale for all Morse code elements. (wpm_element_scale_t)")
4251
set(CONFIG_DFLT_BUZZER_ENABLED true
43-
CACHE STRING "Should the buzzer be enabled by default? (true / false)")
52+
CACHE STRING "Is buzzer enabled by default? (bool)")
4453
set(CONFIG_DFLT_BUZZER_FREQUENCY 700
45-
CACHE STRING "The default buzzer frequency, in Hz. (500 - 2000 Hz)")
54+
CACHE STRING "Default buzzer frequency, in Hz. (buzzer_freq_t)")
4655
set(CONFIG_DFLT_LED_STATUS_ENABLED true
47-
CACHE STRING "Is the status LED enabled? (true / false)")
56+
CACHE STRING "Is the status LED enabled by default? (bool)")
4857
set(CONFIG_DFLT_LED_KEY_ENABLED true
49-
CACHE STRING "Is the key LED enabled? (true / false)")
58+
CACHE STRING "Is the keyer LED enabled by default? (bool)")
5059
set(CONFIG_DFLT_IO_TYPE_TRS_0_TIP IO_TYPE_INPUT_STRAIGHT_KEY
51-
CACHE STRING "I/O type for the tip of TRS 0. (io_type_t)")
60+
CACHE STRING "I/O type for the tip pin of TRS connector 0. (io_type_t)")
5261
set(CONFIG_DFLT_IO_POLARITY_TRS_0_TIP IO_POLARITY_ACTIVE_LOW
53-
CACHE STRING "I/O polarity for the tip of TRS 0. (io_polarity_t)")
62+
CACHE STRING "I/O polarity for the tip pin of TRS connector 0. (io_polarity_t)")
5463
set(CONFIG_DFLT_IO_TYPE_TRS_0_RING IO_TYPE_NONE
55-
CACHE STRING "I/O type for the ring of TRS 0. (io_type_t)")
64+
CACHE STRING "I/O type for the ring pin of TRS connector 0. (io_type_t)")
5665
set(CONFIG_DFLT_IO_POLARITY_TRS_0_RING IO_POLARITY_ACTIVE_LOW
57-
CACHE STRING "I/O polarity for the ring of TRS 0. (io_polarity_t)")
66+
CACHE STRING "I/O polarity for the ring pin of TRS connector 0. (io_polarity_t)")
5867
set(CONFIG_DFLT_IO_TYPE_TRS_1_TIP IO_TYPE_INPUT_PADDLE_LEFT
59-
CACHE STRING "I/O type for the tip of TRS 1. (io_type_t)")
68+
CACHE STRING "I/O type for the tip pin of TRS connector 1. (io_type_t)")
6069
set(CONFIG_DFLT_IO_POLARITY_TRS_1_TIP IO_POLARITY_ACTIVE_LOW
61-
CACHE STRING "I/O polarity for the tip of TRS 1. (io_polarity_t)")
70+
CACHE STRING "I/O polarity for the tip pin of TRS connector 1. (io_polarity_t)")
6271
set(CONFIG_DFLT_IO_TYPE_TRS_1_RING IO_TYPE_INPUT_PADDLE_RIGHT
63-
CACHE STRING "I/O type for the ring of TRS 1. (io_type_t)")
72+
CACHE STRING "I/O type for the ring pin of TRS connector 1. (io_type_t)")
6473
set(CONFIG_DFLT_IO_POLARITY_TRS_1_RING IO_POLARITY_ACTIVE_LOW
65-
CACHE STRING "I/O polarity for the ring of TRS 1. (io_polarity_t)")
74+
CACHE STRING "I/O polarity for the ring pin of TRS connector 1. (io_polarity_t)")
6675
set(CONFIG_DFLT_IO_TYPE_TRS_2_TIP IO_TYPE_INPUT_PADDLE_LEFT
67-
CACHE STRING "I/O type for the tip of TRS 2. (io_type_t)")
76+
CACHE STRING "I/O type for the tip pin of TRS connector 2. (io_type_t)")
6877
set(CONFIG_DFLT_IO_POLARITY_TRS_2_TIP IO_POLARITY_ACTIVE_LOW
69-
CACHE STRING "I/O polarity for the tip of TRS 2. (io_polarity_t)")
78+
CACHE STRING "I/O polarity for the tip pin of TRS connector 2. (io_polarity_t)")
7079
set(CONFIG_DFLT_IO_TYPE_TRS_2_RING IO_TYPE_INPUT_PADDLE_RIGHT
71-
CACHE STRING "I/O type for the ring of TRS 2. (io_type_t)")
80+
CACHE STRING "I/O type for the ring pin of TRS connector 2. (io_type_t)")
7281
set(CONFIG_DFLT_IO_POLARITY_TRS_2_RING IO_POLARITY_ACTIVE_LOW
73-
CACHE STRING "I/O polarity for the ring of TRS 2. (io_polarity_t)")
82+
CACHE STRING "I/O polarity for the ring pin of TRS connector 2. (io_polarity_t)")
7483
set(CONFIG_DFLT_IO_TYPE_TRS_3_TIP IO_TYPE_OUTPUT_KEYER
75-
CACHE STRING "I/O type for the tip of TRS 3. (io_type_t)")
84+
CACHE STRING "I/O type for the tip pin of TRS connector 3. (io_type_t)")
7685
set(CONFIG_DFLT_IO_POLARITY_TRS_3_TIP IO_POLARITY_ACTIVE_LOW
77-
CACHE STRING "I/O polarity for the tip of TRS 3. (io_polarity_t)")
86+
CACHE STRING "I/O polarity for the tip pin of TRS connector 3. (io_polarity_t)")
7887
set(CONFIG_DFLT_IO_TYPE_TRS_3_RING IO_TYPE_NONE
79-
CACHE STRING "I/O type for the ring of TRS 3. (io_type_t)")
88+
CACHE STRING "I/O type for the ring pin of TRS connector 3. (io_type_t)")
8089
set(CONFIG_DFLT_IO_POLARITY_TRS_3_RING IO_POLARITY_ACTIVE_LOW
81-
CACHE STRING "I/O polarity for the ring of TRS 3. (io_polarity_t)")
90+
CACHE STRING "I/O polarity for the ring pin of TRS connector 3. (io_polarity_t)")
8291
set(CONFIG_DFLT_KEYER_PADDLE_MODE KEYER_PADDLE_MODE_IAMBIC
83-
CACHE STRING "Keyer paddle mode. (keyer_paddle_mode_t)")
92+
CACHE STRING "Default keyer paddle mode. (keyer_paddle_mode_t)")
8493
set(CONFIG_DFLT_KEYER_PADDLE_INVERT false
85-
CACHE STRING "Set to true to invert the paddles. (true / false)")
94+
CACHE STRING "Are keyer paddles inverted by default? (bool)")
8695

8796
# Set compile definitions
8897
add_compile_definitions(
@@ -119,25 +128,25 @@ add_compile_definitions(
119128

120129
# Define values
121130
set(PIN_IO_PIN_TRS_0_TIP GPIO_PIN_A0
122-
CACHE STRING "GPIO pin for the tip connector of TRS 0. (gpio_pin_t)")
131+
CACHE STRING "GPIO pin for the tip pin of TRS connector 0. (gpio_pin_t)")
123132
set(PIN_IO_PIN_TRS_0_RING GPIO_PIN_A1
124-
CACHE STRING "GPIO pin for the ring connector of TRS 0. (gpio_pin_t)")
133+
CACHE STRING "GPIO pin for the ring pin of TRS connector 0. (gpio_pin_t)")
125134
set(PIN_IO_PIN_TRS_1_TIP GPIO_PIN_A2
126-
CACHE STRING "GPIO pin for the tip connector of TRS 1. (gpio_pin_t)")
135+
CACHE STRING "GPIO pin for the tip pin of TRS connector 1. (gpio_pin_t)")
127136
set(PIN_IO_PIN_TRS_1_RING GPIO_PIN_A3
128-
CACHE STRING "GPIO pin for the ring connector of TRS 1. (gpio_pin_t)")
137+
CACHE STRING "GPIO pin for the ring pin of TRS connector 1. (gpio_pin_t)")
129138
set(PIN_IO_PIN_TRS_2_TIP GPIO_PIN_A4
130-
CACHE STRING "GPIO pin for the tip connector of TRS 2. (gpio_pin_t)")
139+
CACHE STRING "GPIO pin for the tip pin of TRS connector 2. (gpio_pin_t)")
131140
set(PIN_IO_PIN_TRS_2_RING GPIO_PIN_A5
132-
CACHE STRING "GPIO pin for the ring connector of TRS 2. (gpio_pin_t)")
141+
CACHE STRING "GPIO pin for the ring pin of TRS connector 2. (gpio_pin_t)")
133142
set(PIN_IO_PIN_TRS_3_TIP GPIO_PIN_A6
134-
CACHE STRING "GPIO pin for the tip connector of TRS 3. (gpio_pin_t)")
143+
CACHE STRING "GPIO pin for the tip pin of TRS connector 3. (gpio_pin_t)")
135144
set(PIN_IO_PIN_TRS_3_RING GPIO_PIN_A7
136-
CACHE STRING "GPIO pin for the ring connector of TRS 3. (gpio_pin_t)")
145+
CACHE STRING "GPIO pin for the ring pin of TRS connector 3. (gpio_pin_t)")
137146
set(PIN_LED_STATUS GPIO_PIN_D7
138147
CACHE STRING "GPIO pin for the status LED. (gpio_pin_t)")
139148
set(PIN_LED_KEY GPIO_PIN_D6
140-
CACHE STRING "GPIO pin for the key LED. (gpio_pin_t)")
149+
CACHE STRING "GPIO pin for the keyer LED. (gpio_pin_t)")
141150

142151
# Set compile definitions
143152
add_compile_definitions(

‎src/main/application/intf_port.h‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@
55
* @author Chris Vig (chris@invictus.so)
66
* @date 2025-08-29
77
* @cpyrt © 2025 by Chris Vig. Licensed under the GNU General Public License v3 (GPLv3).
8+
*
9+
* This module implements a binary serial port which allows controlling the SuperKey device. Numerous commands are
10+
* supported to perform functions like configuring the device, auto-keying characters, etc.
811
*/
912

1013
#if !defined( APPLICATION_INTF_PORT_H )

0 commit comments

Comments
 (0)