Fixed help texts.

README.md

@@ -23,7 +23,7 @@ and is automatically generated. Here is a quick summary of config variables:
 
 |Key|Type|Default|Note|
 |---|----|---|---|
-|`wifi_ssid`|String|""|Your WiFi SSID|
+|`wifi_ssid`|String|""|Your WiFi SSID.|
 |`wifi_key`|String|""|Your WiFi Password.|
 |`wifi_on`|Boolean|false|True to enable WiFi / Websocket server.|
 |`bt_display_name`|String|"Edge-o-Matic 3000"|AzureFang* device name, you might wanna change this.|
@@ -35,28 +35,28 @@ and is automatically generated. Here is a quick summary of config variables:
 |`hostname`|String|"eom3k"|Local hostname for your device.|
 |`motor_start_speed`|Byte|10|The minimum speed the motor will start at in automatic mode.|
 |`motor_max_speed`|Byte|128|Maximum speed for the motor in auto-ramp mode.|
-|`motor_ramp_time_s`|Int|30|The time it takes for the motor to reach `motor_max_speed` in auto ramp mode.|
+|`motor_ramp_time_s`|Int|30|The time it takes for the motor to reach Motor Max Speed in automatic mode.|
 |`edge_delay`|Int|10000|Minimum time (ms) after edge detection before resuming stimulation.|
 |`max_additional_delay`|Int|10000|Maximum time (ms) that can be added to the edge delay before resuming stimulation. A random number will be picked between 0 and this setting each cycle. 0 to disable.|
 |`minimum_on_time`|Int|1000|Time (ms) after stimulation starts before edge detection is resumed.|
 |`screen_dim_seconds`|Int|10|Time, in seconds, before the screen dims. 0 to disable.|
 |`screen_timeout_seconds`|Int|0|Time, in seconds, before the screen turns off. 0 to disable.|
 |`pressure_smoothing`|Byte|5|Number of samples to take an average of. Higher results in lag and lower resolution!|
 |`classic_serial`|Boolean|false|Output continuous stream of arousal data over serial for backwards compatibility with other software.|
-|`sensitivity_threshold`|Int|600|The arousal threshold for orgasm detection. Lower = sooner cutoff.|
+|`sensitivity_threshold`|Int|600|The arousal threshold for orgasm detection. Lower values stop sooner.|
 |`update_frequency_hz`|Int|50|Update frequency for pressure readings and arousal steps. Higher = crash your serial monitor.|
-|`sensor_sensitivity`|Byte|128|Analog pressure prescaling. Adjust this until the pressure is ~60-70%|
+|`sensor_sensitivity`|Byte|128|Analog pressure prescaling. Please see instruction manual.|
 |`use_average_values`|Boolean|false|Use average values when calculating arousal. This smooths noisy data.|
 |`vibration_mode`|VibrationMode|RampStop|Vibration Mode for main vibrator control.|
 |`use_post_orgasm`|Boolean|false|Use post-orgasm torture mode and functionality.|
-|`clench_pressure_sensitivity`|Int|200|Threshold over arousal to detect a clench : Lower values increase sensitivity|
-|`clench_threshold_2_orgasm`|Int|35|Threshold variable that is tick counts of clench to detect orgasm|
-|`clench_detector_in_edging`|Boolean|false|Use the clench detector to adjust Arousal|
-|`auto_edging_duration_minutes`|Int|30|How long to edge before permiting an orgasm|
-|`post_orgasm_duration_seconds`|Int|10|How long to stimulate after orgasm detected|
-|`edge_menu_lock`|Boolean|false|Deny access to menu starting in the edging session|
-|`post_orgasm_menu_lock`|Boolean|false|Deny access to menu starting after orgasm detected|
-|`max_clench_duration`|Int|100|Duration the clench detector can raise arousal if clench detector turned on in edging session|
+|`clench_pressure_sensitivity`|Int|200|Minimum additional Arousal level to detect clench. See manual.|
+|`clench_threshold_2_orgasm`|Int|35|Threshold variable that is tick counts of clench to detect orgasm. See manual.|
+|`clench_detector_in_edging`|Boolean|false|Use the clench detector to adjust Arousal. See manual.|
+|`auto_edging_duration_minutes`|Int|30|How long to edge before permiting an orgasm.|
+|`post_orgasm_duration_seconds`|Int|10|How long to stimulate after orgasm detected.|
+|`edge_menu_lock`|Boolean|false|Deny access to menu starting in the edging session.|
+|`post_orgasm_menu_lock`|Boolean|false|Deny access to menu starting after orgasm detected.|
+|`max_clench_duration`|Int|100|Duration the clench detector can raise arousal if clench detector turned on in edging session.|
 
 
 \* AzureFang refers to a common wireless technology that is blue and involves chewing face-rocks. However, the

include/assets/config_help.h

