Difference between revisions of "Component: Digital Multimeter (HY3131) (Sensors)"
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_DMM_HY3131.fcfx FC_Comp_Source_DMM_HY3131.fcfx] | ||
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_DMM_HY3131.fcfx FC_Comp_Source_DMM_HY3131.fcfx] | Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_DMM_HY3131.fcfx FC_Comp_Source_DMM_HY3131.fcfx] | ||
==Detailed description== | ==Detailed description== | ||
| + | |||
| + | |||
| Line 30: | Line 34: | ||
==Examples== | ==Examples== | ||
| + | |||
| + | |||
| Line 40: | Line 46: | ||
==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;" | '''ReadRegister''' | ||
| + | |- | ||
| + | | colspan="2" | A simple example showing a generic way to read a register using I2C. | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | Address | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | 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;" | '''WriteRegister''' | ||
| + | |- | ||
| + | | colspan="2" | A simple example showing a generic way to write a register using I2C. | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | Address | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | Data | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | 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" | | ||
| + | |- | ||
| + | |- | ||
| + | | 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;" | SPI Properties | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | ||
| + | | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | ||
| + | | width="90%" | Channel | ||
| + | |- | ||
| + | | colspan="2" | SPI Channel selector | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-5-icon.png]] | ||
| + | | width="90%" | MOSI | ||
| + | |- | ||
| + | | colspan="2" | SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode. | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-5-icon.png]] | ||
| + | | width="90%" | MISO | ||
| + | |- | ||
| + | | colspan="2" | SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode. | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-5-icon.png]] | ||
| + | | width="90%" | CLK | ||
| + | |- | ||
| + | | colspan="2" | SPI Clock Pin CLK - The Clock signal is driven by the SPI master. | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | ||
| + | | width="90%" | Use Auto CS | ||
| + | |- | ||
| + | | colspan="2" | Allow the SPI component to manage the CS pin for us in Master mode. On initialise the CS pin is automatically set high to disable the remote SPI device. Set to No if you want to create a component with multiple CS pins or if you want to manage the CS pin yourself. | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-5-icon.png]] | ||
| + | | width="90%" | CS / SS | ||
| + | |- | ||
| + | | colspan="2" | Chip Select / Slave Select Pin Master Mode: General purpose output pin used to select the remote SPI device. Slave Mode: Hardware chip select pin input used to select the SPI device. | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | ||
| + | | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Options | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | ||
| + | | width="90%" | Mode | ||
| + | |- | ||
| + | | colspan="2" | Configures the mode of the SPI component. Currently only Master mode is supported. | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | ||
| + | | width="90%" | Prescale | ||
| + | |- | ||
| + | | colspan="2" | Prescale option selector | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | ||
| + | | width="90%" | Clock Phase | ||
| + | |- | ||
| + | | colspan="2" | Clock Phase (data change edge) selection | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | ||
| + | | width="90%" | Clock Polarity | ||
| + | |- | ||
| + | | colspan="2" | Clock Polarity setting, inactive (idle) state | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | ||
| + | | width="90%" | Sample Point | ||
| + | |- | ||
| + | | colspan="2" | Data bit read sample point | ||
| + | |- | ||
| + | | 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" | | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | ||
| + | | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Scale | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | ||
| + | | width="90%" | Select Scale | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |}==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 | MatrixTSL |
| Version | 1.0 |
| Category | Sensors |
Contents
Digital Multimeter component
A component allowing access to the digital multimeter IC HY3131.
Component Source Code
Please click here to download the component source project: FC_Comp_Source_DMM_HY3131.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_DMM_HY3131.fcfx
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Macro reference
|
ReadRegister |
| A simple example showing a generic way to read a register using I2C. | |
 - BYTE
|
Address |
| - BYTE
|
Return |
|
|
WriteRegister |
| A simple example showing a generic way to write a register using I2C. | |
| - BYTE
|
Address |
| - BYTE
|
Data |
 - VOID
