Skip to content
This repository has been archived by the owner on Feb 4, 2023. It is now read-only.

Commit

Permalink
Fix Codespell complaints
Browse files Browse the repository at this point in the history
  • Loading branch information
khoih-prog authored Nov 18, 2022
1 parent 431f0ff commit c89375b
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,7 @@ Supposing the STM32 stm32 core version is 2.3.0. These files must be copied into
- `~/.arduino15/packages/STM32/hardware/stm32/2.3.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
Expand All @@ -257,7 +257,7 @@ Supposing the STM32 stm32 core version is 2.3.0. These files must be copied into
- `~/.arduino15/packages/STM32/hardware/stm32/2.3.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`
Expand Down
4 changes: 2 additions & 2 deletions docs/2.-API-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Set the keep alive. Defaults to 15 seconds.

#### AsyncMqttClient& setClientId(const char\* `clientId`)

Set the client ID. Defaults to `esp8266<chip ID on 6 hex caracters>`.
Set the client ID. Defaults to `esp8266<chip ID on 6 hex characters>`.

* **`clientId`**: Client ID

Expand Down Expand Up @@ -163,4 +163,4 @@ Return the packet ID (or 1 if QoS 0) or 0 if failed.

When disconnected, clears all queued messages

Returns true on succes, false on failure (client is no disconnected)
Returns true on success, false on failure (client is no disconnected)
2 changes: 1 addition & 1 deletion docs/3.-Memory-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ AsyncMqttClient buffers outgoing messages in a queue. On sending data is copied
## Outgoing messages

You can send data as long as memory permits. A minimum amount of free memory is set at 4096 bytes. You can lower (or raise) this value by setting `MQTT_MIN_FREE_MEMORY` to your desired value.
If the free memory was sufficient to send your packet, the `publish` method will return a packet ID indicating the packet was queued. Otherwise, a `0` will be returned, and it's your responsability to resend the packet with `publish`.
If the free memory was sufficient to send your packet, the `publish` method will return a packet ID indicating the packet was queued. Otherwise, a `0` will be returned, and it's your responsibility to resend the packet with `publish`.

## Incoming messages

Expand Down
2 changes: 1 addition & 1 deletion platformio/platformio.ini
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ lib_deps =
build_flags =
; set your debug output (default=Serial)
; -D DEBUG_ESP_PORT=Serial
; comment the folowing line to enable WiFi debugging
; comment the following line to enable WiFi debugging
; -D NDEBUG

; ============================================================
Expand Down

0 comments on commit c89375b

Please sign in to comment.