Peripherals

Peripheral commands and variables enable access to general purpose input/outputs (GPIOs), analog functions such as analog-digital converters (ADCs) and PWMs (Pulse Width Modulators). In the case of the ACKme Numbat and Mackeral evaluation boards, peripherals include two user LEDs, two user buttons and the thermistor ADC.

GPIO Commands and Variables

Typically, particular GPIOs are hard-wired to components such as LEDs, buttons and sensors. Other GPIOs are configurable for input and output.

GPIOs can be used for special system functions, including (but not limited to):

• assigning a LED as wlan status indicator
• selecting between serial bus modes: COMMAND or STREAM
• pulse width modulator (PWM) function
• general standard IO function
• out-of-band interrupts

GPIO commands and variables allow control of the function and direction of the GPIOs.

GPIO Commands

• adc_take_sample - Take a sample of an ADC pin via the connected GPIO
• dac_set_level - Set the output level of a DAC (if available)
• gpio_dir - Set GPIO direction, as a Standard I/O
• gpio_get - Get GPIO value, for a GPIO functioning as Standard I/O
• gpio_set - Set GPIO value, for a GPIO functioning as Standard I/O
• pwm_update - Assign a PWM to a GPIO, with a specified duty cycle and frequency

GPIO Variables

• broadcast.udp.data - Specify GPIOs and ADCs for which state is to be broadcast in UDP data packet
• bus.stream.cmd_gpio - Set and get the GPIO used for switching from stream mode to command mode
• ghm.solo.gpio - Assign a GPIO to a goHACK.me stream or control parameter in solo mode.
• gpio_alias - Set and get the alias of a GPIO
• gpio.config_file - Set and get the file used for GPIO configuration on bootup
• gpio.init - Set and get GPIO initial direction and value
• gpio.usage - Get list of GPIO usage
• ioconn.control_gpio - Set and get the GPIO used for GPIO controlled network connection (stream)
• ioconn.status_gpio - Set and get the GPIO used to indicate when GPIO controlled network feature is enabled (stream)
• network.status_gpio - Set and get the GPIO used for network status
• setup.gpio.cmd - Set and get the command executed when setup.gpio.control_gpio asserted
• setup.gpio.control_gpio - Set and get the GPIO used for initiating a command or web setup sequence
• setup.gpio.level - Set and get the active logic level that indicates setup.gpio.control_gpio is asserted
• setup.gpio.mode - Set the execution mode for setup.gpio.cmd
• system.activity.gpio - Set and get the GPIO used to indicate specific types of system activity.
• system.activity.gpio_level - Set and get the logic level corresponding to activity.
• system.bflash.cs_gpio - Set and get the bulk flash chip select GPIO
• system.indicator.gpio - Set and get the GPIO used for a system indicator function
• system.indicator.state - Set and get the behavior of the GPIO corresponding to each indicator state
• system.wakeup.events - Set and get GPIOs assigned to wake the module from sleep. Available only for GPIOs with wake capability
• system.oob variables - Set a GPIO for out-of-band interrupts in response to specified events.
• tcp.server.connected_gpio - Set and get the GPIO used to indicate whether a client is connected to the TCP server.
• tcp.server.data_gpio - Set and get the GPIO used to indicate whether a connected TCP client has data available to read.
• udp.server.data_gpio - Set and get the GPIO used to indicate whether a connected UDP client has data available to read.

GPIO Functions and Pins

GPIO functions pins differ depending on module and evaluation board. For a comparison of modules, see Module Comparison.

Wallaby Module and Mackerel Evaluation Board

The table below shows functions, defaults and pins for the AMW004 Wallaby GPIOs. The table also shows defaults, connections and header pins for the AMW004-E03.3 Mackerel evaluation board.

Mackerel power header pins:

• GND: H1-2, H1-19, H2-2, H2-19
• VDD: H1-1, H1-20, H2-1, H2-20

Numbat Module and Moray Evaluation Board

The table below shows functions, defaults and pins for the AMW006 Numbat GPIOs. The table also shows defaults, connections and header pins for the AMW006-E03.2 Moray evaluation board.

• Numbat V4+ only

Moray power header pins:

• GND: H6-2, H6-11, H7-27, H7-36, H8-12, H8-35
• VDD: H6-3, H6-10, H7-35

Viewing GPIO Usage

To see the current GPIO usage, read the gpio.usage variable.

The default Mackerel GPIO usage is:

get  gp u
!  # Description
#  0 GPIO input_highz
#  1 system.indicator.wlan
#  2 system.indicator.network
#  5 system.indicator.softap
# 11 setup.control_gpio
# 13 UART1 RX
# 14 UART1 TX
# 17 SPI0 CLK
# 18 SPI0 MOSI
# 19 SPI0 MISO
# 21 GPIO output
# 22 GPIO output

