Component: Sense Hat (Raspberry Pi Hat): Difference between revisions

Revision as of 09:59, 27 January 2023

Author	Matrix TSL
Version	1.0
Category	Raspberry Pi Hat

Sense Hat component

A component to drive various features on the Raspberry Pi Sense Hat. Supported Features: 8x8 RGB LED / 5-Way Joystick

Component Source Code

Please click here to download the component source project: FC_Comp_Source_RPI_SenseHat.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_RPI_SenseHat.fcfx

Detailed description

No detailed description exists yet for this component

Examples

A simple example to sample the joystick and output a fixed colour to all 8 x 8 RGB LEDs. Pressing up on the joystick outputs blue to the LEDs and pressing down outputs red.

RPI Sense HAT

Macro reference

	ReadJoystick
Reads the joystick Returns the direction as a bit field. 1 = Down / 2 = Right / 4 = Up / 8 = Click / 16 = Left
- BYTE	Return

	SetPixel
Seta the colour of a single pixel
- BYTE	X

- BYTE	Y

- BYTE	R

- BYTE	G

- BYTE	B

- VOID	Return

	SetAll
Sets all pixels to a specific colour
- BYTE	R

- BYTE	G

- BYTE	B

- VOID	Return

	Initialise
Initialises the I2C peripheral ready for communications.
- VOID	Return

Property reference

	Properties
	I2C
	Channel
Channel selection
	SDA
Pin used for SDA (data signal)
	SCL
Pin used for SCL (clock signal)
	Stop Delay
On older microcontroller devices there is a potential for the I2C hardware channel to lock up if there is not a 10ms delay between an I2C stop event and the next I2C start event. Most modern microcontrollers will not have a problem so this property can be disabled to speed up the I2C communications.
	Baud Select
Baud rate option selector
	Baud Rate
Baud rate to be used
	Simulation
	Scope Traces
Selects if the component pin connections are automatically generated on the data recorder window or not. Yes: Automatically add the component pins to a group on the data recorder which will reflect the sim data during simultion. No: Do not show the pin signals on the data recorder window.
	Console Data
Selects if the console data is automatically generated or not
	API

==Macro reference==

	ReadJoystick
Reads the joystick Returns the direction as a bit field. 1 = Down / 2 = Right / 4 = Up / 8 = Click / 16 = Left
- BYTE	Return

	SetPixel
Seta the colour of a single pixel
- BYTE	X

- BYTE	Y

- BYTE	R

- BYTE	G

- BYTE	B

- VOID	Return

	SetAll
Sets all pixels to a specific colour
- BYTE	R

- BYTE	G

- BYTE	B

- VOID	Return

	Initialise
Initialises the I2C peripheral ready for communications.
- VOID	Return

Property reference

	Properties
	I2C
	Channel
Channel selection
	SDA
Pin used for SDA (data signal)
	SCL
Pin used for SCL (clock signal)
	Stop Delay
On older microcontroller devices there is a potential for the I2C hardware channel to lock up if there is not a 10ms delay between an I2C stop event and the next I2C start event. Most modern microcontrollers will not have a problem so this property can be disabled to speed up the I2C communications.
	Baud Select
Baud rate option selector
	Baud Rate
Baud rate to be used
	Simulation
	Scope Traces
Selects if the component pin connections are automatically generated on the data recorder window or not. Yes: Automatically add the component pins to a group on the data recorder which will reflect the sim data during simultion. No: Do not show the pin signals on the data recorder window.
	Console Data
Selects if the console data is automatically generated or not
	API

==Macro reference==

	ReadJoystick
Reads the joystick Returns the direction as a bit field. 1 = Down / 2 = Right / 4 = Up / 8 = Click / 16 = Left
- BYTE	Return

	SetPixel
Seta the colour of a single pixel
- BYTE	X

- BYTE	Y

- BYTE	R

- BYTE	G

- BYTE	B

- VOID	Return

	SetAll
Sets all pixels to a specific colour
- BYTE	R

- BYTE	G

- BYTE	B

- VOID	Return

	Initialise
Initialises the I2C peripheral ready for communications.
- VOID	Return

Property reference

	Properties
	I2C
	Channel
Channel selection
	SDA
Pin used for SDA (data signal)
	SCL
Pin used for SCL (clock signal)
	Stop Delay
On older microcontroller devices there is a potential for the I2C hardware channel to lock up if there is not a 10ms delay between an I2C stop event and the next I2C start event. Most modern microcontrollers will not have a problem so this property can be disabled to speed up the I2C communications.
	Baud Select
Baud rate option selector
	Baud Rate
Baud rate to be used
	Simulation
	Scope Traces
