Difference between revisions of "Component: Bluetooth (HC05 HC06) (Wireless)"
(XML import BR) |
(XML import) |
||
Line 7: | Line 7: | ||
|- | |- | ||
| width="20%" style="color: gray;" | Version | | width="20%" style="color: gray;" | Version | ||
− | | | + | | 2.0 (Release) |
|- | |- | ||
| width="20%" style="color: gray;" | Category | | width="20%" style="color: gray;" | Category | ||
Line 67: | Line 67: | ||
'''Parameters''' | '''Parameters''' | ||
− | :[[Variable Types| | + | :[[Variable Types|BOOL]] ''Baud'' |
− | ::1=1200, 2=2400, 3=4800, 4=9600, 5=19200, 6=38400, | + | ::1=1200, 2=2400, 3=4800, 4=9600, 5=19200, 6=NA, 7=38400, 8=57600, 9=115200 |
+ | |||
+ | |||
+ | '''Return value''' | ||
+ | |||
+ | :''This call does not return a value'' | ||
+ | |||
+ | |||
+ | ===<span style="font-weight: normal;"><u><tt>SendCommand</tt></u></span>=== | ||
+ | Sends a command string to the HC05/HC06 module. | ||
+ | |||
+ | '''Parameters''' | ||
+ | |||
+ | :[[Variable Types|<- STRING]] ''Command'' | ||
+ | ::''This parameter may be returned back to the caller'' | ||
Line 164: | Line 178: | ||
==Simulation macro reference== | ==Simulation macro reference== | ||
− | ===<span style="font-weight: normal;"><u> | + | ''This component does not contain any simulation macros'' |
− | + | ||
+ | |||
+ | ==Property reference== | ||
+ | <span style="font-weight: normal;"><u>Data Bits</u></span> | ||
+ | |||
+ | This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_uart::DBITS''. | ||
− | + | Number of data bits | |
− | : | + | <span style="font-weight: normal;"><u>Return</u></span> |
+ | This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_uart::RETURN''. | ||
− | + | Return data width from Receive macro. | |
− | + | 8-bit data mode always returns a byte ranging from 0-255, 255 could mean a timeout or could be a valid data. | |
+ | 16-bit data mode rereturns 0-255 for valid data, 256 for a timeout, return data must be stored into an INT or UINT variable. | ||
+ | <span style="font-weight: normal;"><u>Echo</u></span> | ||
+ | This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_uart::ECHO''. | ||
− | + | Echo selection | |
− | |||
− | + | <span style="font-weight: normal;"><u>Baud Options</u></span> | |
− | + | 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 | |
<span style="font-weight: normal;"><u>Baud Rate</u></span> | <span style="font-weight: normal;"><u>Baud Rate</u></span> | ||
− | This property is of type '' | + | This property is of type ''Signed integer'' and can be referenced with the variable name ''cal_uart::BAUD''. |
− | + | ''<span style="color:red;">No additional information</span>'' | |
− | |||
− | |||
− | This property is of type ''Fixed list of ints'' and can be referenced with the variable name '' | + | <span style="font-weight: normal;"><u>Channel</u></span> |
+ | |||
+ | 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. | |
− | <span style="font-weight: normal;"><u> | + | <span style="font-weight: normal;"><u>Use TX</u></span> |
− | This property is of type '' | + | This property is of type ''True or false'' and can be referenced with the variable name ''cal_uart::UseTX''. |
− | + | Selects if the Transmit pin is used by the component. | |
− | + | Yes: The TX pin is active and used to transmit data for the UART. | |
− | + | No: The TX pin is disabled and free to be used as general I/O. | |
− | <span style="font-weight: normal;"><u> | + | <span style="font-weight: normal;"><u>TX</u></span> |
− | This property is of type '' | + | 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 | |
− | <span style="font-weight: normal;"><u> | + | <span style="font-weight: normal;"><u>Use RX</u></span> |
− | This property is of type '' | + | This property is of type ''True or false'' and can be referenced with the variable name ''cal_uart::UseRX''. |
− | + | Selects if the Receive pin is used by the component. | |
− | + | Yes: The RX pin is active and used to receive data for the UART. | |
− | + | No: The RX pin is disabled and free to be used as general I/O. | |
− | + | <span style="font-weight: normal;"><u>RX</u></span> | |
− | + | 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 | |
− | + | <span style="font-weight: normal;"><u>Use Flow Control</u></span> | |
− | + | 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. | |
<span style="font-weight: normal;"><u>Label</u></span> | <span style="font-weight: normal;"><u>Label</u></span> | ||
Line 252: | Line 278: | ||
<span style="font-weight: normal;"><u>Scope Traces</u></span> | <span style="font-weight: normal;"><u>Scope Traces</u></span> | ||
− | This property is of type ''True or false'' and can be referenced with the variable name ''ScopeTraces''. | + | 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. | |
<span style="font-weight: normal;"><u>Console Data</u></span> | <span style="font-weight: normal;"><u>Console Data</u></span> | ||
− | This property is of type ''True or false'' and can be referenced with the variable name ''ConsoleData''. | + | 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 | Selects if the console data is automatically generated or not | ||
Line 264: | Line 294: | ||
<span style="font-weight: normal;"><u>Console Columns</u></span> | <span style="font-weight: normal;"><u>Console Columns</u></span> | ||
− | This property is of type ''Unsigned integer'' and can be referenced with the variable name ''ConsoleColumns''. | + | 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. | Number of characters that can be displayed on a single line of the console. | ||
Line 270: | Line 300: | ||
<span style="font-weight: normal;"><u>Data Source</u></span> | <span style="font-weight: normal;"><u>Data Source</u></span> | ||
− | This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''DataSource''. | + | 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 | + | 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. |
Latest revision as of 10:26, 9 May 2018
Author | Matrix Ltd |
Version | 2.0 (Release) |
Category | Wireless |
Contents
Bluetooth (HC05 HC06) component
Low level routines for controlling or interacting with a HC05 or HC06 Bluetooth module. Contains functions to allow the baud rate, bluetooth name and bluetooth key to be defined.
Examples
Example Program that configures a HC05 / HC06 Bluetooth module and then allows a data connection to be established and utilised.
Incoming data will be displayed on an LCD.
Outgoing data is assigned and sent using a keypad component.
HC05 Example
Downloadable macro reference
SetPairKey
Sets the Bluetooth pair key stored in the Bluetooth module's ROM.
Commands must be sent before Bluetooth communications are estabished e.g. right after power on and initialisation.
Parameters
- STRING Key
- Four digit pair key e.g. "0000" or "1234"
Return value
- This call does not return a value
SendString
Sends out a string of bytes from the UART interface.
Parameters
- <- STRING Data
- This parameter may be returned back to the caller
Return value
- This call does not return a value
SetBaud
Sets the Bluetooth baud rate stored in the Bluetooth module's ROM.
Commands must be sent before Bluetooth communications are estabished e.g. right after power on and initialisation.
Parameters
- BOOL Baud
- 1=1200, 2=2400, 3=4800, 4=9600, 5=19200, 6=NA, 7=38400, 8=57600, 9=115200
Return value
- This call does not return a value
SendCommand
Sends a command string to the HC05/HC06 module.
Parameters
- <- STRING Command
- This parameter may be returned back to the caller
Return value
- This call does not return a value
SendNumber
Sends out a number as an ASCII String from the UART interface.
Parameters
- <- LONG Number
- This parameter may be returned back to the caller
Return value
- This call does not return a value
SendChar
Sends out a single packet from the UART interface.
Parameters
- INT Char
Return value
- This call does not return a value
SetName
Sets the Bluetooth Friendly name stored in the Bluetooth module's ROM.
Commands must be sent before Bluetooth communications are estabished e.g. right after power on and initialisation.
Parameters
- STRING Name
- Name you wish to provide to the module
Return value
- This call does not return a value
ReceiveString
Attempts to receive a string of bytes from the UART interface.
Parameters
- BYTE Timeout
- BYTE NumBytes
Return value
Initialise
Sets up the RS232 peripheral, must be called at the start of your program or at least before you start calling any other RS232 macros.
Parameters
- This macro has no parameters
Return value
- This call does not return a value
ReceiveChar
Attempts to receive a single packet from the UART interface.
Parameters
- INT Timeout
- Time to wait for valid data before returning, 0=Dont wait, 255=Wait forever.
Return value
Simulation macro reference
This component does not contain any simulation macros
Property reference
Data Bits
This property is of type Fixed list of ints and can be referenced with the variable name cal_uart::DBITS.
Number of data bits
Return
This property is of type Fixed list of ints and can be referenced with the variable name cal_uart::RETURN.
Return data width from Receive macro.
8-bit data mode always returns a byte ranging from 0-255, 255 could mean a timeout or could be a valid data.
16-bit data mode rereturns 0-255 for valid data, 256 for a timeout, return data must be stored into an INT or UINT variable.
Echo
This property is of type Fixed list of ints and can be referenced with the variable name cal_uart::ECHO.
Echo selection
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
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.
Use TX
This property is of type True or false and can be referenced with the variable name cal_uart::UseTX.
Selects if the Transmit pin is used by the component.
Yes: The TX pin is active and used to transmit data for the UART.
No: The TX pin is disabled and free to be used as general I/O.
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
Use RX
This property is of type True or false and can be referenced with the variable name cal_uart::UseRX.
Selects if the Receive pin is used by the component.
Yes: The RX pin is active and used to receive data for the UART.
No: The RX pin is disabled and free to be used as general I/O.
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.
Label
This property is of type Line of text and can be referenced with the variable name label.
Textual label shown on the component I/O flasher
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.
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
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.
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.