|
Return |
|
|
Initialise |
| - VOID
|
Return |
Property reference
|
Properties |
|
SPI Properties |
|
|
Connections |
|
Channel |
| SPI Channel selector | |
|
MOSI |
| SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode. | |
|
|
MISO |
| SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode. | |
|
|
CLK |
| SPI Clock Pin CLK - The Clock signal is driven by the SPI master. | |
|
Use Auto CS |
| Allow the SPI component to manage the CS pin for us in Master mode. On initialise the CS pin is automatically set high to disable the remote SPI device. Set to No if you want to create a component with multiple CS pins or if you want to manage the CS pin yourself. | |
|
|
CS / SS |
| Chip Select / Slave Select Pin Master Mode: General purpose output pin used to select the remote SPI device. Slave Mode: Hardware chip select pin input used to select the SPI device. | |
|
|
Options |
|
|
Mode |
| Configures the mode of the SPI component. Currently only Master mode is supported. | |
|
|
Prescale |
| Prescale option selector | |
|
|
Clock Phase |
| Clock Phase (data change edge) selection | |
|
|
Clock Polarity |
| Clock Polarity setting, inactive (idle) state | |
|
|
Sample Point |
| Data bit read sample point | |
|
|
Simulation |
|
|
Simulate Comms |
|
|
Scale |
|
|
Select Scale |
==Macro reference==
|
|
ReadRegister |
| A simple example showing a generic way to read a register using I2C. | |
| - BYTE
|
Address |
| - BYTE
|
Return |
|
|
WriteRegister |
| A simple example showing a generic way to write a register using I2C. | |
| - BYTE
|
Address |
| - BYTE
|
Data |
| - VOID
|
Return |
|
|
Initialise |
| - VOID
|
Return |
Property reference
|
|
Properties |
|
|
SPI Properties |
|
|
Connections |
|
|
Channel |
| SPI Channel selector | |
|
|
MOSI |
| SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode. | |
|
|
MISO |
| SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode. | |
|
|
CLK |
| SPI Clock Pin CLK - The Clock signal is driven by the SPI master. | |
|
|
Use Auto CS |
| Allow the SPI component to manage the CS pin for us in Master mode. On initialise the CS pin is automatically set high to disable the remote SPI device. Set to No if you want to create a component with multiple CS pins or if you want to manage the CS pin yourself. | |
|
|
CS / SS |
| Chip Select / Slave Select Pin Master Mode: General purpose output pin used to select the remote SPI device. Slave Mode: Hardware chip select pin input used to select the SPI device. | |
|
|
Options |
|
|
Mode |
| Configures the mode of the SPI component. Currently only Master mode is supported. | |
|
|
Prescale |
| Prescale option selector | |
|
|
Clock Phase |
| Clock Phase (data change edge) selection | |
|
|
Clock Polarity |
| Clock Polarity setting, inactive (idle) state | |
|
|
Sample Point |
| Data bit read sample point | |
|
|
Simulation |
|
|
Simulate Comms |
|
|
Scale |
|
|
Select Scale |
==Macro reference==
|
|
ReadRegister |
| A simple example showing a generic way to read a register using I2C. | |
| - BYTE
|
Address |
| - BYTE
|
Return |
|
|
WriteRegister |
| A simple example showing a generic way to write a register using I2C. | |
| - BYTE
|
Address |
| - BYTE
|
Data |
| - VOID
|
Return |
|
|
Initialise |
| - VOID
|
Return |
Property reference
|
|
Properties |
|
|
SPI Properties |
|
|
Connections |
|
|
Channel |
| SPI Channel selector | |
|
|
MOSI |
| SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode. | |
|
|
MISO |
| SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode. | |
|
|
CLK |
| SPI Clock Pin CLK - The Clock signal is driven by the SPI master. | |
|
|
Use Auto CS |
| Allow the SPI component to manage the CS pin for us in Master mode. On initialise the CS pin is automatically set high to disable the remote SPI device. Set to No if you want to create a component with multiple CS pins or if you want to manage the CS pin yourself. | |
|
|
CS / SS |
| Chip Select / Slave Select Pin Master Mode: General purpose output pin used to select the remote SPI device. Slave Mode: Hardware chip select pin input used to select the SPI device. | |
|
|
Options |
|
|
Mode |
| Configures the mode of the SPI component. Currently only Master mode is supported. | |
|
|
Prescale |
| Prescale option selector | |
|
|
Clock Phase |
| Clock Phase (data change edge) selection | |
|
|
Clock Polarity |
| Clock Polarity setting, inactive (idle) state | |
|
|
Sample Point |
| Data bit read sample point | |
|
|
Simulation |
|
|
Simulate Comms |
|
|
Scale |
|
|
Select Scale |