Selects if the component pin connections are automatically generated on the data recorder window or not. Yes: Automatically add the component pins to a group on the data recorder which will reflect the sim data during simultion. No: Do not show the pin signals on the data recorder window.
	Console Data
Selects if the console data is automatically generated or not
	API

==Macro reference==

	ReadJoystick
Reads the joystick Returns the direction as a bit field. 1 = Down / 2 = Right / 4 = Up / 8 = Click / 16 = Left
- BYTE	Return

	SetPixel
Seta the colour of a single pixel
- BYTE	X

- BYTE	Y

- BYTE	R

- BYTE	G

- BYTE	B

- VOID	Return

	SetAll
Sets all pixels to a specific colour
- BYTE	R

- BYTE	G

- BYTE	B

- VOID	Return

	Initialise
Initialises the I2C peripheral ready for communications.
- VOID	Return

Property reference

	Properties
	I2C
	Channel
Channel selection
	SDA
Pin used for SDA (data signal)
	SCL
Pin used for SCL (clock signal)
	Stop Delay
On older microcontroller devices there is a potential for the I2C hardware channel to lock up if there is not a 10ms delay between an I2C stop event and the next I2C start event. Most modern microcontrollers will not have a problem so this property can be disabled to speed up the I2C communications.
	Baud Select
Baud rate option selector
	Baud Rate
Baud rate to be used
	Simulation
	Scope Traces
Selects if the component pin connections are automatically generated on the data recorder window or not. Yes: Automatically add the component pins to a group on the data recorder which will reflect the sim data during simultion. No: Do not show the pin signals on the data recorder window.
	Console Data
Selects if the console data is automatically generated or not
	API

@@ Line 17: / Line 17: @@
 ==Component Source Code==
-Please click here to download the component source project: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_RPI_SenseHat.fcfx FC_Comp_Source_RPI_SenseHat.fcfx]
+Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_RPI_SenseHat.fcfx FC_Comp_Source_RPI_SenseHat.fcfx]
 Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_RPI_SenseHat.fcfx FC_Comp_Source_RPI_SenseHat.fcfx]
 ==Detailed description==
@@ Line 36: / Line 38: @@
 ==Examples==
@@ Line 54: / Line 58: @@
 ==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;" | '''ReadJoystick'''
+|-
+| colspan="2" | Reads the joystick Returns the direction as a bit field. 1 = Down / 2 = Right / 4 = Up / 8 = Click / 16 = Left&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;"
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetPixel'''
+|-
+| colspan="2" | Seta the colour of a single pixel&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | X
+|-
+| colspan="2" | &nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Y
+|-
+| colspan="2" | &nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | R
+|-
+| colspan="2" | &nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | G
+|-
+| colspan="2" | &nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | B
+|-
+| colspan="2" | &nbsp;
+|-
+| 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''
+|}
+{| 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;" | '''SetAll'''
+|-
+| colspan="2" | Sets all pixels to a specific colour&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | R
+|-
+| colspan="2" | &nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | G
+|-
+| colspan="2" | &nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | B
+|-
+| colspan="2" | &nbsp;
+|-
+| 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''
+|}
+{| 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" | Initialises the I2C peripheral ready for communications.&nbsp;
+|-
+|-
+| 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;" | I2C
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
+| width="90%" | Channel
+|-
+| colspan="2" | Channel selection&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
+| width="90%" | SDA
+|-
+| colspan="2" | Pin used for SDA (data signal)&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
+| width="90%" | SCL
+|-
+| colspan="2" | Pin used for SCL (clock signal)&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
+| width="90%" | Stop Delay
+|-
+| colspan="2" | On older microcontroller devices there is a potential for the I2C hardware channel to lock up if there is not  a 10ms delay between an I2C stop event and the next I2C start event.  Most modern microcontrollers will not have a problem so this property can be disabled to speed up the  I2C communications. &nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
+| width="90%" | Baud Select
+|-
+| colspan="2" | Baud rate option selector&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
+| width="90%" | Baud Rate
+|-
+| colspan="2" | Baud rate to be used&nbsp;
+|-
+| 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 component pin connections are automatically generated on the data recorder window or not. Yes: Automatically add the component pins to a group on the data recorder which will reflect the sim data during simultion. No: Do not show the pin signals on the data recorder window.&nbsp;
+|-
+| 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&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
+| width="90%" | API
+|-
+| colspan="2" | &nbsp;
+|}==Macro reference==
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"

Wiki bot (talk | contribs)

Revision as of 09:59, 27 January 2023

Sense Hat component

Component Source Code

Detailed description

Examples

Macro reference

Property reference

Property reference

Property reference

Property reference