Component: Temperature (DS18S20) (Environmental)
From Flowcode Help
Jump to navigationJump to search| Author | MatrixTSL |
| Version | 1.0 |
| Category | Environmental |
Contents
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.
Macro reference
|
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 |
|
|
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 |
| Gets the Serial String for the current addressed device. | |
| - STRING
|
Return |
|
|
AddressNextDevice |
| Scans for the next connected device with a matching family code. Goes through the device list generated by the ScanBus macro. | |
| - VOID
|
Return |
|
|
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 |
|
|
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 |
|
|
Initialise |
| Configures each matching sensor on the bus with the specified conversion bits. | |
| - 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 | |
==Macro reference==
|
|
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 |
|
|
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 |
| Gets the Serial String for the current addressed device. | |
| - STRING
|
Return |
|
|
AddressNextDevice |
| Scans for the next connected device with a matching family code. Goes through the device list generated by the ScanBus macro. | |
| - VOID
|
Return |
|
|
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 |
|
|
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 |
|
|
Initialise |
| Configures each matching sensor on the bus with the specified conversion bits. | |
| - 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 | |
==Macro reference==
|
|
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 |
|
|
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 |
| Gets the Serial String for the current addressed device. | |
| - STRING
|
Return |
|
|
AddressNextDevice |
| Scans for the next connected device with a matching family code. Goes through the device list generated by the ScanBus macro. | |
| - VOID
|
Return |
|
|
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 |
|
|
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 |
|
|
Initialise |
| Configures each matching sensor on the bus with the specified conversion bits. | |
| - 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 | |
