Getting Started with WiConnect
WiConnect provides a secure wireless network link between your host microcontroller (MCU) and a network.
To join a wireless network, you need to supply the module with network credentials: the wireless network name (SSID) and password. There are several ways to do this, including:
- Getting Started with the WiConnect Web App. See below.
- Getting Started with the WiConnect Terminal. See below.
- See Configuration and Setup for more ways to configure a WiConnect device.
Let's get started!
Getting Started with the WiConnect Web App
The WiConnect Web App provides a simple way to configure the module network credentials using a web browser. This is particularly convenient for configuring ACKme evaluation boards, which can be put in setup web
mode without connecting a WiConnect terminal. See WiConnect Web App, Setup Web Mode.
Getting Started with the WiConnect Terminal
Before configuring your module, you can ensure your module is in a known state by performing a factory_reset.
Opening a WiConnect Terminal
You can control your ACKme module with WiConnect commands via a UART serial terminal.
For an ACKme WiConnect evaluation board, plug the computer USB port into the evaluation board micro USB port. USB provides power and UART serial connection.
For a module not in an evaluation board, connect the terminal to module UART 1 Rx and Tx and provide power to the module. See the module datasheet for details.
With the module UART connected:
- Open a communication terminal application e.g. Teraterm
- Find the UART serial (COM) port associated with the eval board
- Set the communication parameters to 115200 8N1 with NO hardware flow control
- Press the enter key. WiConnect responds with a ready message and command prompt:
Ready
>
- At the WiConnect prompt, type
version
and check for a response similar to the text below.
> version
WiConnect-2.0.0.11, Built:2014-10-20 13:35:04 for AMW006.4, Board:AMW006-E03.2
If problems arise, see the WiConnect Troubleshooting Guide.
Configuring the Module for a Wi-Fi Network
You need to provide your module with your Access Point (AP) SSID and password. You can do this via the serial terminal, with the following WiConnect commands.
WiConnect Commands | Description |
---|---|
|
|
When you issue any WiConnect command that requires network access, WiConnect attempts to bring the network up using these properties.
ACKme evaluation boards have a network indicator LED to help determine successful association.
Enter the network_up command (nup
).
The network indicator LED changes its blink rate from fast (no IP address), to medium (DHCP in progress) to slow (DHCP successful, IP address obtained).
To ensure that variables like the AP name and password persist after a reboot, use the save command:
save
Verifying the Internet Connection
To demonstrate that the module is connecting to the Internet, try downloading a web page:
WiConnect Commands | Description |
---|---|
|
|
WiConnect Applications
Now that you have established control over your ACKme module, you can experiment with the rich set of WiConnect features. There are many application notes demonstrating WiConnect networking applications. See Application Examples.
Getting Help
As well as this WiConnect documentation, there are various WiConnect help commands:
- At the WiConnect prompt, enter
[help](commands#help)
.
The following help options are available ...
help all -> Print a list of all Commands and Variables
help commands -> Print a list of Commands
help variables -> Print a list of readable Variables
help <command> -> Print help for a specific Command
help <variable> -> Print help for a specific Variable
Additional help is available online at http://wiconnect.ack.me
- Enter help all for a full list of commands and variables.
- Enter help commands to list commands only, or help variables to list variables only.
- Enter help
to show help for an individual command or variable.