The default Moray GPIO usage is:

> get gp u
!  # Description
#  0 GPIO input_highz (button1)
#  5 system.indicator.softap (softap_led)
#  6 SPI MISO
#  7 SPI CLK
#  8 SPI MOSI
# 11 UART0 RX
# 12 UART0 TX
# 13 GPIO output (led2)
# 16 GPIO output (led1)
# 18 system.indicator.network (network_led)
# 22 Standard I/O (button2)
# 23 system.indicator.wlan (wlan_led)

The gpio_usage command does not list GPIOs set to none: these GPIOs have no function configured.

Note that the aliases shown in the Moray GPIO usage list above are set in the gpio_config_init.csv file provided with the Moray evaluation board. See Configuration and Setup, GPIO Configuration.

Setting GPIO Function

GPIO function can be set by commands or variables, or by a configuration file (see Configuration and Setup, GPIO Configuration).

If there is a gpio_config_init.csv file present on the file system, this overrides any other GPIO settings at boot time. Some GPIO function changes are not implemented until reboot, and cannot be implemented by WiConnect command if a gpio_config_init.csv file sets the GPIO function.

GPIOs that are already assigned to a function need to be deregistered before reassignment. If the GPIO is assigned to a system.indicator.gpio function, deregister or reassign the system.indicator.gpio function. See System Indicator Functions. Otherwise use the gpio_dir command with a none argument.

For example, to deregister user LED1 on the Moray board (GPIO13): gdi 13 none

For the change to persist after reboot, you need to set the gpio.init variable and save:

set gpio.init <GPIO#> none
save

To use a GPIO as Standard I/O, use the gpio_dir command to set its direction. For example, to set user LED1 on the Moray to an output: gdi 13 out

For the change to persist after reboot, you need to set the gpio.init variable and save. For example:

set gpio.init 13 out
save

To use a GPIO with a PWM, use the pwm_update command.

You can also use a GPIO for a number of special functions, such as indicators, or inputs to control special features.

System Indicator Functions

Use the system.indicator.gpio and system.indicator.state to configure a GPIO for a system indicator function. Save the variables and reboot to complete the configuration change, since these functions are managed by services configured during bootup.

Note: This GPIO function change cannot be implemented by WiConnect command if a gpio_config_init.csv file sets the GPIO function.

On the Mackerel and Moray evaluation boards, the red, yellow and green LEDs are configured by default as system indicators, showing soft AP, network and wlan status. See Wallaby Module and Mackerel Evaluation Board, Numbat Module and Moray Evaluation Board.

For example, to switch the network system indicator function to Mackerel user LED 1 (GPIO 22):

gdi 22 none
set sy i g network 22
save
reboot

Each system indicator function can be associated with only one GPIO. Setting the indicator to a GPIO automatically sets to none any GPIO previously assigned to that system indicator.

To deregister a GPIO currently registered for a system indicator function, either disable the system indicator function or set it to another GPIO. For example, to deregister GPIO 1 on the Mackerel:

set sy i g wlan -1

Bus Stream Command GPIO

Set the bus.stream.cmd_gpio to configure a GPIO to force WiConnect from stream mode to command mode. See Serial Interface for a discussion of stream mode and command mode.

This feature is intended for automated use with a host MCU. In the following demonstration of this feature on the Mackerel evaluation board, we use Button 2 (GPIO 11).

gdi 11 none
set bu s g 11
set bu m stream
save 
reboot

Deregister Mackerel Button 2 GPIO
Configure Button 2 GPIO as bus.stream.cmd_gpio
Set the bus mode to stream
Save variables 
The changed bus mode is not implemented until boot

Because the device is in stream mode, characters typed into the serial terminal are not echoed. Press Button 2, and WiConnect displays: Command Mode Start While holding down Button 2, WiConnect commands may be typed into the terminal, and characters are echoed. For example, you can set bus mode to command and save, to restore command mode after a reboot. Release Button 2 and the device returns to stream mode.

GPIO Controlled Network Connection

WiConnect allows you to configure full details of a connection to a host, then connect and disconnect under the control of a single GPIO. The connection can be via UDP or TCP, with optional TLS.

Set ioconn.control_gpio to assign a GPIO to the control function that makes and breaks the connection.

Set ioconn.status_gpio to assign a GPIO to indicate the status of the connection.

See the ioconn.* variables for details.

The GPIO-Controlled Network Connection application note provides further examples.

GPIO Controlled Script

You can control the execution of a command script with a GPIO. See Configuration and Setup, Setup Configuration Script, and in particular Automatically Executing a Script - On GPIO Assertion or Reboot.

