Difference between revisions of "Component: PIR Motion (Grove 101020020) (101020020) (Light)"

From Flowcode Help
Jump to navigationJump to search
(Created page with "{| style="width:50%" |- | width="20%" style="color:gray;" | Author | Matrix Ltd |- | width="20%" style="color:gray;" | Version | 1.0 |- | width="20%" style="color:gray...")
 
 
(16 intermediate revisions by 2 users not shown)
Line 5: Line 5:
 
|-
 
|-
 
| width="20%" style="color:gray;" | Version
 
| width="20%" style="color:gray;" | Version
−
| 1.0
+
| 8.0
 
|-
 
|-
 
| width="20%" style="color:gray;" | Category
 
| width="20%" style="color:gray;" | Category
Line 14: Line 14:
 
==PIR Motion (Grove 101020020) component==
 
==PIR Motion (Grove 101020020) component==
 
PIR motion sensor component for digital output sensors. Simulates range sensitivity and output hold.
 
PIR motion sensor component for digital output sensors. Simulates range sensitivity and output hold.
 +
 +
==Version information==
 +
 +
Library Version, Component Version, Date, Author, Info
 +
8, 8.0, 18-09-24, MW, Simulation bug, Fixed Switch and LED indicator not enabled
 +
8, 8.0, 18-09-24, MW, Simulation only - Removed all properties and added a new Movement threshold % property
 +
 
 +
  
 
==Detailed description==
 
==Detailed description==
  
−
''No detailed description exists yet for this component''
 
  
−
==Examples==
 
  
  
−
''<span style="color:red;">No additional examples</span>''
 
  
  
−
==Downloadable 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;" | '''SampleSensor'''
 
−
|-
 
−
| colspan="2" | Returns the state of the sensor. Activated if movement detected in the sensor range.&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;" | '''Initialise'''
 
−
|-
 
−
| colspan="2" | Configures the I/O ready for the sensor to be sampled.&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;" | '''GetAverageInt'''
 
−
|-
 
−
| colspan="2" | Function call to read the ADC as a full width average sample over time &nbsp;
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | NumSamples
 
−
|-
 
−
| colspan="2" | &nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | DelayUs
 
−
|-
 
−
| colspan="2" | Number of micro seconds in between taking each sample&nbsp;
 
−
|-
 
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
 
−
| 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;" | '''GetVoltage'''
 
−
|-
 
−
| colspan="2" | Reads the ADC as a direct voltage&nbsp;
 
−
|-
 
−
|-
 
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:]] -
 
−
| 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;" | '''GetInt'''
 
−
|-
 
−
| colspan="2" | Blocking call to read the ADC at full bit depth &nbsp;
 
−
|-
 
−
|-
 
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
 
−
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
−
|}
 
  
  
 +
 +
 +
 +
 +
 +
 +
''No detailed description exists yet for this component''
 +
 +
==Examples==
 +
 +
 +
 +
A simple example that shows the PIR in action.
 +
 +
{{Fcfile|GrovePIR.fcfx|PIR Example}}
 +
 +
==Macro reference==
 +
 +
===Initialise===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetByte'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
 
|-
 
|-
−
| colspan="2" | Blocking call to read the ADC as a byte &nbsp;
+
| colspan="2" | Configures the I/O ready for the sensor to be sampled.&nbsp;
 
|-
 
|-
 
|-
 
|-
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
+
| 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''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
  
  
 +
===SampleSensor===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SampleSensor'''
 
|-
 
|-
−
| colspan="2" | Initialise the sensor configuration as set by the component properties. Sets the default intigration time and gain as well as enable the sensor.&nbsp;
+
| colspan="2" | Returns the state of the sensor. Activated if movement detected in the sensor range.&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''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
−
 
−
 
  
  
Line 138: Line 95:
 
|-
 
|-
 
|-
 
|-
−
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
−
| width="90%" | Sensitivity
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections
−
|-
 
−
| colspan="2" | Simulation range used to detect object&nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 
−
| width="90%" | Holding Count
 
−
|-
 
−
| colspan="2" | Number of calls to SampleSensor to repeat active state, once triggered&nbsp;
 
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Connections'''
 
 
|-
 
|-
 
|-
 
|-
Line 157: Line 104:
 
| colspan="2" | Pin connected to the sensor element of the photo transistor&nbsp;
 
| colspan="2" | Pin connected to the sensor element of the photo transistor&nbsp;
 
|-
 
|-
−
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Simulations'''
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
 
|-
 
|-
 
|-
 
|-
−
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
−
| width="90%" | Sim Mode
+
| width="90%" | Movement threshold %
 
|-
 
|-
−
| colspan="2" | &nbsp;
+
| colspan="2" | Simulation only. Set threashold difference for detection of movement. E.g. if the slider was on 20 then moved to 40 the differnce is 20 PIR will only be triggered if Movement threshold is set below 20&nbsp;
 
|}
 
|}
 +
 +
==Component Source Code==
 +
 +
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_PIR_Motion_Sensor_Grove.fcfx FC_Comp_Source_PIR_Motion_Sensor_Grove.fcfx]
 +
 +
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_PIR_Motion_Sensor_Grove.fcfx FC_Comp_Source_PIR_Motion_Sensor_Grove.fcfx]

Latest revision as of 21:16, 27 January 2026

Author Matrix Ltd
Version 8.0
Category Light


PIR Motion (Grove 101020020) component

PIR motion sensor component for digital output sensors. Simulates range sensitivity and output hold.

Version information

Library Version, Component Version, Date, Author, Info
8, 8.0, 18-09-24, MW, Simulation bug, Fixed Switch and LED indicator not enabled
8, 8.0, 18-09-24, MW, Simulation only - Removed all properties and added a new Movement threshold % property


Detailed description

No detailed description exists yet for this component

Examples

A simple example that shows the PIR in action.

FC6 Icon.png PIR Example

Macro reference

Initialise

Fc9-comp-macro.png Initialise
Configures the I/O ready for the sensor to be sampled. 
Fc9-void-icon.png - VOID Return


SampleSensor

Fc9-comp-macro.png SampleSensor
Returns the state of the sensor. Activated if movement detected in the sensor range. 
Fc9-u8-icon.png - BYTE Return


Property reference

Fc9-prop-icon.png Properties
Fc9-conn-icon.png Connections
Fc9-type-5-icon.png SIG Pin
Pin connected to the sensor element of the photo transistor 
Fc9-conn-icon.png Simulation
Fc9-type-21-icon.png Movement threshold %
Simulation only. Set threashold difference for detection of movement. E.g. if the slider was on 20 then moved to 40 the differnce is 20 PIR will only be triggered if Movement threshold is set below 20 

Component Source Code

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

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

Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_PIR_Motion_(Grove_101020020)_(101020020)_(Light)&oldid=41904"