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

From Flowcode Help
Jump to navigationJump to search
Line 16: Line 16:
  
 
==Component Source Code==
 
==Component Source Code==
 +
 +
Please click here to download the component source project: [https://www.flowcode.co.uk/wikicopy/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]
 
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 40: Line 44:
  
 
==Examples==
 
==Examples==
 +
 +
  
  
Line 60: Line 66:
  
 
==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;" | '''ContinuousMeasurement'''
 +
|-
 +
| colspan="2" | Powers up and starts the continous measurement mode. Delays in between measurements readings must be provided by the user, 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Resolution
 +
|-
 +
| colspan="2" | 0=1lx (120ms) / 1=0.5lx (120ms) / 2 = 4lx (16ms) 
 +
|-
 +
| 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;" | '''OneTimeMeasurement'''
 +
|-
 +
| 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. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Resolution
 +
|-
 +
| colspan="2" | 0=1lx (120ms) / 1=0.5lx (120ms) / 2 = 4lx (16ms) 
 +
|-
 +
| 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;" | '''PowerDown'''
 +
|-
 +
| colspan="2" | Power Down the Device 
 +
|-
 +
|-
 +
| 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;" | '''ChangeMeasurementTime'''
 +
|-
 +
| colspan="2" | Adjusts the measurement result to counteract influence of the optical window. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Sensitvity
 +
|-
 +
| colspan="2" | Range: 31-254 / Default: 69 
 +
|-
 +
| 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;" | '''ReadMeasurement'''
 +
|-
 +
| colspan="2" | Reads data from the Light Sensor as a 16-bit value. 
 +
|-
 +
|-
 +
| 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;" | '''ResetMeasurement'''
 +
|-
 +
| colspan="2" | Resets the device measurement register, Must be in the powered up state to do this. 
 +
|-
 +
|-
 +
| 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" | Stes up the I2C bus and initialises the termperature sensor ready for use. 
 +
|-
 +
|-
 +
| 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 Properties
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Slave Address
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Channel
 +
|-
 +
| colspan="2" | Channel selection 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 +
| width="90%" | SDA
 +
|-
 +
| colspan="2" | Pin used for SDA (data signal) 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 +
| width="90%" | SCL
 +
|-
 +
| colspan="2" | Pin used for SCL (clock signal) 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 +
| width="90%" | DVI Pin
 +
|-
 +
| colspan="2" | Pin used to reset the device. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Baud Select
 +
|-
 +
| colspan="2" | Baud rate option selector 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 +
| width="90%" | Baud Rate
 +
|-
 +
| colspan="2" | Baud rate to be used 
 +
|-
 +
| 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.  
 +
|-
 +
| 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%" | Simulate Comms
 +
|-
 +
| colspan="2" | Allows the simulation data to come from the panel GUI or relayed via an injector component. 
 +
|}==Macro reference==
  
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"

Revision as of 15:20, 20 January 2023

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

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


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Resolution
0=1lx (120ms) / 1=0.5lx (120ms) / 2 = 4lx (16ms) 
Fc9-u16-icon.png - UINT Return


Fc9-comp-macro.png PowerDown
Power Down the Device 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png ChangeMeasurementTime
Adjusts the measurement result to counteract influence of the optical window. 
Fc9-u8-icon.png - BYTE Sensitvity
Range: 31-254 / Default: 69 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png ReadMeasurement
Reads data from the Light Sensor as a 16-bit value. 
Fc9-u16-icon.png - UINT Return


Fc9-comp-macro.png ResetMeasurement
Resets the device measurement register, Must be in the powered up state to do this. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Initialise
Stes up the I2C bus and initialises the termperature sensor ready for use. 
Fc9-void-icon.png - VOID Return



Property reference

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

==Macro reference==

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


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Resolution
0=1lx (120ms) / 1=0.5lx (120ms) / 2 = 4lx (16ms) 
Fc9-u16-icon.png - UINT Return


Fc9-comp-macro.png PowerDown
Power Down the Device 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png ChangeMeasurementTime
Adjusts the measurement result to counteract influence of the optical window. 
Fc9-u8-icon.png - BYTE Sensitvity
Range: 31-254 / Default: 69 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png ReadMeasurement
Reads data from the Light Sensor as a 16-bit value. 
Fc9-u16-icon.png - UINT Return


Fc9-comp-macro.png ResetMeasurement
Resets the device measurement register, Must be in the powered up state to do this. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Initialise
Stes up the I2C bus and initialises the termperature sensor ready for use. 
Fc9-void-icon.png - VOID Return



Property reference

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

==Macro reference==

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


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Resolution
0=1lx (120ms) / 1=0.5lx (120ms) / 2 = 4lx (16ms) 
Fc9-u16-icon.png - UINT Return


Fc9-comp-macro.png PowerDown
Power Down the Device 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png ChangeMeasurementTime
Adjusts the measurement result to counteract influence of the optical window. 
Fc9-u8-icon.png - BYTE Sensitvity
Range: 31-254 / Default: 69 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png ReadMeasurement
Reads data from the Light Sensor as a 16-bit value. 
Fc9-u16-icon.png - UINT Return


Fc9-comp-macro.png ResetMeasurement
Resets the device measurement register, Must be in the powered up state to do this. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Initialise
Stes up the I2C bus and initialises the termperature sensor ready for use. 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-conn-icon.png I2C Properties
Fc9-type-16-icon.png Slave Address
 
Fc9-type-16-icon.png Channel
Channel selection 
Fc9-type-5-icon.png SDA
Pin used for SDA (data signal) 
Fc9-type-5-icon.png SCL
Pin used for SCL (clock signal) 
Fc9-type-5-icon.png DVI Pin
Pin used to reset the device. 
Fc9-type-16-icon.png Baud Select
Baud rate option selector 
Fc9-type-14-icon.png Baud Rate
Baud rate to be used 
Fc9-type-7-icon.png 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.  
Fc9-conn-icon.png Simulation
Fc9-type-7-icon.png Simulate Comms
Allows the simulation data to come from the panel GUI or relayed via an injector component. 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Ambient_Light_(BH1750FVI)_(Light)&oldid=33114"