Skip to content

Commit

Permalink
fix some typos
Browse files Browse the repository at this point in the history
  • Loading branch information
soundanalogous committed Feb 1, 2016
1 parent ebba4fc commit 1fcf42b
Show file tree
Hide file tree
Showing 6 changed files with 40 additions and 36 deletions.
24 changes: 12 additions & 12 deletions examples/ConfigurableFirmata/ConfigurableFirmata.ino
Original file line number Diff line number Diff line change
Expand Up @@ -79,15 +79,15 @@
* OPTION A: Configure for Arduino Ethernet board or Arduino Ethernet shield (or clone)
*
* To configure ConfigurableFirmata to use the an Arduino Ethernet Shield or Arduino Ethernet
* Board (both use the same WIZ5100-based ethernet controller), uncomment the SPI and Ethernet
* Board (both use the same WIZ5100-based Ethernet controller), uncomment the SPI and Ethernet
* includes below.
*/
//#include <SPI.h>
//#include <Ethernet.h>


/*
* OPTION B: Configure for a board or shield using an ENC28J60-based ethernet controller,
* OPTION B: Configure for a board or shield using an ENC28J60-based Ethernet controller,
* uncomment out the UIPEthernet include below.
*
* The UIPEthernet-library can be downloaded
Expand All @@ -97,7 +97,7 @@


/*
* OPTION C: Configure for Arduin Yun
* OPTION C: Configure for Arduino Yun
*
* The Ethernet port on the Arduino Yun board can be used with Firmata in this configuration.
* To execute StandardFirmataEthernet on Yun uncomment the Bridge and YunClient includes below.
Expand All @@ -123,17 +123,17 @@
// OR replace with hostname of server you want to connect to, comment out if using 'remote_ip'
// #define remote_host "server.local"

// STEP 3 [REQUIRED unless using Arduin Yun]
// STEP 3 [REQUIRED unless using Arduino Yun]
// Replace with the port that your server is listening on
#define remote_port 3030

// STEP 4 [REQUIRED unless using Arduino Yun OR if not using DHCP]
// Replace with your board or ethernet shield's IP address
// Replace with your board or Ethernet shield's IP address
// Comment out if you want to use DHCP
#define local_ip IPAddress(192, 168, 0, 6)

// STEP 5 [REQUIRED unless using Arduino Yun]
// replace with ethernet shield mac. Must be unique for your network
// replace with Ethernet shield mac. Must be unique for your network
const byte mac[] = {0x90, 0xA2, 0xDA, 0x0D, 0x07, 0x02};
#endif

Expand Down Expand Up @@ -241,14 +241,14 @@ EthernetClientStream stream(client, IPAddress(0, 0, 0, 0), IPAddress(0, 0, 0, 0)

void systemResetCallback()
{
// initialize a defalt state
// initialize a default state

// pins with analog capability default to analog input
// otherwise, pins default to digital output
for (byte i = 0; i < TOTAL_PINS; i++) {
if (IS_PIN_ANALOG(i)) {
#ifdef AnalogInputFirmata_h
// turns off pullup, configures everything
// turns off pull-up, configures everything
Firmata.setPinMode(i, PIN_MODE_ANALOG);
#endif
} else if (IS_PIN_DIGITAL(i)) {
Expand Down Expand Up @@ -278,9 +278,9 @@ void setup()
Bridge.begin();
#else
#ifdef local_ip
Ethernet.begin((uint8_t *)mac, local_ip); //start ethernet
Ethernet.begin((uint8_t *)mac, local_ip); //start Ethernet
#else
Ethernet.begin((uint8_t *)mac); //start ethernet using dhcp
Ethernet.begin((uint8_t *)mac); //start Ethernet using dhcp
#endif
#endif
delay(1000);
Expand Down Expand Up @@ -342,7 +342,7 @@ void setup()
// ignore SPI and pin 4 that is SS for SD-Card on Ethernet-shield
for (byte i = 0; i < TOTAL_PINS; i++) {
if (IS_PIN_SPI(i)
|| 4 == i // SD-Card on Ethernet-shiedl uses pin 4 for SS
|| 4 == i // SD Card on Ethernet shield uses pin 4 for SS
|| 10 == i // Ethernet-shield uses pin 10 for SS
) {
Firmata.setPinMode(i, PIN_MODE_IGNORE);
Expand Down Expand Up @@ -380,7 +380,7 @@ void loop()
digitalInput.report();
#endif

/* STREAMREAD - processing incoming messagse as soon as possible, while still
/* STREAMREAD - processing incoming message as soon as possible, while still
* checking digital inputs. */
while (Firmata.available()) {
Firmata.processInput();
Expand Down
44 changes: 23 additions & 21 deletions examples/ConfigurableFirmataWiFi/ConfigurableFirmataWiFi.ino
Original file line number Diff line number Diff line change
Expand Up @@ -107,9 +107,9 @@
/*
* OPTION A: Configure for Arduino WiFi shield
*
* This will configure ConfigurableFirmataWiFi to use the original WiFi library (deprecated) provided
* with the Arduino IDE. It is supported by the Arduino WiFi shield (a discontinued product) and
* is compatible with 802.11 B/G networks.
* This will configure ConfigurableFirmataWiFi to use the original WiFi library (deprecated)
* provided with the Arduino IDE. It is supported by the Arduino WiFi shield (a discontinued
* product) and is compatible with 802.11 B/G networks.
*
* To configure ConfigurableFirmataWiFi to use the Arduino WiFi shield
* leave the #define below uncommented.
Expand All @@ -125,15 +125,16 @@ WiFiStream stream;
/*
* OPTION B: Configure for WiFi 101
*
* This will configure ConfigurableFirmataWiFi to use the WiFi101 library, which works with the Arduino WiFi101
* shield and devices that have the WiFi101 chip built in (such as the MKR1000). It is compatible
* with 802.11 B/G/N networks.
* This will configure ConfigurableFirmataWiFi to use the WiFi101 library, which works with the
* Arduino WiFi101 shield and devices that have the WiFi101 chip built in (such as the MKR1000). It
* is compatible with 802.11 B/G/N networks.
*
* To enable, uncomment the #define WIFI_101 below and verify the #define values under
* options A and C are commented out.
*
* IMPORTANT: You must have the WiFI 101 library installed. To easily install this library, opent the library manager via:
* Arduino IDE Menus: Sketch > Include Library > Manage Libraries > filter search for "WiFi101" > Select the result and click 'install'
* IMPORTANT: You must have the WiFI 101 library installed. To easily install this library, open
* the library manager via: Arduino IDE Menus: Sketch > Include Library > Manage Libraries >
* filter search for "WiFi101" > Select the result and click 'install'
*/
//#define WIFI_101

Expand All @@ -160,8 +161,8 @@ WiFi101Stream stream;
char ssid[] = "your_network_name";

// STEP 3 [OPTIONAL for all boards and shields]
// if you want to use a static IP (v4) address, uncomment the line below. You can also change the IP.
// if this line is commented out, the WiFi shield will attempt to get an IP from the DHCP server
// If you want to use a static IP (v4) address, uncomment the line below. You can also change the IP.
// If this line is commented out, the WiFi shield will attempt to get an IP from the DHCP server
// #define STATIC_IP_ADDRESS 192,168,1,113

// STEP 4 [REQUIRED for all boards and shields]
Expand All @@ -177,8 +178,8 @@ char ssid[] = "your_network_name";
*
* WPA is the most common network security type. A passphrase is required to connect to this type.
*
* To enable, leave #define WIFI_WPA_SECURITY uncommented below, set your wpa_passphrase value appropriately,
* and do not uncomment the #define values under options B and C
* To enable, leave #define WIFI_WPA_SECURITY uncommented below, set your wpa_passphrase value
* appropriately, and do not uncomment the #define values under options B and C
*/
#define WIFI_WPA_SECURITY

Expand All @@ -189,11 +190,11 @@ char wpa_passphrase[] = "your_wpa_passphrase";
/*
* OPTION B: WEP
*
* WEP is a less common (and regarded as less safe) security type. A WEP key and its associated index are required
* to connect to this type.
* WEP is a less common (and regarded as less safe) security type. A WEP key and its associated
* index are required to connect to this type.
*
* To enable, Uncomment the #define below, set your wep_index and wep_key values appropriately, and verify
* the #define values under options A and C are commented out.
* To enable, Uncomment the #define below, set your wep_index and wep_key values appropriately, and
* verify the #define values under options A and C are commented out.
*/
//#define WIFI_WEP_SECURITY

Expand All @@ -208,7 +209,8 @@ char wep_key[] = "your_wep_key";
/*
* OPTION C: Open network (no security)
*
* Open networks have no security, can be connected to by any device that knows the ssid, and are unsafe.
* Open networks have no security, can be connected to by any device that knows the ssid, and are
* unsafe.
*
* To enable, uncomment #define WIFI_NO_SECURITY below and verify the #define values
* under options A and B are commented out.
Expand Down Expand Up @@ -333,14 +335,14 @@ int wifiStatus = WL_IDLE_STATUS;

void systemResetCallback()
{
// initialize a defalt state
// initialize a default state

// pins with analog capability default to analog input
// otherwise, pins default to digital output
for (byte i = 0; i < TOTAL_PINS; i++) {
if (IS_PIN_ANALOG(i)) {
#ifdef AnalogInputFirmata_h
// turns off pullup, configures everything
// turns off pull-up, configures everything
Firmata.setPinMode(i, PIN_MODE_ANALOG);
#endif
} else if (IS_PIN_DIGITAL(i)) {
Expand Down Expand Up @@ -563,7 +565,7 @@ void loop()
digitalInput.report();
#endif

/* STREAMREAD - processing incoming messagse as soon as possible, while still
/* STREAMREAD - processing incoming message as soon as possible, while still
* checking digital inputs. */
while (Firmata.available()) {
Firmata.processInput();
Expand Down Expand Up @@ -602,6 +604,6 @@ runtasks: scheduler.runTasks();
serial.update();
#endif

// keep the WiFi connection live. Attemtps to reconnect automatically if disconnected.
// keep the WiFi connection live. Attempts to reconnect automatically if disconnected.
stream.maintain();
}
4 changes: 2 additions & 2 deletions src/I2CFirmata.h
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@
See file LICENSE.txt for further informations on licensing terms.
ServoFirmata.cpp has been merged into this header file as a hack to avoid having to
include Servo.h for every arduino sketch that includes ConfigurableFirmata.
I2CFirmata.cpp has been merged into this header file as a hack to avoid having to
include Wire.h for every arduino sketch that includes ConfigurableFirmata.
Last updated by Jeff Hoefs: January 23rd, 2015
*/
Expand Down
1 change: 1 addition & 0 deletions src/OneWireFirmata.cpp
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
/*
OneWireFirmata.cpp - Firmata library
Copyright (C) 2012-2013 Norbert Truchsess. All rights reserved.
Copyright (C) 2016 Jeff Hoefs. All rights reserved.
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
Expand Down
1 change: 1 addition & 0 deletions src/OneWireFirmata.h
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
/*
OneWireFirmata.h - Firmata library
Copyright (C) 2012-2013 Norbert Truchsess. All rights reserved.
Copyright (C) 2016 Jeff Hoefs. All rights reserved.
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
Expand Down
2 changes: 1 addition & 1 deletion src/SerialFirmata.cpp
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
SerialFirmata.cpp - Firmata library
Copyright (C) 2015 Jeff Hoefs. All rights reserved.
Copyright (C) 2015-2016 Jeff Hoefs. All rights reserved.
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
Expand Down

0 comments on commit 1fcf42b

Please sign in to comment.