Fix various spelling issues (#400)

Author: hrzlgnm

CMakeLists.txt

@@ -191,7 +191,7 @@ endif()
 
 include (CTest)
 
-## Simple test wether we can run the application (should basic hidapi functions, like enumerate, work)
+## Simple test whether we can run the application (should basic hidapi functions, like enumerate, work)
 enable_testing()
 add_test(run_test headsetcontrol)
 set_tests_properties(run_test PROPERTIES PASS_REGULAR_EXPRESSION "No supported device found;Found")

src/dev.c

@@ -106,7 +106,7 @@ static void print_help()
     printf("HINTS\n");
     printf("\tsend and receive can be combined\n");
     printf("\t--send does not return anything on success and is always executed first\n");
-    printf("\tDATA can be specified as single bytes, either as decimal or hex, seperated by spaces or commas or newlines\n");
+    printf("\tDATA can be specified as single bytes, either as decimal or hex, separated by spaces or commas or newlines\n");
     printf("\n");
 
     printf("EXAMPLEs\n");

src/device.h

@@ -257,7 +257,7 @@ struct device {
      *  @returns    > 0         success
      *              -1          HIDAPI error
      */
-    int (*notifcation_sound)(hid_device* hid_device, uint8_t soundid);
+    int (*notification_sound)(hid_device* hid_device, uint8_t soundid);
 
     /** @brief Function pointer for turning light on or off of the headset
      *

src/devices/corsair_void.c

@@ -69,10 +69,10 @@ void void_init(struct device** device)
     device_void.capability_details[CAP_NOTIFICATION_SOUND] = (struct capability_detail) { .usagepage = 0xffc5, .usageid = 0x1, .interface = 3 };
     device_void.capability_details[CAP_LIGHTS]             = (struct capability_detail) { .usagepage = 0xffc5, .usageid = 0x1, .interface = 3 };
 
-    device_void.send_sidetone     = &void_send_sidetone;
-    device_void.request_battery   = &void_request_battery;
-    device_void.notifcation_sound = &void_notification_sound;
-    device_void.switch_lights     = &void_lights;
+    device_void.send_sidetone      = &void_send_sidetone;
+    device_void.request_battery    = &void_request_battery;
+    device_void.notification_sound = &void_notification_sound;
+    device_void.switch_lights      = &void_lights;
 
     *device = &device_void;
 }

src/devices/headsetcontrol_test.c

@@ -87,7 +87,7 @@ void headsetcontrol_test_init(struct device** device)
 
     device_headsetcontrol_test.send_sidetone                       = &headsetcontrol_test_send_sidetone;
     device_headsetcontrol_test.request_battery                     = &headsetcontrol_test_request_battery;
-    device_headsetcontrol_test.notifcation_sound                   = &headsetcontrol_test_notification_sound;
+    device_headsetcontrol_test.notification_sound                  = &headsetcontrol_test_notification_sound;
     device_headsetcontrol_test.switch_lights                       = &headsetcontrol_test_lights;
     device_headsetcontrol_test.send_inactive_time                  = &headsetcontrol_test_set_inactive_time;
     device_headsetcontrol_test.request_chatmix                     = &headsetcontrol_test_request_chatmix;

src/devices/hyperx_calphaw.c

@@ -144,7 +144,7 @@ static BatteryInfo calphaw_request_battery(hid_device* device_handle)
         uint8_t batteryPercentage = data_read[3];
 
 #ifdef DEBUG
-        uint32_t batteryVoltage = (data_read[4] << 8) | data_read[5]; // best assumtion this is voltage in mV
+        uint32_t batteryVoltage = (data_read[4] << 8) | data_read[5]; // best assumption this is voltage in mV
         printf("batteryVoltage: %d mV\n", batteryVoltage);
 #endif
         info.status = BATTERY_AVAILABLE;

src/devices/steelseries_arctis_nova_5.c

@@ -81,7 +81,7 @@ static uint8_t EQUALIZER_FILTER_MAP[NUM_EQ_FILTER_TYPES] = {
 };
 
 static int nova_5_send_sidetone(hid_device* device_handle, uint8_t num);
-static int nova_5_send_microhpone_mute_led_brightness(hid_device* device_handle, uint8_t num);
+static int nova_5_send_microphone_mute_led_brightness(hid_device* device_handle, uint8_t num);
 static int nova_5_send_microphone_volume(hid_device* device_handle, uint8_t num);
 static int nova_5_send_inactive_time(hid_device* device_handle, uint8_t num);
 static int nova_5_send_volume_limiter(hid_device* device_handle, uint8_t num);
@@ -119,7 +119,7 @@ void arctis_nova_5_init(struct device** device)
     device_arctis.capability_details[CAP_EQUALIZER]                      = (struct capability_detail) { .usagepage = 0xffc0, .usageid = 0x1, .interface = 3 };
 
     device_arctis.send_sidetone                       = &nova_5_send_sidetone;
-    device_arctis.send_microphone_mute_led_brightness = &nova_5_send_microhpone_mute_led_brightness;
+    device_arctis.send_microphone_mute_led_brightness = &nova_5_send_microphone_mute_led_brightness;
     device_arctis.send_microphone_volume              = &nova_5_send_microphone_volume;
     device_arctis.request_battery                     = &nova_5_get_battery;
     device_arctis.request_chatmix                     = &nova_5_get_chatmix;
@@ -203,7 +203,7 @@ static int nova_5_send_microphone_volume(hid_device* device_handle, uint8_t num)
     return nova_5_save_state(device_handle);
 }
 
-static int nova_5_send_microhpone_mute_led_brightness(hid_device* device_handle, uint8_t num)
+static int nova_5_send_microphone_mute_led_brightness(hid_device* device_handle, uint8_t num)
 {
     // Off = 0x00
     // low = 0x01
@@ -351,7 +351,7 @@ static int nova_5_send_equalizer(hid_device* device_handle, struct equalizer_set
     uint8_t data[MSG_SIZE] = { 0x0, 0x33 };
 
     /**
-     * constains the eq band frequencies used in "default" well known profiles used in presets
+     * contains the eq band frequencies used in "default" well known profiles used in presets
      */
     const unsigned char band_freq_le[2 * EQUALIZER_BANDS_COUNT] = {
         0x20,

src/main.c

@@ -184,7 +184,7 @@ static void print_readmetable()
 /**
  * @brief Checks if an existing connection exists, and either uses it, or closes it and creates a new one
  *
- * A device - depending on the feature - needs differend Endpoints/Connections
+ * A device - depending on the feature - needs different Endpoints/Connections
  * Instead of opening and keeping track of multiple connections, we close and open connections no demand
  *
  *
@@ -193,7 +193,7 @@ static void print_readmetable()
  * @param device_handle an existing device handle or NULL if none yet
  * @param device headsetcontrol struct, containing vendor and productid
  * @param cap which capability to use, to determine interfaceid and usageids
- * @return hid_device pointer if successfull, or NULL (error in hid_error)
+ * @return hid_device pointer if successful, or NULL (error in hid_error)
  */
 static hid_device* dynamic_connect(char** existing_hid_path, hid_device* device_handle,
     struct device* device, enum capabilities cap)
@@ -307,7 +307,7 @@ static FeatureResult handle_feature(struct device* device_found, hid_device** de
     }
 
     case CAP_NOTIFICATION_SOUND:
-        ret = device_found->notifcation_sound(*device_handle, (uint8_t) * (int*)param);
+        ret = device_found->notification_sound(*device_handle, (uint8_t) * (int*)param);
         break;
 
     case CAP_LIGHTS:
@@ -503,7 +503,7 @@ void print_help(char* programname, struct device* device_found, bool show_all)
         printf("Parametric Equalizer:\n");
         printf("  --parametric-equalizer STRING\t\tSet equalizer bands (bands separated by semicolon)\n");
         printf("      Band format:\t\t\tFREQUENCY,GAIN,Q_FACTOR,FILTER_TYPE\n");
-        printf("      Availabe filter types:\t\t");
+        printf("      Available filter types:\t\t");
         for (int i = 0; i < NUM_EQ_FILTER_TYPES; i++) {
             if (show_all || has_capability(device_found->parametric_equalizer->filter_types, i)) {
                 printf("%s, ", equalizer_filter_type_str[i]);
@@ -1016,7 +1016,7 @@ int main(int argc, char* argv[])
     bool isExtendedOutput = output_format == OUTPUT_YAML || output_format == OUTPUT_JSON || output_format == OUTPUT_ENV;
     for (int i = 0; i < headset_available; i++) {
         for (int j = 0; j < numFeatures; j++) {
-            // For specific output types, like YAML, we will do all actions - even when not specified - to aggreate all information
+            // For specific output types, like YAML, we will do all actions - even when not specified - to aggregate all information
             if (isExtendedOutput && feature_requests[i][j].type == CAPABILITYTYPE_INFO && !feature_requests[i][j].should_process) {
                 if (device_has_capability(devices_found[i].device, feature_requests[i][j].cap)) {
                     feature_requests[i][j].should_process = true;

src/output.c

@@ -112,7 +112,7 @@ void output(DeviceList* deviceList, bool print_capabilities, OutputType output)
         infos = calloc(num_devices, sizeof(HeadsetInfo));
     }
 
-    // Supress static analysis warning
+    // Suppress static analysis warning
     assert((infos != NULL && status.device_count > 0) || (infos == NULL && status.device_count == 0));
 
     // Iterate through all devices

src/utility.h

@@ -47,10 +47,10 @@ int spline_battery_level(const int p[], const int v[], const size_t size, uint16
 /**
  * @brief This function calculates the estimate batttery level in percent.
  *
- * To find the terms representing the polynominal discarge curve of the
+ * To find the terms representing the polynomial discharge curve of the
  * battery an solver like https://arachnoid.com/polysolve/ can be used.
  *
- * @param terms polynominal terms for the battery discharge curve
+ * @param terms polynomial terms for the battery discharge curve
  * @param numterms number of terms
  * @param voltage readings
  * @return battery level in percent
@@ -99,8 +99,8 @@ struct parametric_equalizer_settings* parse_parametric_equalizer_settings(const
  *
  * @param input input string
  * @param id1 the first (left) id
- * @param id2 the secound it
- * @return int 0 if successfull, or 1 if not two ids provided
+ * @param id2 the second it
+ * @return int 0 if successful, or 1 if not two ids provided
  */
 int get_two_ids(char* input, int* id1, int* id2);