Difference between revisions of "Component: Heelight Sensor (Grove 101020312) (101020312) (Audio)"
From Flowcode Help
Jump to navigationJump to search| Line 17: | Line 17: | ||
==Component Source Code== | ==Component Source Code== | ||
| − | Please click here to download the component source project: [https://www.flowcode.co.uk/ | + | Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Heelight_Sensor.fcfx FC_Comp_Source_Heelight_Sensor.fcfx] |
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Heelight_Sensor.fcfx FC_Comp_Source_Heelight_Sensor.fcfx] | Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Heelight_Sensor.fcfx FC_Comp_Source_Heelight_Sensor.fcfx] | ||
==Detailed description== | ==Detailed description== | ||
| + | |||
| + | |||
| Line 44: | Line 46: | ||
==Examples== | ==Examples== | ||
| + | |||
| + | |||
| Line 68: | Line 72: | ||
==Macro reference== | ==Macro reference== | ||
| + | |||
| + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadData''' | ||
| + | |- | ||
| + | | colspan="2" | Reads data received from the listen macro. | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | Index | ||
| + | |- | ||
| + | | colspan="2" | Data Byte Received Range: 0-3 | ||
| + | |- | ||
| + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
| + | |} | ||
| + | |||
| + | |||
| + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ListenForCommand''' | ||
| + | |- | ||
| + | | colspan="2" | Listens for a Heelight command with timeout. Returns 1 if a command received. Returns 0 if no command was received. | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | Timeout | ||
| + | |- | ||
| + | | colspan="2" | 0=Don't Wait, 1-254=MilliSec Delay, 255=Wait Forever | ||
| + | |- | ||
| + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
| + | |} | ||
| + | |||
| + | |||
| + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise''' | ||
| + | |- | ||
| + | | colspan="2" | Sets up the UART peripheral ready to receive messages from the Heelight sensor. | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID | ||
| + | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
| + | |} | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | ==Property reference== | ||
| + | |||
| + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties''' | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | ||
| + | | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | ||
| + | | width="90%" | Channel | ||
| + | |- | ||
| + | | colspan="2" | UART Channel selector | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-5-icon.png]] | ||
| + | | width="90%" | TX | ||
| + | |- | ||
| + | | colspan="2" | Pin to be used for Transmit data | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-5-icon.png]] | ||
| + | | width="90%" | RX | ||
| + | |- | ||
| + | | colspan="2" | Pin to be used for Receive data | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | ||
| + | | width="90%" | Baud Options | ||
| + | |- | ||
| + | | colspan="2" | Baud rate option selector | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-14-icon.png]] | ||
| + | | width="90%" | Baud Rate | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | ||
| + | | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | ||
| + | | width="90%" | Scope Traces | ||
| + | |- | ||
| + | | colspan="2" | 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. | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | ||
| + | | width="90%" | Console Data | ||
| + | |- | ||
| + | | colspan="2" | Selects if the console data is automatically generated or not | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-21-icon.png]] | ||
| + | | width="90%" | Console Columns | ||
| + | |- | ||
| + | | colspan="2" | Number of characters that can be displayed on a single line of the console. | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | ||
| + | | width="90%" | Data Source | ||
| + | |- | ||
| + | | colspan="2" | 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 API - Routes the communication data via a data API component on the Panel. | ||
| + | |}==Macro reference== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
Revision as of 09:57, 27 January 2023
| Author | Matrix Ltd |
| Version | 2.0 |
| Category | Audio |
Contents
Heelight Sensor (Grove 101020312) component
Heelight Sensor is a smart voice sensor that can recognize up tp 500 digital voice commands. It was originally used on the Heelight – a smart colorful bulb that can be controlled by digital sound waves. Allows you to realize smart control in your own projects. Compatible with Heelight smart phone apps and other Heelight controllers.
Component Source Code
Please click here to download the component source project: FC_Comp_Source_Heelight_Sensor.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_Heelight_Sensor.fcfx
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Macro reference
|
ReadData |
| Reads data received from the listen macro. | |
 - BYTE
