Component: Heelight Sensor (Grove 101020312) (101020312) (Audio): Difference between revisions

Latest revision as of 14:37, 13 July 2026

Author	Matrix Ltd
Version	2.0
Category	Audio

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

Initialise

	Initialise
Sets up the UART peripheral ready to receive messages from the Heelight sensor.
- VOID	Return

ListenForCommand

	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

ReadData

	ReadData
Reads data received from the listen macro.
- BYTE	Index
Data Byte Received Range: 0-3
- BYTE	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.

@@ Line 73: / Line 73: @@
 ''<span style="color:red;">No additional examples</span>''
@@ Line 79: / Line 87: @@
 ==Macro reference==
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+===Initialise===
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadData'''
+| width="90%" class="mtx-class-macrohead" | '''Initialise'''
 |-
-| colspan="2" | Reads data received from the listen macro.&nbsp;
+| colspan="2" | Sets up the UART peripheral ready to receive messages from the Heelight sensor.&nbsp;
 |-
 |-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
-| width="90%" | Index
-|-
-| colspan="2" | Data Byte Received Range: 0-3&nbsp;
-|-
-| 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;"
+===ListenForCommand===
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ListenForCommand'''
+| width="90%" class="mtx-class-macrohead" | '''ListenForCommand'''
 |-
 | colspan="2" | Listens for a Heelight command with timeout.  Returns 1 if a command received. Returns 0 if no command was received.&nbsp;
@@ Line 115: / Line 120: @@
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+===ReadData===
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
+| width="90%" class="mtx-class-macrohead" | '''ReadData'''
 |-
-| colspan="2" | Sets up the UART peripheral ready to receive messages from the Heelight sensor.&nbsp;
+| colspan="2" | Reads data received from the listen macro.&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Index
 |-
+| colspan="2" | Data Byte Received Range: 0-3&nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
+| 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''
 |}
 ==Property reference==
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
+| width="90%" class="mtx-class-macrohead" | '''Properties'''
 |-
 |-
-| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
+| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
-| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections
+| width="90%" class="mtx-class-propfolder" | Connections
 |-
 |-
@@ Line 167: / Line 176: @@
 | colspan="2" | &nbsp;
 |-
-| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
+| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
-| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
+| width="90%" class="mtx-class-propfolder" | Simulation
 |-
 |-

SteveT (talk | contribs)