Component: WLAN (ESP 12S) (Comms: Networking)

Author	Matrix Ltd.
Version	2.1
Category	Comms: Networking

WLAN component

Wireless LAN component designed to work with the ESP-12S module. Provides a very simple interface to allow webpages to be hosted from hardware or simulation. Also available in the form of the BL0136 WIFI E-block.

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Downloadable macro reference

	SendString
Sends the given Text with no preappendment. Useful for sending preformatted command strings. Appends a CR to the end of the string if SendCR is greater than 0.
- STRING	Text
- BYTE	SendCR
- VOID	Return

	DisconnectFromSSID
Disconnects from the current SSID. Returns 1 if the command was accepted and returned an "OK"
- BYTE	Return

	ClientConnect
Creates a TCP or UDP connection to a remote server. Returns the state of the connection. 0=Connection failed 1=Connection active
- BYTE	Type
0 = TCP, 1 = UDP
- STRING	IPAddress
e.g. "192.168.1.20"
- UINT	Port
Remote port number to connect to, HTTP comms = Port 80
- BYTE	Return

	ControlTCPServer
Allows a TCP web page server to be switched on and off on the selected port. Returns 1 if the command was completed correctly.
- BYTE	Enable
0 = Stop Server, 1 = Start Server
- UINT	Port
Server port to listen for incoming TCP/IP data requests
- BYTE	Return

	GetFirmwareVersion
Collects the firmware version from the ESP8266 module and returns it as a string.
- STRING	Return

	CheckForPageRequests
To be called periodically. Returns non-zero if a request has been processed
- BYTE	Return

	ClientSendRequest
Sends out a string with the required AT+CIPSEND=Length$(Request) initialiser.
- STRING	Request
e.g. "GET / HTTP/1.0\r\n\r\n"
- VOID	Return

	ReadSSIDFromScan
Collects one of the SSID name strings from the last SSID Scan. The ScanForSSID macro must be called first.
- BYTE	Index
SSID Index
- STRING	Return

	CreateAccessPoint
Sets up the wireless LAN module into AP mode to host a wireless network. Other WIFI enabled devices can then connect to the module. Returns 1 for success.
- STRING	SSID
Name of the wireless network to create
- STRING	Password
Password used to gain access to the network
- BYTE	Channel
802.11 Channel Range 1-14
- BYTE	Encryption
0=Open, 1=WEP, 2=WPA_PSK, 3=WPA2_PSK, 4=WPA_WPA2_PSK
- BYTE	Return

	SetOutValue
Set the value of an outbound substitution string
- BYTE	index
Range 0-4
- STRING	value
- VOID	Return

	EndServerConnection
Disconnects from the current active TCP/IP pipe.
- BYTE	Return

	Send_Embedded_HTML_Page4
- VOID	Return

	ReadSignalStrengthFromScan
Collects the signal strength from the last SSID Scan. The ScanForSSID macro must be called first. Value returned is in negative dB, smaller value = better signal
- BYTE	Index
SSID Index
[[File:]] -	Return

	Send_Embedded_HTML_Page3
- VOID	Return

	Send_Embedded_HTML_Page2
- VOID	Return

	Send_Embedded_HTML_Page1
- VOID	Return

	ReadEncryptionModeFromScan
Collects one of the encryption modes from the last SSID Scan. The ScanForSSID macro must be called first. 0=Open, 1=WEP, 2=WPA_PSK, 3=WPA2_PSK, 4=WPA_WPA2_PSK
- BYTE	Index
SSID Index
- BYTE	Return

	GetByteWithTimeout
Attempts to receive a byte from the circular buffer. If nothing is available then waits up to 200 ms for data to become available.
- BYTE	Return

	GetInValue
Returns the string value of a Request parameter
- BYTE	index
Index of the request paramter, starting at zero Range 0-2
- STRING	Return

	ConnectToSSID
Attempts to connect to the given SSID and Key values. Returns 1 if the SSID has been connected.
- STRING	SSID
- STRING	Key
- BYTE	Timeout
Number of seconds to wait for the connection, default 20
- BYTE	Return

	ClientSendArray
Sends out an array of data bytes with the required AT+CIPSEND=Length$(Request) initialiser.
- BYTE	Data
- UINT	NumBytes
- VOID	Return

	GetRxArray