@@ -21,7 +21,7 @@ extern "C" {
 #define _HELPSTR(str) NULL
 #endif
 
-#define WIFI_SSID_HELP _HELPSTR("Your WiFi SSID")
+#define WIFI_SSID_HELP _HELPSTR("Your WiFi SSID.")
 #define WIFI_KEY_HELP _HELPSTR("Your WiFi Password.")
 #define WIFI_ON_HELP _HELPSTR("True to enable WiFi / Websocket server.")
 #define BT_DISPLAY_NAME_HELP _HELPSTR("AzureFang* device name, you might wanna change this.")
@@ -33,28 +33,28 @@ extern "C" {
 #define HOSTNAME_HELP _HELPSTR("Local hostname for your device.")
 #define MOTOR_START_SPEED_HELP _HELPSTR("The minimum speed the motor will start at in automatic mode.")
 #define MOTOR_MAX_SPEED_HELP _HELPSTR("Maximum speed for the motor in auto-ramp mode.")
-#define MOTOR_RAMP_TIME_S_HELP _HELPSTR("The time it takes for the motor to reach `motor_max_speed` in auto ramp mode.")
+#define MOTOR_RAMP_TIME_S_HELP _HELPSTR("The time it takes for the motor to reach Motor Max Speed in automatic mode.")
 #define EDGE_DELAY_HELP _HELPSTR("Minimum time (ms) after edge detection before resuming stimulation.")
 #define MAX_ADDITIONAL_DELAY_HELP _HELPSTR("Maximum time (ms) that can be added to the edge delay before resuming stimulation. A random number will be picked between 0 and this setting each cycle. 0 to disable.")
 #define MINIMUM_ON_TIME_HELP _HELPSTR("Time (ms) after stimulation starts before edge detection is resumed.")
 #define SCREEN_DIM_SECONDS_HELP _HELPSTR("Time, in seconds, before the screen dims. 0 to disable.")
 #define SCREEN_TIMEOUT_SECONDS_HELP _HELPSTR("Time, in seconds, before the screen turns off. 0 to disable.")
 #define PRESSURE_SMOOTHING_HELP _HELPSTR("Number of samples to take an average of. Higher results in lag and lower resolution!")
 #define CLASSIC_SERIAL_HELP _HELPSTR("Output continuous stream of arousal data over serial for backwards compatibility with other software.")
-#define SENSITIVITY_THRESHOLD_HELP _HELPSTR("The arousal threshold for orgasm detection. Lower = sooner cutoff.")
+#define SENSITIVITY_THRESHOLD_HELP _HELPSTR("The arousal threshold for orgasm detection. Lower values stop sooner.")
 #define UPDATE_FREQUENCY_HZ_HELP _HELPSTR("Update frequency for pressure readings and arousal steps. Higher = crash your serial monitor.")
-#define SENSOR_SENSITIVITY_HELP _HELPSTR("Analog pressure prescaling. Adjust this until the pressure is ~60-70%")
+#define SENSOR_SENSITIVITY_HELP _HELPSTR("Analog pressure prescaling. Please see instruction manual.")
 #define USE_AVERAGE_VALUES_HELP _HELPSTR("Use average values when calculating arousal. This smooths noisy data.")
 #define VIBRATION_MODE_HELP _HELPSTR("Vibration Mode for main vibrator control.")
 #define USE_POST_ORGASM_HELP _HELPSTR("Use post-orgasm torture mode and functionality.")
-#define CLENCH_PRESSURE_SENSITIVITY_HELP _HELPSTR("Threshold over arousal to detect a clench : Lower values increase sensitivity")
-#define CLENCH_THRESHOLD_2_ORGASM_HELP _HELPSTR("Threshold variable that is tick counts of clench to detect orgasm")
-#define CLENCH_DETECTOR_IN_EDGING_HELP _HELPSTR("Use the clench detector to adjust Arousal")
-#define AUTO_EDGING_DURATION_MINUTES_HELP _HELPSTR("How long to edge before permiting an orgasm")
-#define POST_ORGASM_DURATION_SECONDS_HELP _HELPSTR("How long to stimulate after orgasm detected")
-#define EDGE_MENU_LOCK_HELP _HELPSTR("Deny access to menu starting in the edging session")
-#define POST_ORGASM_MENU_LOCK_HELP _HELPSTR("Deny access to menu starting after orgasm detected")
-#define MAX_CLENCH_DURATION_HELP _HELPSTR("Duration the clench detector can raise arousal if clench detector turned on in edging session")
+#define CLENCH_PRESSURE_SENSITIVITY_HELP _HELPSTR("Minimum additional Arousal level to detect clench. See manual.")
+#define CLENCH_THRESHOLD_2_ORGASM_HELP _HELPSTR("Threshold variable that is tick counts of clench to detect orgasm. See manual.")
+#define CLENCH_DETECTOR_IN_EDGING_HELP _HELPSTR("Use the clench detector to adjust Arousal. See manual.")
+#define AUTO_EDGING_DURATION_MINUTES_HELP _HELPSTR("How long to edge before permiting an orgasm.")
+#define POST_ORGASM_DURATION_SECONDS_HELP _HELPSTR("How long to stimulate after orgasm detected.")
+#define EDGE_MENU_LOCK_HELP _HELPSTR("Deny access to menu starting in the edging session.")
+#define POST_ORGASM_MENU_LOCK_HELP _HELPSTR("Deny access to menu starting after orgasm detected.")
+#define MAX_CLENCH_DURATION_HELP _HELPSTR("Duration the clench detector can raise arousal if clench detector turned on in edging session.")
 
 #ifdef __cplusplus
 }