Connecting to a Wi-Fi Access Point

Wi-Fi Notecards have the ability to connect to Wi-Fi access points and transmit data over Wi-Fi networks. In this guide you'll learn two different ways to set up a connection.

note

To connect a Wi-Fi Notecard to a Wi-Fi access point, you must first connect the Notecard to a companion Notecarrier board. If you're not sure how to do so, refer to our guide on connecting a Notecard to a Notecarrier.

Once you have your Wi-Fi Notecard seated on a Notecarrier, you're ready to connect it to a local Wi-Fi access point. There are two ways to accomplish this:

Using a Notecard API Command
Using Your Smartphone

warning

Before you continue, please note that Wi-Fi Notecard is only compatible with 2.4 GHz Wi-Fi access points. Access points that combine 5 GHz and 2.4 GHz with the same SSID may cause issues using the Notecard. Also, your ensure your Notecard firmware version is at least v3.3.1.

Using a Notecard API Command

Connect your Notecarrier to your computer via USB. You should see a red LED flash repeatedly, letting you know it's booting up. Using your terminal program (or the in-browser REPL), send this request to the Wi-Fi Notecard:


{"req":"card.wifi","ssid":"<ssid name>","password":"<password>"}

In return, you'll get a confirmation that your Wi-Fi Notecard is set to connect to the specified SSID using a specific security protocol. For example:


{
  "secure": true,
  "version": "3.12.3",
  "ssid": "<ssid name>",
  "security": "wpa2-psk"
}

Follow the instructions provided below to validate your Wi-Fi connection.

Using Your Smartphone

Alternatively, you can set up your Wi-Fi Notecard using your smartphone.

With your Wi-Fi Notecard and Notecarrier plugged into a power supply, press and release the black button on the face of the Notecard:

Next, open up your smartphone and browse for available Wi-Fi access points. Within a minute or so, you should see "Notecard" as an option:

Connect to "Notecard" on your phone and you'll be redirected to a window where you can enter the SSID and password. You can also use the "Scan networks" button to look for available access points, then tap on an access point to fill the SSID.

note

If the browser window doesn't automatically appear after connecting to the Notecard SSID, visit 10.10.0.1 in your phone's browser.

Tap "Connect" to complete your Wi-Fi configuration. Your Wi-Fi Notecard should reboot (note the flashing red LEDs), at which point you'll have successfully connected.

Finally, follow the instructions provided below to validate your Wi-Fi connection.

Validating Your Wi-Fi Connection

You'll know that your Wi-Fi Notecard is actively connected to Notehub when the green LED is on. Don't worry if it's not on right now, as it only turns on after you make your first hub.set request and sync with Notehub via a hub.sync request. If you're unsure how to send these commands, refer to the Notecard quickstart.

As of Notecard firmware v3.3.1, you can also issue a card.wireless request to verify the SSID, IP address of the Notecard, and the IP address of the gateway. For example:


> {"req":"card.wireless"}
{
 "status": "{network-up}",
 "mode": "auto",
 "count": 5,
 "net": {
  "imei": "89:DE:E5:11:XX:00",
  "ssid": "<ssid name>",
  "bssid": "A6:12:35:ED:F0:10",
  "rat": "wifi-2.4",
  "rssi": -32,
  "bars": 5,
  "ip": "192.168.0.200",
  "gateway": "192.168.0.1",
  "cid": 9,
  "updated": 1669834743
 }
}

The LED remains on only when the connection to Notehub is active. If you set the Notecard's mode to "continuous", the Notecard will maintain a connection to your access point. If you set the Notecard's mode to "periodic", the Notecard will only connect when it needs to transfer data.

If you change your Wi-Fi configuration and the hub.sync.status command returns "status": "connect delayed...", power cycle the Notecard to have it immediately use the new Wi-Fi configuration.

Common Connection Failure Issues

There are a variety of reasons why a Wi-Fi Notecard may be unable to connect to a Wi-Fi access point (SSID). As of Notecard firmware v3.3.1, one of the following error messages may be returned when a Notecard is unable to connect:

authentication failure - The provided password is incorrect.
invalid parameter - The password is too short or the SSID is too long.
AP not found - The SSID is incorrect, out of range, or no password was supplied.