Attempts to receive a number of bytes from the remote connection If nothing is available then waits up to 200 ms for data to become available. Returns the number of bytes received,.
- BYTE	Data
Byte array to store the incoming data
- UINT	MaxBytes
Maximum number of bytes to try and receive
- UINT	Return

	ScanForSSID
Checks for wireless networks in the local area which are broadcasting their SSID. Must not be connected to a network to allow this to function. Returns the number of wireless networks found, max 8.
- BYTE	Return

	Initialise
Initialise the device with the property data. Returns 1 if "ready" message successfully received Returns 0 if no reply from module
- BYTE	Return

	CheckTCPServerIP
Collects the local IP address of the active TCP server.
- STRING	Return

	PULSRISE
Sets the pulse waveform negative edge to <nrf> micro seconds. (Lower limit: 5ns - Upper limit: 99.9ns).
[[File:]] -	Rise
Sets the pulse waveform positive edge in micro seconds (5ns - 99.9ns).
- VOID	Return

	MODAMSHAPE
Sets AM waveform shape to: 0 = SINE, 1 = SQUARE, 2 = RAMPUP, 3 = RAMPDN, 4 = TRIANG, 5 = NOISE, 6 = DC, 7 = SINC, 8 = EXPRISE, 9 = LOGRISE, 10 = ARB1, 11 = ARB2, 12 = ARB3, 13= ARB4.
- BYTE	Shape
Sets AM waveform shape (1 = SINE, 2 = SQUARE, 3 = RAMPUP, 4 = RAMPDN, 5 = TRIANG, 6 = NOISE, 7 = DC, 8 = SINC, 9 = EXPRISE, 10 = LOGRISE, 11 = ARB1, 12 = ARB2, 13 = ARB3, 14= ARB4).
- VOID	Return

	CLKSRC
Sets the clock source to; 0 = INT, 1 = EXT.
[[File:]] -	Source
Sets the clock source (0 = INT, 1 = EXT).
- VOID	Return

	ARB1DEFRet
Returns user specified waveform name, waveform pint interpolation state and waveform length of ARB1.
- STRING	Return

	BEEP
Sound one beep.
- VOID	Return

	SWPCNTFREQ
Sets the sweep centre frequency to <nrf> Hz. (Lower limit: 1uHz - Upper limit: 50MHz).
[[File:]] -	Frequency
Sets the sweep centre frequency in Hertz(Hz) (1uHz - 50MHz).
- VOID	Return

	SWP
Sets the sweep to <ON> or <OFF>. 0 = ON, 1 = OFF.
[[File:]] -	Sweep
Enable or disable the sweep (0 = ON, 1 = OFF).
- VOID	Return

	BSTTRGSRC
Sets the burst trigger source to; 0 = INT, 1 = EXT, 2 = MAN.
- BYTE	Source
Set the burst trigger source (0 = INT, 1 = EXT, 2 = MAN).
- VOID	Return

	MODPWMFREQ
Sets PWM waveform frequency to <nrf> Hz. (Lower limit: 1uHz - Upper limit: 20kHz).
[[File:]] -	Frequency
Sets PWM waveform frequency in Hertz(Hz) (1uHz - 20kHz).
- VOID	Return

	ARB2Ret
Returns the binary-data from an existing abbitrary wavefrom memory location.
- UINT	Return

	RST
Resets the instrument parameters to their default values.
- VOID	Return

	RMPSYMM
Sets the ramp waveform symmetry to <nrf> %. (Lower limit: 0 - Upper limit: 100)
[[File:]] -	Symmetry
Sets the ramp waveform symmetry in percent (0 - 100).
- VOID	Return

	BSTCOUNT
Sets the burst count to <nrf> cycles, maximum 1048575 cycles.
[[File:]] -	Count
Sets the burst count in cycles (1 - 1048575).
- VOID	Return

	SWPMKR
Sets the sweep marker to <ON> or <OFF>. 0 = ON, 1 = OFF.
[[File:]] -	Marker
Enable or disable the sweep marker (0 = ON, 1 = OFF).
- VOID	Return

	PULSFREQ
