Fix Codespell complaints

Author: khoih-prog

README.md

@@ -352,7 +352,7 @@ Supposing the STM32 stm32 core version is 2.2.0. These files must be copied into
 - `~/.arduino15/packages/STM32/hardware/stm32/2.2.0/system/STM32F7xx/stm32f7xx_hal_conf_default.h` for Nucleo-144 STM32F7.
 
 Whenever a new version is installed, remember to copy this file into the new version directory. For example, new version is x.yy.zz,
-theses files must be copied into the corresponding directory:
+these files must be copied into the corresponding directory:
 
 - `~/.arduino15/packages/STM32/hardware/stm32/x.yy.zz/system/STM32F4xx/stm32f4xx_hal_conf_default.h`
 - `~/.arduino15/packages/STM32/hardware/stm32/x.yy.zz/system/STM32F7xx/stm32f7xx_hal_conf_default.h`
@@ -368,7 +368,7 @@ Supposing the STM32 stm32 core version is 2.2.0. These files must be copied into
 - `~/.arduino15/packages/STM32/hardware/stm32/2.2.0/variants/STM32L0xx/L052R(6-8)T_L053R(6-8)T_L063R8T/NUCLEO_L053R8/variant.h` for Nucleo-64 NUCLEO_L053R8.
 
 Whenever a new version is installed, remember to copy this file into the new version directory. For example, new version is x.yy.zz,
-theses files must be copied into the corresponding directory:
+these files must be copied into the corresponding directory:
 
 - `~/.arduino15/packages/STM32/hardware/stm32/x.yy.zz/variants/STM32F7xx/F765Z(G-I)T_F767Z(G-I)T_F777ZIT/NUCLEO_F767ZI/variant.h`
 - `~/.arduino15/packages/STM32/hardware/stm32/x.yy.zz/variants/STM32L0xx/L052R(6-8)T_L053R(6-8)T_L063R8T/NUCLEO_L053R8/variant.h`
@@ -631,7 +631,7 @@ To use SPI2 or any custom SPI
 
 **The default CS/SS pin is 10 for all boards, and is configurable in code.**
 
