Skip to content

Spelling and grammar corrections in project files #791

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 14 commits into from
Aug 18, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions src/Wippersnapper.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ void Wippersnapper::_disconnect() {

/****************************************************************************/
/*!
@brief Sets the network interface's unique identifer, typically the
@brief Sets the network interface's unique identifier, typically the
MAC address.
*/
/****************************************************************************/
Expand Down Expand Up @@ -256,7 +256,7 @@ bool Wippersnapper::check_valid_ssid() {
/*!
@brief Configures the device's Adafruit IO credentials. This method
should be used only if filesystem-backed provisioning is
not avaliable.
not available.
*/
/****************************************************************************/
void Wippersnapper::set_user_key() {
Expand Down Expand Up @@ -493,7 +493,7 @@ bool cbSignalMsg(pb_istream_t *stream, const pb_field_t *field, void **arg) {
/**************************************************************************/
/*!
@brief Decodes a signal buffer protobuf message.
NOTE: Should be executed in-order after a new _buffer is recieved.
NOTE: Should be executed in-order after a new _buffer is received.
@param encodedSignalMsg
Encoded signal message.
@return true if successfully decoded signal message, false otherwise.
Expand Down Expand Up @@ -1089,7 +1089,7 @@ bool cbDecodeServoMsg(pb_istream_t *stream, const pb_field_t *field,

/**************************************************************************/
/*!
@brief Called when the device recieves a new message from the
@brief Called when the device receives a new message from the
/servo/ topic.
@param data
Incoming data from MQTT broker.
Expand Down Expand Up @@ -1215,7 +1215,7 @@ bool cbPWMDecodeMsg(pb_istream_t *stream, const pb_field_t *field, void **arg) {
#endif
return false; // fail out if we can't decode the request
}
// execute PWM pin detatch request
// execute PWM pin detach request
char *pwmPin = msgPWMDetachRequest.pin + 1;
WS._pwmComponent->detach(atoi(pwmPin));

Expand Down Expand Up @@ -1298,7 +1298,7 @@ bool cbPWMDecodeMsg(pb_istream_t *stream, const pb_field_t *field, void **arg) {

/**************************************************************************/
/*!
@brief Called when the device recieves a new message from the
@brief Called when the device receives a new message from the
/pwm/ topic.
@param data
Incoming data from MQTT broker.
Expand Down Expand Up @@ -1501,7 +1501,7 @@ bool cbDecodePixelsMsg(pb_istream_t *stream, const pb_field_t *field,

/**************************************************************************/
/*!
@brief Called when the device recieves a new message from the
@brief Called when the device receives a new message from the
/pixels/ topic.
@param data
Incoming data from MQTT broker.
Expand Down Expand Up @@ -2736,7 +2736,7 @@ void print_reset_reason(int reason) {
break; /**<13, RTC Watch dog Reset CPU*/
case 14:
WS_DEBUG_PRINTLN("EXT_CPU_RESET");
break; /**<14, for APP CPU, reseted by PRO CPU*/
break; /**<14, for APP CPU, reset by PRO CPU*/
case 15:
WS_DEBUG_PRINTLN("RTCWDT_BROWN_OUT_RESET");
break; /**<15, Reset when the vdd voltage is not stable*/
Expand Down Expand Up @@ -2796,7 +2796,7 @@ void Wippersnapper::connect() {
haltError("Unable to generate Device UID");
}

// Initialize MQTT client with device identifer
// Initialize MQTT client with device identifier
setupMQTTClient(_device_uid);

WS_DEBUG_PRINTLN("Generating device's MQTT topics...");
Expand Down
6 changes: 3 additions & 3 deletions src/components/i2c/WipperSnapper_I2C.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -181,14 +181,14 @@ WipperSnapper_Component_I2C::scanAddresses() {
continue;
} else if (endTransmissionRC == 4) {
WS_DEBUG_PRINTLN(
"[i2c] Did not find device: Unspecified bus error occured!");
"[i2c] Did not find device: Unspecified bus error occurred!");
continue;
} else if (endTransmissionRC == 5) {
WS_DEBUG_PRINTLN("[i2c] Did not find device: Bus timed out!");
continue;
} else {
WS_DEBUG_PRINTLN(
"[i2c] Did not find device: Unknown bus error has occured!");
"[i2c] Did not find device: Unknown bus error has occurred!");
continue;
}
#endif
Expand Down Expand Up @@ -1307,7 +1307,7 @@ void WipperSnapper_Component_I2C::update() {

std::vector<WipperSnapper_I2C_Driver *>::iterator iter, end;
for (iter = drivers.begin(), end = drivers.end(); iter != end; ++iter) {
// Number of events which occured for this driver
// Number of events which occurred for this driver
msgi2cResponse.payload.resp_i2c_device_event.sensor_event_count = 0;

// Event struct - zero-initialise on each iteration
Expand Down
2 changes: 1 addition & 1 deletion src/components/register/Wippersnapper_Register.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ bool Wippersnapper::encodePubRegistrationReq() {
if (!_status)
return _status;

// pubish message
// publish message
WS.publish(WS._topic_description, _message_buffer, _message_len, 1);
WS_DEBUG_PRINTLN("Published!");
WS._boardStatus = WS_BOARD_DEF_SENT;
Expand Down
2 changes: 1 addition & 1 deletion src/components/servo/ws_servo.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ bool ws_servo::servo_attach(int pin, int minPulseWidth, int maxPulseWidth,
#ifdef ARDUINO_ARCH_ESP32
rc = servo->attach(pin, minPulseWidth, maxPulseWidth, freq);
#else
(void)freq; // supress warning when we don't use the frequency parameter
(void)freq; // suppress warning when we don't use the frequency parameter
rc = servo->attach(pin, minPulseWidth, maxPulseWidth);
#endif
if (rc == ERR_SERVO_ATTACH)
Expand Down
Loading