Sets the pulse waveform frequency to <nrf> Hz (Lower limit: 1uHz - Upper limit: 50MHz).
[[File:]] -	Frequency
Sets the pulse waveform frequency in Hertz(Hz) (1uHz - 50MHz).
- VOID	Return

	MODFMDEV
Sets FM waveform deviation to <nrf> Hz. (Lower limit: 1uHz - Upper limit: 25MHz).
[[File:]] -	Deviation
Sets FM waveform deviation in Hertz(Hz) (1uHz - 25MHz).
- VOID	Return

	RCL
Recalls the instrument setup contained in store <nrf>.
- BYTE	StoreLocation
Memory location (0-9)
- VOID	Return

	ESESet
Sets the standard event status enable register to the value of <nrf>. (Lower limit: 0 - Upper limit: 255)
- BYTE	Value
Enable the register to this value. (0 - 255)
- VOID	Return

	LOCAL
Returns the instrument to local opertion and unlocks the keyboard.
- VOID	Return

	SWPSPNFREQ
Sets the sweep frequency span to <nrf> Hz. (Lower limit: 1uHz - Upper limit: 50.25kHz).
[[File:]] -	Frequency
Set the sweep frequency span in Hertz(Hz) (1uHz - 50.25kHz).
- VOID	Return

	CALSTEP
Step to the next calibration point.
- VOID	Return

	OPC
Sets the Operation Complete bit (bit 0) in the Standard Event Status Register. This will happen immediately the command is executed because of the sequential nature of all operations.
- VOID	Return

	SRERet
Returns the value of the Service Request Enable Register in <nr1> numeric format.
- BYTE	Return

	MODPMFREQ
Sets PM waveform frequency to <nrf> Hz. (Lower limit: 1uHz - Upper limit: 20kHz).
[[File:]] -	Frequency
Sets FM waveform frequency in Hertz(Hz) (1uHz - 20kHz).
- VOID	Return

	ARBRESIZE
Changes the size of arbritary waveform <cpd> to <nrf>.
[[File:]] -	Size
Size of waveform
- STRING	Waveform
Arbritary Waveform
- VOID	Return

	LRN
Intall data from a previous *LRN? command.
- VOID	Return

	MODPMSHAPE
Sets PM waveform shape to; 0 = SINE, 1 = SQUARE, 2 = RAMPUP, 3 = RAMPDN, 4 = TRIANG, 5 = NOISE, 6 = DC, 7 = SINC, 8 = EXPRISE, 9 = LOGRISE, 10 = ARB1, 11 = ARB2, 12 = ARB3, 13= ARB4.
- BYTE	Shape
Sets PM waveform shape (1 = SINE, 2 = SQUARE, 3 = RAMPUP, 4 = RAMPDN, 5 = TRIANG, 6 = NOISE, 7 = DC, 8 = SINC, 9 = EXPRISE, 10 = LOGRISE, 11 = ARB1, 12 = ARB2, 13 = ARB3, 14= ARB4).
- VOID	Return

	ARB4
Loads the binary-data to an existing arbitrary waveform memory location ARB4.
- BYTE	Waveform
- VOID	Return

	CLKSRRet
Returns the clock source <INT> or <EXT>.
[[File:]] -	Return

	MODPMDEV
Sets PM waveform deviation to <nrf> degrees. (Lower limit: -360° - Upper limit: 360°).
[[File:]] -	Degrees
Sets PM waveform deviation in degrees (-360 - 360).
- VOID	Return

	MSTLOCK
Sends signal to SLAVE generator to get synchronised
- VOID	Return

	HILVL
Sets the amplitude-high-level to <nrf> Volts. (Lower limit: -0.490 V - Upper limit: 5.000 V).
[[File:]] -	HighLevel
Sets the amplitude-high-level in Volts(V) (-0.490 V - 5.000 V).
- VOID	Return

	ARB3
Loads the binary-data to an existing arbitrary waveform memory location ARB3.
- UINT	Waveform
- VOID	Return

	WAVE
Sets the waveform type. 0 = SINE, 1 = SQUARE, 2 = RAMP, 3 = TRIANG, 4 = PULSE, 5 = NOISE, 6 = ARB
- BYTE	WaveType
0 = SINE, 1 = SQUARE, 2 = RAMP, 3 = TRIANG, 4 = PULSE, 5 = NOISE, 6 = ARB.
- VOID	Return

	CALADJ
