Component: Bluetooth (EB024, Generic AT) (Wireless)
| Author | Matrix Ltd. |
| Version | 2.0 (Release) |
| Category | Wireless |
Contents
Bluetooth (EB024, Generic AT) component
Low level routines for controlling a standard AT Bluetooth interface. Also available in the form of the EB024 Bluetooth E-block.
Examples
Making a device discoverable
Example program to set up the Bluetooth module to be discoverable with a pair key. Any data received is then output onto the LCD component. You can connect to the Bluetooth device using a PC with Bluetooth connection and using software such as Flowcode 6, RealTerm or HyperTerminal. Alternatively you can connect using a smart phone running a terminal emulator app or via another embedded Bluetooth board.
Bluetooth Discover
Script 1 contains the AT commands to setup the Bluetooth device to be discoverable with pair key "1234".
Searching for a device
Example program to scan for local discoverable Bluetooth devices. For each device found the MAC address is displayed on to the LCD.
Bluetooth Inquiry
Connecting to a device
Example program to connect to a specific Bluetooth device address and send data to the device.
Bluetooth Connect
The device MAC address is specified using the "CreateCommandString" and "SendCommand" macros.
Downloadable macro reference
StringRead
Returns the ASCII value of character idx of the Response string.
Parameters
- BYTE idx
- Needs to be a equal to or less than the string length of the response in order to retrieve a valid character.
Return value
SendScript
Sends Script idx
Note that the general property Number of Scripts needs to be set so that it allows the scripts to be accessed and sent.
Returns 0 for success and 1 for error
Parameters
- BYTE idx
- Refers to the Script page to send (1-4).
Return value
SendCommand
Sends the command buffer.
Returns 1 for success in sending the command.
Returns 0 for errors.
Parameters
- BYTE ExpectEcho
- Remote module automatically echos back data: 1 = On (Expect echo), 0 = off
- BYTE SendCR
- Automatically adds \n to the end of the command data: 1 = append CR, 0 = no CR.
Return value
CreateCommandString
Assigns a string of characters to the Command buffer.
Returns 1 for success in adding the characters to the buffer.
Returns 0 for errors, including Buffer overflow.
Parameters
- <- STRING Data
- This parameter may be returned back to the caller
Return value
StringReceive
Checks for a response string.
Returns the length of the response string if one is present otherwise returns 0.
Parameters
- This macro has no parameters
Return value
CreateCommand
Adds a single characters to the end of the Command buffer.
Returns 1 for success in adding the characters to the buffer.
Returns 0 for errors, including Buffer overflow.
Parameters
- BYTE Character
- ASCII value or single character,
Return value
Send_byte
No additional information
Parameters
- BYTE ByteVal
Return value
- This call does not return a value
WaitForResponse
Waits for a response message of type response_code for timeout ms.
Returns: 0 for a Response of type response_code
255 (0xFF) for a timeout or invalid response
Response string length for any Response not of type response_code
Parameters
- BYTE response_code
- 1:OK / 2:ERROR / 3:CONNECT / 4:NO CARRIER / 5:AUDIO / 6:PAIR / 7:RING
- BYTE timeout
- The timeout value will need to set to allow sufficient time for the response to arrive.
Return value
Initialise
Required to be used whenever the Bluetooth component is used in a program.
Initialises the Bluetooth component ready for use.
Parameters
- This macro has no parameters
Return value
- This call does not return a value
Simulation macro reference
This component does not contain any simulation macros
Property reference
Command Buffer Size
This property is of type Unsigned integer and can be referenced with the variable name CommandBufferSize.
Maximum number of bytes that can be stored in the outgoing command buffer.
Response Buffer Size
This property is of type Unsigned integer and can be referenced with the variable name ResponseBufferSize.
Maximum number of bytes that can be stored in the incoming response buffer.
Script Count
This property is of type Fixed list of ints and can be referenced with the variable name SCRIPTS.
Controls how many AT scripts are stored into non-volatile memory
Script 1
This property is of type Multiple lines of text and can be referenced with the variable name SCRIPT1.
Data to send for script 0, each command should be terminated with a carriage return
Channel
This property is of type Fixed list of ints and can be referenced with the variable name cal_uart::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.
TX
This property is of type Single digital pin and can be referenced with the variable name cal_uart::TX.
Pin to be used for Transmit data
RX
This property is of type Single digital pin and can be referenced with the variable name cal_uart::RX.
Pin to be used for Receive data
Use Flow Control
This property is of type Fixed list of ints and can be referenced with the variable name cal_uart::FLOWEN.
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.
Baud Options
This property is of type Fixed list of ints and can be referenced with the variable name cal_uart::BAUD_LIST.
Baud rate option selector
Baud Rate
This property is of type Signed integer and can be referenced with the variable name cal_uart::BAUD.
No additional information
Console Columns
This property is of type Unsigned integer and can be referenced with the variable name cal_uart::ConsoleColumns.
Number of characters that can be displayed on a single line of the console.
Console Data
This property is of type True or false and can be referenced with the variable name cal_uart::ConsoleData.
Selects if the console data is automatically generated or not
Scope Traces
This property is of type True or false and can be referenced with the variable name cal_uart::ScopeTraces.
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.
Data Source
This property is of type Fixed list of ints and can be referenced with the variable name cal_uart::DataSource.
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.
Injector
This property is of type Fixed list of ints and can be referenced with the variable name cal_uart::Injector.
Selects which injector component to route the communication data via.
Add injector components to the panel before they will be available in this list.
Injector components are available from the Comms component category.
