GPIO-Controlled Network Connection
This example demonstrates how to use a GPIO to control a network connection to a remote server. Once the network connection is open, data can be automatically streamed between ZentriOS and the remote server.
Features Demonstrated
- ioconn.* variables
- gpio.alias variable
Method
The ZentriOS ioconn
feature makes it easy for an MCU, or blackbox electronic system with a serial output, to add network communication with a remote server. A GPIO is assigned as the ioconn.control_gpio. Toggling the ioconn control GPIO makes and breaks the network connection to the remote server.
The remote server used in the demonstration is the Zentri test TCP echo server, located online at test.zentri.com
.
The TCP echo server simply echoes any messages back to the client.
A computer, connected via USB to the evaluation board, takes the part of the MCU host system.
To set the level of the ioconn control GPIO high, various techniques are possible. In this demonstration, a switch is used to connect a logic high (3.3V) to the ioconn control GPIO pin. In an actual implementation, the host system toggles the ioconn control GPIO.
This demonstration uses the user LED GPIOs on the module for the ioconn control and status GPIOs. The LEDs are configured so that:
- User LED1 turns on when the ioconn control GPIO is asserted
- User LED2 turns on when a connection with the remote server is established
This demonstration works on a Mackerel, Moray or Medusa evaluation board.
Setup
Connect the switch between the IOC_CTRL and VDD_3V3, using eval board pins as indicated below:
Board | IOC_CTRL (LED 1) | VDD_3V3 | IOC_STATUS (LED2) |
---|---|---|---|
Mackerel AMW004-E03 | GPIO 22: Pin H2-10 | Pin H2-20 | GPIO 21 |
Moray AMW006-E03 | GPIO 16: Pin H8-24 | Pin H7-35 | GPIO 13 |
Medusa AMW007-E03 | GPIO 1: Pin H2-3 | Pin H2-8 | GPIO 4 |
Connect the module via USB to your computer and open a serial terminal console. See Getting Started.
The following assumes that the module is in the default state. To return to the default state, perform a factory reset.
Set up the local Wi-Fi network parameters.
ZentriOS commands | Comments |
---|---|
|
|
Set up aliases for the ioconn variables.
For the AMW004-E03 Mackerel evaluation board:
ZentriOS commands | Comments |
---|---|
|
|
For the AMW006-E03 Moray evaluation board:
ZentriOS commands | Comments |
---|---|
|
|
Configure the ioconn variables.
ZentriOS commands | Comments |
---|---|
|
|
Performing a GPIO-Controlled Host Connection
When the IOC_CTRL
GPIO is low, the stream_list command does not list any TCP client network stream:
> stream_list
! # Type Info
Assert the module IOC_CTRL
GPIO by setting the switch to ON.
If all goes well, the module terminal console displays something like the following:
ZentriOS Response |
---|
|
The stream_list command lists the new TCP client network stream:
> stream_list
! # Type Info
# 0 TCPC 107.170.222.80:50007 (22316)
While the IOC_CTRL
GPIO is still asserted, send a message to the server:
ZentriOS commands | Comments |
---|---|
|
|
ZentriOS Response |
---|
|
Now check if a message has been received in reply:
ZentriOS commands | Comments |
---|---|
|
|
ZentriOS Response |
---|
|
The server's response echoes the message sent.
De-assert the ioconn control GPIO by setting the switch to OFF.
The ZentriOS response is similar to the following:
ZentriOS Response |
---|
|
Once again, the stream_list command does not list any TCP client network stream:
> stream_list
! # Type Info
Using Stream Mode
A typical use of the GPIO Controlled Network Connection feature is to allow a device to stream data to and from a server. To demonstrate this, put the module in stream mode:
ZentriOS commands | Comments |
---|---|
|
|
The module terminal console can no longer send commands to ZentriOS. Try typing at the terminal. There is no response. Characters you type are transparently streamed to the network, which is currently not connected. See Serial Interface, Stream Mode.
Now assert the ioconn control GPIO by setting the switch to on.
ZentriOS responds as follows:
ZentriOS Response |
---|
|
All characters received from the remote server appear automatically on the console.
Now type some characters into the module terminal console. Typed characters are echoed (after round-trip network latency) by the Zentri test server.
Supporting ZentriOS Editions and Versions
- WiConnect-2.0+
- ZentriOS-W-3.0+
- ZentriOS-WZ-3.0+
- ZentriOS-XZ-3.2+
- ZentriOS-WL-1.0+
Change Log
Modified | Changes |
---|---|
2014-11-28 | Created |