Adjust the selected calibration value by <nrf> (Lower limit: -100 - Upper limit: 100).
[[File:]] -	Calibrate
Adjust the selected calibration value (-100 - 100).
- VOID	Return

	STBRet
Returns the value of the Status Byte Register in <nr1> numeric format.
- BYTE	Return

	ARB2
Loads the binary-data to an existing arbitrary waveform memory location ARB2.
- UINT	Waveform
- VOID	Return

	EERRet
Query and clear execution error number register.
- STRING	Return

	MODFMSRC
Sets FM waveform source to; 0 INT, 1 = EXT.
[[File:]] -	Source
Sets FM waveform source (0 = INT, 1 = EXT).
- VOID	Return

	MODAMFREQ
Sets AM waveform frequency to <nrf> Hz. (Lower limit: 1uHz - Upper limit: 20kHz).
[[File:]] -	Frequency
Sets AM waveform frequency in Hertz(Hz) (1uHz - 20kHz).
- VOID	Return

	ESE
Sets the Standard Event Status Enable Register to the value of <nrf>.
- BYTE	Value
Value of register 0-255
- VOID	Return

	ARB1
Loads the binary-data to an existing arbitrary waveform memory location ARB1.
- UINT	Waveform
16 Bit binary number for arbitrary waveform.
- VOID	Return

	ARB4DEFRet
Returns user specified waveform name, waveform pint interpolation state and waveform length of ARB4.
- STRING	Return

	CLS
Clears status byte register of the interface.
- VOID	Return

	MSTRELOCK
Resynchronises the two generators in MASTER-SLAVE mode.
- VOID	Return

	NOISLVL
Sets the output noise level to <nr1> %. (Lower limit: 0% - Upper limit: 50%)
- BYTE	Percent
Sets the output noise level in percent. (0 - 50)
- VOID	Return

	LOCKMODE
Sets the synchronising mode to; 0 = MASTER, 1 = SLAVE, 2 = INDEP.
- BYTE	Mode
Sets the synchronising mode (0 = MASTER, 1 = SLAVE, 2 = INDEP).
- VOID	Return

	ADDRESSRet
Returns the instruments address
[[File:]] -	Return

	MODPMSRC
Sets PM waveform source to; 0 INT, 1 = EXT.
[[File:]] -	Source
Sets PM waveform source (0 = INT, 1 = EXT).
- VOID	Return

	MODPWMSRC
Sets PWM waveform source to; 0 = INT, 1 = EXT.
[[File:]] -	Source
Sets PWM waveform source (0 = INT, 1 = EXT).
- VOID	Return

	MOD
Sets modulation to; 0 = OFF, 1 = AM, 2 = FM, 3 = PM, 4 = FSK, 5 = PWM.
- BYTE	Modulation
Sets modulation (0 = OFF, 1 = AM, 2 = FM, 3 = PM, 4 = FSK, 5 = PWM).
- VOID	Return

	ISTRet
Returns IST local message as defined by IEEE Std. 488.2. The syntax of the response is 0<rmt>, if the local message is false, or 1<rmt>, if the local message is true.
[[File:]] -	Return

	LRNRet
Returns the complete setup of the instrument as a binary data block
[[File:]] -	Return

	OPCRet
Query Operation Complete status. The response is always 1<rmt> and will be available immediately the command is executed because all commands are sequential.
[[File:]] -	Return

	SWPTYPE
Sets the sweep type to; 0 = LINUP, 1 = LINDN, 2 = LINUPDN, 3 = LINDNUP, 4 = LOGUP, 5 = LOGDN, 6 = LOGUPDN, 7 = LOGDNUP.
- BYTE	Type
Set the sweep type (0 = LINUP, 1 = LINDN, 2 = LINUPDN, 3 = LINDNUP, 4 = LOGUP, 5 = LOGDN, 6 = LOGUPDN, 7 = LOGDNUP).
- VOID	Return

	PULSRANGE
Sets PWM waveform source to <1>, <2> or <3>; 1 = 1, 2 = 2, 3 = 3.
- BYTE	Range
Sets the pulse rise and fall range. (1, 2 or 3)
- VOID	Return

	TSTRet
