Difference between revisions of "Component: Temperature (DS18S20) (Environmental)"

Latest revision as of 13:13, 7 February 2023

Author	MatrixTSL
Version	1.0
Category	Environmental

Temperature (DS18S20) component

A rugged temperature sensor allowing one or more sensors to be addressed and read. Capable of reading temperatures from -55 to +125 degrees C. Requires a One Wire component to perform the bus operations.

Component Source Code

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

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

Detailed description

No detailed description exists yet for this component

Examples

This example shows how to connect the DS18S20 component to the OneWire component and either select a specific device on the bus or scan through the devices on the bus collecting the temperature readings.

The temperature and serial number is output using a UART connection as is onboard a Arduino or ESP32 device.

Example DS18S20

Macro reference

AddressNextDevice

	AddressNextDevice
Scans for the next connected device with a matching family code. Goes through the device list generated by the ScanBus macro.
- VOID	Return

AddressSpecificDevice

	AddressSpecificDevice
Starts a temperature conversion on a specific device using a hex string identifier. SerialNumber parameter should be 12 characters and contain the 48-bit Serial.
- STRING	SerialNumber
48-bit Serial Number e.g. "32DF4A3C1901"
- VOID	Return

GetSerialString

	GetSerialString
Gets the Serial String for the current addressed device.
- STRING	Return

GetTemperature

	GetTemperature
Reads the temperature from the last sample on the selected device. The selected device is set using the AddressNext or AddressSpecific macros.
- FLOAT	Return

Initialise

	Initialise
Configures each matching sensor on the bus with the specified conversion bits.
- VOID	Return

SampleAddressedDevice

	SampleAddressedDevice
Performs a temperature conversion on the current addressed device. Requires one of the Address component macros to be called. The temperature can be read using the ReadTemperature macro.
- BOOL	WaitForCompletion
0=Dont Wait, 1=Block and Wait To Complete
- VOID	Return

SampleAllDevices

	SampleAllDevices
Performs a temperature conversion on all compatible devices. The temperature can be read using the ReadTemperature macro. Brefore calling ReadTemperature you need to use one of the Address macros.
- BOOL	WaitForCompletion
0=Dont Wait, 1=Block and Wait To Complete
- VOID	Return

Property reference

	Properties
	One Wire Component
Link to the one wire component to host the bus.
	Sensor Settings
	CRC Checking
Allows the data to be checked before being returned. Useful if the comunication with the sensor cannot be guarenteed. GetTemperature will return 999.9 if the CRC is not a match.
	Alarm High
The high byte of the alarm range
	Alarm Low
The Low byte of the Alarm range
	Conversion Bits
The number of bits used to perform a temperature sample. Controls the conversion time and the resolution.
	Max Conversion Time
The maximum amount of time in milliseconds it will take for a sample to complete.
	Temperature Resolution
The maximum resolution steps that the temperature can be read in.
	Simulation
	Simulate Comms
No - We use the panel GUI to perform the simulation. Yes - We use OneWire comms via an API to communicate with real hardware.
	Panel Simulation
	Number Sensors
Sens the number of sensors we can communicate with during simulation
	Serial 0
Serial number for simulated one wire device

@@ Line 17: / Line 17: @@
 ==Component Source Code==
-Please click here for the component source code: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_Temperature_DS18S20.fcfx FC_Comp_Source_Temperature_DS18S20.fcfx]
+Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Temperature_DS18S20.fcfx FC_Comp_Source_Temperature_DS18S20.fcfx]
+Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Temperature_DS18S20.fcfx FC_Comp_Source_Temperature_DS18S20.fcfx]
 ==Detailed description==
@@ Line 36: / Line 48: @@
 ==Examples==
@@ Line 57: / Line 79: @@
 {{fcfile|Example_DS18S20.fcfx|Example DS18S20}}
-==Downloadable macro reference==
+==Macro reference==
+===AddressNextDevice===
 {| 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;" | '''SampleAllDevices'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''AddressNextDevice'''
 |-
-| colspan="2" | Performs a temperature conversion on all compatible devices. The temperature can be read using the ReadTemperature macro. Brefore calling ReadTemperature you need to use one of the Address macros.&nbsp;
+| colspan="2" | Scans for the next connected device with a matching family code. Goes through the device list generated by the ScanBus macro.&nbsp;
-|-
-|-
-| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
-| width="90%" | WaitForCompletion
 |-
-| colspan="2" | 0=Dont Wait, 1=Block and Wait To Complete&nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
@@ Line 77: / Line 105: @@
+===AddressSpecificDevice===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 95: / Line 124: @@
+===GetSerialString===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 108: / Line 138: @@
+===GetTemperature===
 {| 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;" | '''AddressNextDevice'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetTemperature'''
 |-
-| colspan="2" | Scans for the next connected device with a matching family code. Goes through the device list generated by the ScanBus macro.&nbsp;
+| colspan="2" | Reads the temperature from the last sample on the selected device. The selected device is set using the AddressNext or AddressSpecific macros.&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-f32-icon.png]] - FLOAT
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
+===Initialise===
 {| 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;" | '''GetTemperature'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
 |-
-| colspan="2" | Reads the temperature from the last sample on the selected device. The selected device is set using the AddressNext or AddressSpecific macros.&nbsp;
+| colspan="2" | Configures each matching sensor on the bus with the specified conversion bits.&nbsp;
 |-
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
+| 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''
 |}
+===SampleAddressedDevice===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 152: / Line 185: @@
+===SampleAllDevices===
 {| 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'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SampleAllDevices'''
+|-
+| colspan="2" | Performs a temperature conversion on all compatible devices. The temperature can be read using the ReadTemperature macro. Brefore calling ReadTemperature you need to use one of the Address macros.&nbsp;
+|-
 |-
-| colspan="2" | Configures each matching sensor on the bus with the specified conversion bits.&nbsp;
+| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
+| width="90%" | WaitForCompletion
 |-
+| colspan="2" | 0=Dont Wait, 1=Block and Wait To Complete&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''
 |}

Difference between revisions of "Component: Temperature (DS18S20) (Environmental)"

Latest revision as of 13:13, 7 February 2023

Contents