The associated variables are:

• setup.gpio.cmd - Set and get the command executed when setup.gpio.control_gpio asserted
• setup.gpio.control_gpio - Set and get the GPIO used for initiating a command or web setup sequence
• setup.gpio.level - Set and get the active logic level that indicates setup.gpio.control_gpio is asserted
• setup.gpio.mode - Set the execution mode for setup.gpio.cmd

Network Status GPIO

The network.status_gpio variable enables you to set and get the GPIO used to indicate network status.

TCP Server Status GPIOs

The tcp.server.connected_gpio variable provides a GPIO to indicate whether a client is connected to the TCP server.

The tcp.server.data_gpio variable provides a GPIO to indicate whether a connected client has data available to read.

See the TCP Server + softAP application note for further information.

UDP Server Data GPIO

The udp.server.data_gpio variable allows asssignment of a GPIO to indicate whether a connected UDP client has data available to read.

Out-of-Band Interrupts

The system.oob variables allow a GPIO to be assigned for out-of-band (OOB) interrupts in response to specified events.

The OOB GPIO is asserted whenever one or more of the configured events occurs. It is de-asserted when reading the status register.

See in particular system.oob.gpio for details.

NOTE: The OOB gpio feature can be used by itself. The corresponding special function GPIO does not need to be enabled. For example, the network.status OOB event can be triggered without setting the network.status_gpio variable.

System Activity GPIO

The system.activity.gpio variables allows assignment of a GPIO to indicate specific types of system activity. Activity types are listed in the system.activity.gpio variable documentation.

The system.activity.gpio_level variables allows setting of the logic level corresponding to activity.

Bulk Flash GPIO

The system.bflash.cs_gpio variable allows adding bulk flash to the system.

System Wakeup GPIO

The system.wakeup.events variable allows assigning a GPIO to wake the module from sleep. Only GPIOs with wake capability can be assigned to this function.

goHACKme Solo GPIO

ghm.solo.gpio allows you to assign a GPIO to a goHACK.me stream or control parameter in solo mode.

Using a GPIO Alias

You can set a GPIO alias for any GPIO. The alias may be used instead of the GPIO number, since an alias is easier to remember. Using aliases can also help to make code more consistent and easier to read.

The default settings for the Moray board configure the alias led1 for GPIO13, so you can use the alias instead of the GPIO number: gdi led1 none

To create an alias for a GPIO, set the gpio.alias variable. For example, to set an alias for the Mackerel board user LED1: set gp a 22 led1

Now the same command works on both the Moray and Mackerel boards, even though GPIO assignments differ: gdi led1 none

Setting and Getting GPIO Values

If a GPIO is set to the Standard I/O function, and the GPIO direction is set as an output with the gdi (gpio_direction) command, the GPIO value may be configured with the gse (gpio_set) and gge (gpio_get) commands. For example:

> gdi 12 out
Set OK
> gge 12
0
> gse 12 1
Set OK
> gge 12
1

If a Standard I/O GPIO is configured for input, you can read the GPIO value but you cannot set it:

> gdi 12 in
Set OK
> gge 12
0
> gse 12 1
GPIO not configured for output
Command failed

ADCs

To read the value from an ADC, use the adc command. For example, to read the value for the Moray thermistor ADC (GPIO20):

> adc 20
0x7D7

The ADC value can be read regardless of the GPIO function setting.

To convert the ADC_value to mV, use the following formula:

adc_mV = (Vref * adc_value) / adc_max_value

Vref is nominally 3300 (3.3V) and adc_max_value is 0xFFF (hex) = 4095 (dec).

You can specify the ADC reference voltage with the system.adc.vref variable.

For example, using the nominal Vref the ADC value 0x7D7 converts to 1617 mV. This thermistor reading corresponds to a temperature of about 26 degrees Celsius when using the thermistor on the Mackerel or Moray evaluation board.

To determine temperature from the Mackeral and Moray thermistor ADC readings, see Temperature versus ADC value .

You can also send ADC values in broadcast UDP packets. See Broadcast UDP Packet.

ADC Lookup Tables

A LookUp Table (LUT) can be specified for an ADC using the <LUT filename.csv> parameter with the adc_take_sample command. A lookup table can also be specified when setting a GPIO for an ADC function using the ghm.solo.gpio variable.

The ADC is read and the raw value is used to find the two closest entries in the LUT. Those two entries are used to linearly interpolate the corresponding converted value of the ADC.

The LUT is parsed and loaded into RAM, either the first time a LUT file parameter is supplied with the adc_take_sample command, or when the ghm.solo.gpio setting is specified. For every subsequent read of that ADC with a lookup table specified, the cached LUT is used for the conversion, unless the adc_take_sample is issued with a -v (voltage) parameter. Only one LUT for a given ADC may be used. A reboot is required to load another LUT for the same ADC.