The generator has no self test capability and the response is always 0 <rmt>.
[[File:]] -	Return

	BSTTRGPOL
Sets the burst trigger slope to; 0 = POS, 1 = NEG.
[[File:]] -	Slope
Set the burst trigger slope (0 = POS, 1 = NEG).
- VOID	Return

	ARB3Ret
Returns the binary-data from an existing abbitrary wavefrom memory location.
- UINT	Return

	BSTPHASE
Sets the burst phase to <nrf> degrees. (Lower limit: -360 - Upper limit: 360)
[[File:]] -	Degrees
Sets the burst phase in degrees (-360 - 360)
- VOID	Return

	IDNRet
Returns the instrument identification. The IDN is saved to the variable passed from the function 'ReturnIDN'. The return parameter is TRUE when the IDN is successfully returned.
- STRING	ReturnIDN
- STRING	Return

	SWPTRGPER
Sets the sweep trigger period to <nrf> seconds
[[File:]] -	Seconds
Set the sweep trigger period in seconds.
- VOID	Return

	PULSDLY
Sets the waveform delay to <nrf> sec
[[File:]] -	Sec
- VOID	Return

	Initialise
Opens the COM port ready for communications.
- VOID	Return

Property reference

	Properties
	Receive Buffer Size
Buffer used to store incoming data ready for processing. Default 128 Bytes.
	Scan Buffer Size
Buffer used to hold SSID names when performing a SSID network scan. Default 100 Bytes.
	Reset Mode
The initialise automatically resets the WIFI module before establishing communications. Software reset uses an AT command to preform the reset Hardware reset uses an extra I/O pin to toggle the signal to the reset pin on the module.
	Command Termination
Older versions of the firmware require \r to terminate a AT command string. Newer versions of the firmware have changed to use \r\n termination.
	Max Web Pages
Maximum number of individual webpages we can serve up with the component.
	Web Page Timeout
Number of cycles to try and send / receive a webpage before timing out.
	Line Delay
Fixed delay in microseconds sent in between sending a HTML line when running as a web page server.
	Name Page 1
HTML name of webpage 1
	HTML Page 1
HTML content for webpage 1
	Name Page 2
HTML name of webpage 2
	HTML Page 2
HTML content for webpage 2
	Name Page 3
HTML name of webpage 3
	HTML Page 3
HTML content for webpage 3
	Name Page 4
HTML name of webpage 4
	HTML Page 4
HTML content for webpage 4
	Count
Maximum number of outbound string substitutions
	Length 0
Number of bytes to reserve for data string.
	Count
Maximum number of inbound string substitutions
	Length 0
Number of bytes to reserve for data string.
	Data Recorder Traces
Selects if the scope traces are automatically added to the data recorder window or not. Simulation - draws an approximation of the UART data onto the scope trace. ICT - sets up the scope trace for incoming data and adds UART packet decoding at the correct BAUD.
	Console Data
Selects if the console data is automatically generated or not
	Console Columns
Number of characters that can be displayed on a single line of the console.
	Data Source
Simulation data source used to allow the component to connect to various remote devices Nothing - Simulation data is ignored COM port - Routes the communication data to and from a physical or virtual COM port Injector - Routes the communication data via a data injector component on the Panel.
	Connections
	Channel
UART Channel selector Software channels are bit banged using generic I/O pins but are not as reliable as hardware channels. Hardware channels use the selected peripheral on-board the target microcontroller.
	Baud Options
Baud rate option selector
	Baud Rate
	TX
Pin to be used for Transmit data
	TX Remap Pin
Allows the hardware transmit pin to be configured from a list of available pins based on your target device,
	RX
Pin to be used for Receive data
	RX Remap Pin
Allows the hardware receive pin to be configured from a list of available pins based on your target device,
	Reset
WLAN module reset pin connection
	Use Flow Control
Flow Control (Handshake) enable or disable. On: Two I/O pins are used to control the flow of data in and out of the device. Off: Flow control is disabled.
	Simulations
	Label
Text label used to help identify the component on the panel.
	Simulation Method
Decides how to handle the simulation of the component. TCP Base - Allows simulation of the network communications using the TCP Base component and DLL. COM/Injector - Allows the simulation to connect to real hardware or injectors.