Jump to content

Component: Ambient Light (BH1750FVI) (Light): Difference between revisions

From Flowcode Help
No edit summary
m Text replacement - "style="background-color:#EAE1EA;"" to "class="mtx-class-propfolder""
 
(15 intermediate revisions by 2 users not shown)
Line 17: Line 17:
==Component Source Code==
==Component Source Code==


Please click here for the component source code: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_AmbientLight_BH1750FVI.fcfx FC_Comp_Source_AmbientLight_BH1750FVI.fcfx]
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_AmbientLight_BH1750FVI.fcfx FC_Comp_Source_AmbientLight_BH1750FVI.fcfx]
 
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_AmbientLight_BH1750FVI.fcfx FC_Comp_Source_AmbientLight_BH1750FVI.fcfx]


==Detailed description==
==Detailed description==




Line 36: Line 50:


==Examples==
==Examples==




Line 51: Line 77:
''<span style="color:red;">No additional examples</span>''
''<span style="color:red;">No additional examples</span>''


==Downloadable macro reference==


{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
 
 
 
 
 
 
 
 
==Macro reference==
 
===ChangeMeasurementTime===
{| 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;" | '''ContinuousMeasurement'''
| width="90%" class="mtx-class-macrohead" | '''ChangeMeasurementTime'''
|-
|-
| colspan="2" | Powers up and starts the continous measurement mode. Delays in between measurements readings must be provided by the user,&nbsp;
| colspan="2" | Adjusts the measurement result to counteract influence of the optical window.&nbsp;
|-
|-
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Resolution
| width="90%" | Sensitvity
|-
|-
| colspan="2" | 0=1lx (120ms) / 1=0.5lx (120ms) / 2 = 4lx (16ms)&nbsp;
| colspan="2" | Range: 31-254 / Default: 69&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-void-icon.png]] - VOID
Line 71: Line 108:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===ContinuousMeasurement===
{| 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;" | '''OneTimeMeasurement'''
| width="90%" class="mtx-class-macrohead" | '''ContinuousMeasurement'''
|-
|-
| colspan="2" | Powers up and starts a single measurement before returning to power down mode. Waits for the measurement to be ready and returns the value.&nbsp;
| colspan="2" | Powers up and starts the continous measurement mode. Delays in between measurements readings must be provided by the user,&nbsp;
|-
|-
|-
|-
Line 84: Line 122:
| colspan="2" | 0=1lx (120ms) / 1=0.5lx (120ms) / 2 = 4lx (16ms)&nbsp;
| colspan="2" | 0=1lx (120ms) / 1=0.5lx (120ms) / 2 = 4lx (16ms)&nbsp;
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
| 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''
|}
|}




{| 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;" | '''PowerDown'''
| width="90%" class="mtx-class-macrohead" | '''Initialise'''
|-
|-
| colspan="2" | Power Down the Device&nbsp;
| colspan="2" | Stes up the I2C bus and initialises the termperature sensor ready for use.&nbsp;
|-
|-
|-
|-
Line 102: Line 141:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===OneTimeMeasurement===
{| 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;" | '''ChangeMeasurementTime'''
| width="90%" class="mtx-class-macrohead" | '''OneTimeMeasurement'''
|-
|-
| colspan="2" | Adjusts the measurement result to counteract influence of the optical window.&nbsp;
| colspan="2" | Powers up and starts a single measurement before returning to power down mode. Waits for the measurement to be ready and returns the value.&nbsp;
|-
|-
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Sensitvity
| width="90%" | Resolution
|-
|-
| colspan="2" | Range: 31-254 / Default: 69&nbsp;
| colspan="2" | 0=1lx (120ms) / 1=0.5lx (120ms) / 2 = 4lx (16ms)&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-u16-icon.png]] - UINT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===PowerDown===
{| 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;" | '''ReadMeasurement'''
| width="90%" class="mtx-class-macrohead" | '''PowerDown'''
|-
|-
| colspan="2" | Reads data from the Light Sensor as a 16-bit value.&nbsp;
| colspan="2" | Power Down the Device&nbsp;
|-
|-
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
| 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''
|}
|}




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===ReadMeasurement===
{| 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;" | '''ResetMeasurement'''
| width="90%" class="mtx-class-macrohead" | '''ReadMeasurement'''
|-
|-
| colspan="2" | Resets the device measurement register, Must be in the powered up state to do this.&nbsp;
| colspan="2" | Reads data from the Light Sensor as a 16-bit value.&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-u16-icon.png]] - UINT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===ResetMeasurement===
{| 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" | '''ResetMeasurement'''
|-
|-
| colspan="2" | Stes up the I2C bus and initialises the termperature sensor ready for use.&nbsp;
| colspan="2" | Resets the device measurement register, Must be in the powered up state to do this.&nbsp;
|-
|-
|-
|-
Line 157: Line 200:
| width="90%" style="border-top: 2px solid #000;" | ''Return''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}




==Property reference==
==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;" | I2C Properties
| width="90%" class="mtx-class-propfolder" | I2C Properties
|-
|-
|-
|-
Line 213: Line 254:
| 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;
| 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" 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
|-
|-
|-
|-

Latest revision as of 14:36, 13 July 2026

Author Matrix TSL
Version 1.0
Category Light


Ambient Light component

A small PCB surface mount ambient light sensor with a I2C bus interface. Spectral responsibility is approximately human eye response. Wide range and High resolution. ( 1 - 65535 lx )

Component Source Code

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

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

Detailed description

No detailed description exists yet for this component

Examples

No additional examples






Macro reference

ChangeMeasurementTime

ChangeMeasurementTime
Adjusts the measurement result to counteract influence of the optical window. 
- BYTE Sensitvity
Range: 31-254 / Default: 69 
- VOID Return


ContinuousMeasurement

ContinuousMeasurement
Powers up and starts the continous measurement mode. Delays in between measurements readings must be provided by the user, 
- BYTE Resolution
0=1lx (120ms) / 1=0.5lx (120ms) / 2 = 4lx (16ms) 
- VOID Return


Initialise

Initialise
Stes up the I2C bus and initialises the termperature sensor ready for use. 
- VOID Return


OneTimeMeasurement

OneTimeMeasurement
Powers up and starts a single measurement before returning to power down mode. Waits for the measurement to be ready and returns the value. 
- BYTE Resolution
0=1lx (120ms) / 1=0.5lx (120ms) / 2 = 4lx (16ms) 
- UINT Return


PowerDown

PowerDown
Power Down the Device 
- VOID Return


ReadMeasurement

ReadMeasurement
Reads data from the Light Sensor as a 16-bit value. 
- UINT Return


ResetMeasurement

ResetMeasurement
Resets the device measurement register, Must be in the powered up state to do this. 
- VOID Return


Property reference

Properties
I2C Properties
Slave Address
 
Channel
Channel selection 
SDA
Pin used for SDA (data signal) 
SCL
Pin used for SCL (clock signal) 
DVI Pin
Pin used to reset the device. 
Baud Select
Baud rate option selector 
Baud Rate
Baud rate to be used 
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.  
Simulation
Simulate Comms
Allows the simulation data to come from the panel GUI or relayed via an injector component.