Library for controlling the WNC 14A2A from the K64F Freedom Board. It fulfills platform specific pure virtual methods from the WncControllerLibrary.

Dependencies:   WncControllerLibrary

Dependents:   WNC14A2AInterface

Fork of WncControllerK64F by Fred Kellerman

Embed: (wiki syntax)

« Back to documentation index

WncControllerK64F Class Reference

WncControllerK64F Class Reference

#include <WncControllerK64F.h>

Public Member Functions

 WncControllerK64F (struct WncGpioPinListK64F *pPins, BufferedSerial *wnc_uart, WNCDebug *debug_uart=NULL)
 Sets up the resources to control the WNC modem shield.
bool enterWncTerminalMode (BufferedSerial *pUart, bool echoOn)
 Activates a mode where the user can send text to and from the K64F debug Serial port directly to the WNC.

Detailed Description

Author:
Fred Kellerman
See also:
API

WncControllerK64F This mbed C++ class is for controlling the WNC Cellular modem from the NXP K64F Freedom board. It uses the control code from it's base class WncController to handle the WNC Modem AT cmds. This class fulfills various pure virtual methods of the base class. The point of this class is to have the platform specific code in it thus isolating the control code logic from any particular platform or OS.

Definition at line 68 of file WncControllerK64F.h.


Constructor & Destructor Documentation

WncControllerK64F ( struct WncGpioPinListK64F pPins,
BufferedSerial *  wnc_uart,
WNCDebug *  debug_uart = NULL 
)

Sets up the resources to control the WNC modem shield.

Parameters:
pPins- pointer to a list of K64F pins that are used to setup and control the ATT IoT Kit's WNC Shield.
wnc_uart- a pointer to the serial uart that is used to communicate with the WNC modem.
debug_uart- a pointer to a serial uart for the debug output to go out of, if NULL debug will not be output.

Definition at line 33 of file WncControllerK64F.cpp.


Member Function Documentation

bool enterWncTerminalMode ( BufferedSerial *  pUart,
bool  echoOn 
)

Activates a mode where the user can send text to and from the K64F debug Serial port directly to the WNC.

The mode is entered via this call. The mode is exited when the user types CTRL-Q. While in this mode all text to and from the WNC is consumed by the debug Serial port. No other methods in the class will receive any of the WNC output.

Parameters:
pUart- a pointer to a uart to use to collect the user input and put the output from the WNC.
echoOn- set to true to echo what is input back to the output of pUart.

Definition at line 41 of file WncControllerK64F.cpp.