|
Index |
| Data Byte Received Range: 0-3 | |
| - BYTE
|
Return |
|
|
ListenForCommand |
| Listens for a Heelight command with timeout. Returns 1 if a command received. Returns 0 if no command was received. | |
| - BYTE
|
Timeout |
| 0=Don't Wait, 1-254=MilliSec Delay, 255=Wait Forever | |
| - BYTE
|
Return |
|
|
Initialise |
| Sets up the UART peripheral ready to receive messages from the Heelight sensor. | |
 - VOID
|
Return |
Property reference
|
Properties |
|
Connections |
|
Channel |
| UART Channel selector | |
|
TX |
| Pin to be used for Transmit data | |
|
|
RX |
| Pin to be used for Receive data | |
|
|
Baud Options |
| Baud rate option selector | |
|
Baud Rate |
|
|
Simulation |
|
Scope 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 API - Routes the communication data via a data API component on the Panel. | |
==Macro reference==
|
|
ReadData |
| Reads data received from the listen macro. | |
| - BYTE
|
Index |
| Data Byte Received Range: 0-3 | |
| - BYTE
|
Return |
|
|
ListenForCommand |
| Listens for a Heelight command with timeout. Returns 1 if a command received. Returns 0 if no command was received. | |
| - BYTE
|
Timeout |
| 0=Don't Wait, 1-254=MilliSec Delay, 255=Wait Forever | |
| - BYTE
|
Return |
|
|
Initialise |
| Sets up the UART peripheral ready to receive messages from the Heelight sensor. | |
| - VOID
|
Return |
Property reference
|
|
Properties |
|
|
Connections |
|
|
Channel |
| UART Channel selector | |
|
|
TX |
| Pin to be used for Transmit data | |
|
|
RX |
| Pin to be used for Receive data | |
|
|
Baud Options |
| Baud rate option selector | |
|
|
Baud Rate |
|
|
Simulation |
|
|
Scope 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 API - Routes the communication data via a data API component on the Panel. | |
==Macro reference==
|
|
ReadData |
| Reads data received from the listen macro. | |
| - BYTE
|
Index |
| Data Byte Received Range: 0-3 | |
| - BYTE
|
Return |
|
|
ListenForCommand |
| Listens for a Heelight command with timeout. Returns 1 if a command received. Returns 0 if no command was received. | |
| - BYTE
|
Timeout |
| 0=Don't Wait, 1-254=MilliSec Delay, 255=Wait Forever | |
| - BYTE
|
Return |
|
|
Initialise |
| Sets up the UART peripheral ready to receive messages from the Heelight sensor. | |
| - VOID
|
Return |
Property reference
|
|
Properties |
|
|
Connections |
|
|
Channel |
| UART Channel selector | |
|
|
TX |
| Pin to be used for Transmit data | |
|
|
RX |
| Pin to be used for Receive data | |
|
|
Baud Options |
| Baud rate option selector | |
|
|
Baud Rate |
|
|
Simulation |
|
|
Scope 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 API - Routes the communication data via a data API component on the Panel. | |
==Macro reference==
|
|
ReadData |
| Reads data received from the listen macro. | |
| - BYTE
|
Index |
| Data Byte Received Range: 0-3 | |
| - BYTE
|
Return |
|
|
ListenForCommand |
| Listens for a Heelight command with timeout. Returns 1 if a command received. Returns 0 if no command was received. | |
| - BYTE
|
Timeout |
| 0=Don't Wait, 1-254=MilliSec Delay, 255=Wait Forever | |
| - BYTE
|
Return |
|
|
Initialise |
| Sets up the UART peripheral ready to receive messages from the Heelight sensor. | |
| - VOID
|
Return |
Property reference
|
|
Properties |
|
|
Connections |
|
|
Channel |
| UART Channel selector | |
|
|
TX |
| Pin to be used for Transmit data | |
|
|
RX |
| Pin to be used for Receive data | |
|
|
Baud Options |
| Baud rate option selector | |
|
|
Baud Rate |
|
|
Simulation |
|
|
Scope 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 API - Routes the communication data via a data API component on the Panel. | |