-If the default pin is not corect, select another CS/SS pin (e.e. D22) to use as follows:
+If the default pin is not correct, select another CS/SS pin (e.e. D22) to use as follows:
 
 ```cpp
 // To override the default CS/SS pin. Don't use unless you know exactly which pin to use
@@ -1863,7 +1863,7 @@ EthernetWebServer_SSL_STM32 v1.6.0
 You're connected to the network, IP = 192.168.2.96
 Attempting MQTT connection to broker.emqx.io...connected
 Published connection message successfully!
-Subcribed to: STM32_Sub
+Subscribed to: STM32_Sub
 Message Send : STM32_Pub => Hello from MQTTClient_SSL_Complex on NUCLEO_F767ZI, millis = 6990
 Message arrived [STM32_Pub] Hello from MQTTClient_SSL_Complex on NUCLEO_F767ZI, millis = 6990
 Message Send : STM32_Pub => Hello from MQTTClient_SSL_Complex on NUCLEO_F767ZI, millis = 11992
@@ -1898,7 +1898,7 @@ EthernetWebServer_SSL_STM32 v1.6.0
 You're connected to the network, IP = 192.168.2.107
 Attempting MQTT connection to broker.emqx.io...connected
 Published connection message successfully!
-Subcribed to: STM32_Sub
+Subscribed to: STM32_Sub
 Message Send : STM32_Pub => Hello from MQTTClient_SSL_Complex on NUCLEO_F767ZI, millis = 5001
 Message arrived [STM32_Pub] Hello from MQTTClient_SSL_Complex on NUCLEO_F767ZI, millis = 5001
 Message Send : STM32_Pub => Hello from MQTTClient_SSL_Complex on NUCLEO_F767ZI, millis = 10007
@@ -1934,7 +1934,7 @@ esp32-sniffer/12345678/ble
 Attempting MQTT connection to mqtt.thingstream.io
 ...connected
 Published connection message successfully!
-Subcribed to: esp32-sniffer/12345678/ble
+Subscribed to: esp32-sniffer/12345678/ble
 MQTT Message Send : esp32-sniffer/12345678/ble => Hello from MQTTS_ThingStream on NUCLEO_F767ZI with LAN8742A Ethernet & STM32Ethernet Library
 MQTT Message receive [esp32-sniffer/12345678/ble] Hello from MQTTS_ThingStream on NUCLEO_F767ZI with LAN8742A Ethernet & STM32Ethernet Library
 MQTT Message Send : esp32-sniffer/12345678/ble => Hello from MQTTS_ThingStream on NUCLEO_F767ZI with LAN8742A Ethernet & STM32Ethernet Library
@@ -1968,7 +1968,7 @@ esp32-sniffer/12345678/ble
 Attempting MQTT connection to mqtt.thingstream.io
 ...connected
 Published connection message successfully!
-Subcribed to: esp32-sniffer/12345678/ble
+Subscribed to: esp32-sniffer/12345678/ble
 MQTT Message Send : esp32-sniffer/12345678/ble => Hello from MQTTS_ThingStream_ThingStream on NUCLEO_F767ZI with ENC28J60 & EthernetENC Library
 MQTT Message receive [esp32-sniffer/12345678/ble] Hello from MQTTS_ThingStream_ThingStream on NUCLEO_F767ZI with ENC28J60 & EthernetENC Library
 MQTT Message Send : esp32-sniffer/12345678/ble => Hello from MQTTS_ThingStream_ThingStream on NUCLEO_F767ZI with ENC28J60 & EthernetENC Library
@@ -2001,7 +2001,7 @@ esp32-sniffer/12345678/ble
 Attempting MQTT connection to mqtt.thingstream.io
 ...connected
 Published connection message successfully!
-Subcribed to: esp32-sniffer/12345678/ble
+Subscribed to: esp32-sniffer/12345678/ble
 MQTT Message Send : esp32-sniffer/12345678/ble => Hello from MQTTS_ThingStream on NUCLEO_F767ZI with W5x00 & Ethernet_Generic Library
 MQTT Message receive [esp32-sniffer/12345678/ble] Hello from MQTTS_ThingStream on NUCLEO_F767ZI with W5x00 & Ethernet_Generic Library
 MQTT Message Send : esp32-sniffer/12345678/ble => Hello from MQTTS_ThingStream on NUCLEO_F767ZI with W5x00 & Ethernet_Generic Library
@@ -2026,7 +2026,7 @@ esp32-sniffer/12345678/ble
 Attempting MQTT connection to mqtt.thingstream.io
 ...connected
 Published connection message successfully!
-Subcribed to: esp32-sniffer/12345678/ble
+Subscribed to: esp32-sniffer/12345678/ble
 MQTT Message Send : esp32-sniffer/12345678/ble => Hello from MQTTS_ThingStream on BLACK_F407VE with LAN8720 Ethernet & STM32Ethernet Library
 MQTT Message Send : esp32-sniffer/12345678/ble => Hello from MQTTS_ThingStream on BLACK_F407VE with LAN8720 Ethernet & STM32Ethernet Library
 MQTT Message Send : esp32-sniffer/12345678/ble => Hello from MQTTS_ThingStream on BLACK_F407VE with LAN8720 Ethernet & STM32Ethernet Library
@@ -2128,7 +2128,7 @@ EthernetWebServer_SSL_STM32 v1.6.0
 You're connected to the network, IP = 192.168.2.138
 Attempting MQTT connection to broker.emqx.io...connected
 Published connection message successfully!
-Subcribed to: STM32_Sub
+Subscribed to: STM32_Sub
 Message Send : STM32_Pub => Hello from MQTTClient_SSL_LAN8720 on BLACK_F407VE
 Message arrived [STM32_Pub] Hello from MQTTClient_SSL_LAN8720 on BLACK_F407VE
 Message Send : STM32_Pub => Hello from MQTTClient_SSL_LAN8720 on BLACK_F407VE
@@ -2152,7 +2152,7 @@ EthernetWebServer_SSL_STM32 v1.6.0
 You're connected to the network, IP = 192.168.2.142
 Attempting MQTT connection to broker.emqx.io...connected
 Published connection message successfully!
-Subcribed to: STM32_Sub
+Subscribed to: STM32_Sub
 Message Send : STM32_Pub => Hello from MQTTClient_SSL_Complex_LAN8720 on BLACK_F407VE, millis = 6546
 Message arrived [STM32_Pub] Hello from MQTTClient_SSL_Complex_LAN8720 on BLACK_F407VE, millis = 6546
 Message Send : STM32_Pub => Hello from MQTTClient_SSL_Complex_LAN8720 on BLACK_F407VE, millis = 11549

tools/pycert_bearssl/cert_util.py

@@ -23,7 +23,7 @@
 
 CERT_PATTERN = re.compile("^\-\-\-\-\-BEGIN CERTIFICATE\-\-\-\-\-[a-z,A-Z,0-9,\n,\/,+]+={0,2}\n\-\-\-\-\-END CERTIFICATE-\-\-\-\-", re.MULTILINE)
 
-# Default name prefixes for varibles used in the hearder autogeneration
+# Default name prefixes for variables used in the hearder autogeneration
 # Autogenerator will follow these names with a number
 # e.g. "TA_DN0"
 # Distinguished name array prefix
@@ -78,8 +78,8 @@
 # Template that defines a static array of bytes
 # This takes in a few named parameters:
 #  - ray_type: The type (int, unsigned char) to use for the static array
-#  - ray_name: The varible name of the static array
-#  - ray_data: The comma seperated data of the array (ex. "0x12, 0x34, ...")
+#  - ray_name: The variable name of the static array
+#  - ray_data: The comma separated data of the array (ex. "0x12, 0x34, ...")
 CRAY_TEMPLATE = """\
 static const {ray_type} {ray_name}[] = {{
 {ray_data}
@@ -90,8 +90,8 @@
 # This takes in a few named parameters:
 #  - ta_dn_name: The name of the static byte array containing the distunguished
 #    name of the certificate.
-#  - rsa_number_name: Varible name of the static array containing the RSA number
-#  - rsa_exp_name: Varible name of the static array containing the RSA exponent
+#  - rsa_number_name: variable name of the static array containing the RSA number
+#  - rsa_exp_name: variable name of the static array containing the RSA exponent
 CROOTCA_TEMPLATE = """\
     {{
         {{ (unsigned char *){ta_dn_name}, sizeof {ta_dn_name} }},
@@ -110,8 +110,8 @@
 # This takes in a few named parameters:
 #  - ta_dn_name: The name of the static byte array containing the distunguished
 #    name of the certificate.
-#  - ec_number_name: Varible name of the static array containing ec public key
-#  - ec_curve_name: Varible name of the enum that describes curve type
+#  - ec_number_name: variable name of the static array containing ec public key
+#  - ec_curve_name: variable name of the enum that describes curve type
 CROOTCA_EC_TEMPLATE = """\
     {{
         {{ (unsigned char *){ta_dn_name}, sizeof {ta_dn_name} }},
@@ -219,7 +219,7 @@ def decribe_cert_object(cert, cert_num, domain=None):
     x509 object, domain should be a string name, and cert_num should be
     an integer.
     """
-    # get the label from the subject feild on the certificate
+    # get the label from the subject field on the certificate
     label = ""
     com = dict(cert.get_subject().get_components())
     if b'CN' in com:
@@ -228,7 +228,7 @@ def decribe_cert_object(cert, cert_num, domain=None):
         label = com[b'OU'].decode("utf-8")
     elif b'O' in com:
         label = com[b'O'].decode("utf-8")
-    # return the formated string
+    # return the formatted string
     crypto = cert.to_cryptography()
     out_str = CCERT_DESC_TEMPLATE.format(
         cert_num=cert_num,
@@ -327,7 +327,7 @@ def x509_to_header(x509Certs, cert_var, cert_length_var, output_file, keep_dupes
             ))
         else:
             raise Exception(f'Unknown public key type {numbers_typename}')
-    # concatonate it all into the big header file template
+    # concatenate it all into the big header file template
     # cert descriptions
     cert_desc_out = '\n * \n'.join(cert_desc)
     # static arrays
@@ -343,4 +343,4 @@ def x509_to_header(x509Certs, cert_var, cert_length_var, output_file, keep_dupes
         cert_length_var=cert_length_var,
         cert_length=str(len(CAs)),
         cert_data=cert_data_out,
-    ))
+    ))

tools/pycert_bearssl/pycert_bearssl.py

@@ -20,9 +20,9 @@
 import certifi
 from OpenSSL import crypto
 
-# Default name for the cert length varible
+# Default name for the cert length variable
 CERT_LENGTH_NAME = "TAs_NUM"
-# Defualt name for the cert array varible
+# Default name for the cert array variable
 CERT_ARRAY_NAME = "TAs"
 
 # Click setup and commands:
@@ -155,4 +155,4 @@ def convert(cert_var, cert_length_var, output, use_store, keep_dupes, no_search,
       exit(1)
 
 if __name__ == '__main__':
-    pycert_bearssl()
+    pycert_bearssl()