Care should be taken when generating the LUT as it is cached in the heap, i.e. the larger it is, the more RAM it takes away from other features.

Up to 3 ADC GPIOs may use a LUT.

The LUT is a CSV file with the following format: <Raw ADC Value (0-4095)>,<Floating point number>\r\n The table entries must follow these requirements:

• Must contain at least three entries
• Entries must be ordered with in ascending order (i.e. the smallest ADC value is the first entry in the table, the largest ADC value is the last entry)
• The first entry MUST be the of 0
• The last entry MUST be the of 4095

For evaluation boards with a thermistor, such as the Mackerel and Moray boards, a thermistor LUT is downloaded automatically to the module when you issue the ghm_capabilities download -s command in the course of a goHACK.me solo setup.

PWMs

PWMs (Pulse Width Modulators) can be used for blinking and dimming user LEDs. They can also be used for driving a speaker attached to a GPIO.

The pwm_update command provides control of the frequency and duty cycle of a PWM output.

Before using with a PWM, a GPIO must be set to the none function with gpio_dir.

PWMs are associated with specific GPIOs. In the GPIO tables on this page (GPIO Functions and Pins), each PWM has an associated group ID. Only one PWM GPIO in each group may be simultaneously and independently active. The GPIO numbers, NOT the PWM ID numbers, are used in the pwm_update command.

PWM groups, maximum and minimum frequencies are module specific as shown in the tables below:

Wallaby PWMs

Numbat PWMs

LEDs

The level of a LED can be controlled via a GPIO, either with the Standard I/O output or by using a PWM.

GPIO Standard I/O Control

A LED can be turned on or off by configuring as a Standard I/O output, then setting the GPIO level.

For example, to turn on Mackerel user LED1, use the gpio_dir command and the gpio_set command:

gdi 22 none
gdi 22 out
gse 22 1
gse 22 0

Deregister Mackerel User LED1 GPIO, in case it is assigned to a different function 
Assign User LED1 GPIO to a Standard I/O output
Set GPIO output high (LED1 on)
Set GPIO output low (LED1 off)

PWM control - Blinking and Dimming LEDs

You can use a PWM to blink an LED. A PWM can be used with a GPIO only when no function is assigned to the GPIO. For example, to blink Moray user LED1, use the gpio_dir command and the pwm_update command:

gdi 16 none
pwm 16 50 1

Deregister Moray User LED1 GPIO, in case it is assigned to a different function 
Run the GPIO PWM at duty cycle 50%, frequency 1Hz

Using pwm_update on a GPIO assigns the corresponding PWM function to the GPIO. You can see this with the gpio_usage variable:

> get gp u
!  # Description
...
# 16 PWM6 (led1)
...

To turn off blinking, use the pwm_update command with the stop argument:

pwm 16 stop

To dim the LED, reduce the duty cycle. To make blinking imperceptible, set the frequency to a rate above 30 Hz. For example, to dim the Moray user LED2:

gdi 16 none
pwm 16 5 60

Deregister Moray User LED1 GPIO, in case it is assigned to a different function 
Run the GPIO PWM at duty cycle 5%, frequency 60Hz

Communicating Peripheral Information Over the Network

The WiConnect TCP and UDP client and server features provide frameworks for building a customised application for transmitting and receiving monitor and control data from your ACKme module. For examples of these applications, see:

• TCP Client
• Multiple TCP Clients
• Secure TLS Client
• GPIO-Controlled Network Connection
• TCP Server + SoftAP

WiConnect also provides general systems for handling information transfer.

A WiConnect module can be configured to broadcast GPIO and ADC data at regular intervals, via the broadcast group of variables.

The broadcast.udp.data variable lets you specify what data is broadcast. GPIOs are specified by GPIO number, and ADCs are specified by ADC number. See the Broadcast UDP Packet for a demonstration of this feature.

The goHACK.me system provides a complete solution to remote monitoring and control of your ACKme device, including free web servers, a powerful and easy to use online interface, and a WiConnect API. See:

• goHACKme
• goHACK.me Slave Mode application note
• goHACK.me Solo Mode application note

Peripheral GPIO Mapping by Function

Wallaby GPIOs by Function

Wallaby UART

Wallaby ADC

Wallaby PWM

Wallaby SPI Master (System Use Only)

Wallaby DAC

Numbat GPIOs by Function

Numbat UART

Numbat ADC

Numbat PWM

Numbat SPI Master (System Use Only)

Numbat SPI Slave (Numbat v4+ Only)