AP&C API Reference
Classes | Public Member Functions | Static Public Member Functions | Properties | List of all members
Apac.Dallas.OneWire.OneWireDevice10 Class Reference

The 1-Wire adapter for the DS18S20 high-resolution temperature sensor. See http://www.maxim-ic.com/datasheet/index.mvp/id/2815 for details. More...

Inheritance diagram for Apac.Dallas.OneWire.OneWireDevice10:
Apac.Dallas.OneWire.OneWireDevice

Classes

class  TempCalculatorC
 
class  TempCalculatorF
 

Public Member Functions

 OneWireDevice10 (int port, byte[] serialNumberBuf, owApi.FamilyCodes fc)
 
override byte[] Read ()
 Reads this sensor's value. More...
 
override void Initialize (OneWire.Configuration.OneWireDeviceConfig config)
 Lets individual sensor implementations do routines to put the sensor in its expected state, such as setting the number of bits to resolve temperature readings. This method is a no-op for this device because it is not programmable. More...
 
- Public Member Functions inherited from Apac.Dallas.OneWire.OneWireDevice
abstract void Initialize (OneWire.Configuration.OneWireDeviceConfig config)
 Lets individual sensor implementations do routines to put the sensor in its expected state, such as setting the number of bits to resolve temperature readings. Some (many?) sensors will create a no-op method for this message. More...
 
override string ToString ()
 

Static Public Member Functions

static decimal ConvertReadingC (byte[] data)
 Converts the raw data to a temperature in degrees celsius. It is assumed that this is the raw block of data transfered from the network, including the initial command byte (which is not used here). More...
 
static decimal ConvertReadingF (byte[] data)
 Converts the raw data to a temperature in degrees fahrenheit. More...
 
- Static Public Member Functions inherited from Apac.Dallas.OneWire.OneWireDevice
static OneWireDevice Create (int port, OneWireDeviceConfig config)
 Factory method for getting specific 1-Wire device implementations that encapsulate their own communications routines by device type, by using configuration object. More...
 
static OneWireDevice Create (int port, byte[] serialNum)
 Factory method for getting specific 1-Wire device implementations that encapsulate their own communications routines by device type. More...
 
static OneWireDevice Create (int port, ulong serialNum)
 
static ulong DecodeSn (byte[] sn)
 
static string GetIdentifier (ulong sn)
 

Properties

override ushort InputResolutionBits [get, set]
 Gets the input resolution bits. More...
 
override bool IsFunctionalSensor [get]
 Gets a value indicating whether this instance is functional sensor. More...
 
- Properties inherited from Apac.Dallas.OneWire.OneWireDevice
abstract ushort InputResolutionBits [get, set]
 Gets the input resolution bits. More...
 
abstract bool IsFunctionalSensor [get]
 Gets a value indicating whether this instance is functional sensor. More...
 
byte[] Buffer [get, protected set]
 Gets the last buffer of raw data retrieved from the device using Read. More...
 
ulong SerialNumber [get]
 Gets the unique 1-Wire identifier for this device. More...
 
byte[] RawSerialNumber [get]
 Gets the unique 1-Wire identifier for this device in binary format. More...
 
string Identifier [get]
 The SerialNumber as a hex string. More...
 
owApi.FamilyCodes FamilyCode [get]
 Gets the family code that is decoded from the SerialNumber . More...
 
string FamilyDescription [get, protected set]
 Gets a description that goes with FamilyCode . More...
 
string[] PartIds [get, protected set]
 Gets the list of part identifiers that apply to this family of devices. More...
 
int Port [get, set]
 Gets or sets the number for the port used to communicate with this device. More...
 
OneWireDeviceConfig Config [get]
 Gets or sets (protected) the configuration for this OneWireDevice. More...
 
log4net.ILog Log [get]
 Gets the log. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Apac.Dallas.OneWire.OneWireDevice
 OneWireDevice (int port, byte[] serialNumberBuf, owApi.FamilyCodes fc)
 Creates a new 1-Wire device instance and associates it to the port. More...
 

Detailed Description

The 1-Wire adapter for the DS18S20 high-resolution temperature sensor. See http://www.maxim-ic.com/datasheet/index.mvp/id/2815 for details.

Member Function Documentation

◆ ConvertReadingC()

static decimal Apac.Dallas.OneWire.OneWireDevice10.ConvertReadingC ( byte[]  data)
inlinestatic

Converts the raw data to a temperature in degrees celsius. It is assumed that this is the raw block of data transfered from the network, including the initial command byte (which is not used here).

Parameters
dataThe raw data from the DS1820
Returns
Returns a temperature reading in degrees celsius.

In this routine we receive the whole payload from the bus read, but we only care about bytes indexed at 1 and 2. Index 1 is the least significant byte, and index 2 is the most significant byte.

◆ ConvertReadingF()

static decimal Apac.Dallas.OneWire.OneWireDevice10.ConvertReadingF ( byte[]  data)
inlinestatic

Converts the raw data to a temperature in degrees fahrenheit.

Parameters
dataThe raw data from the DS1820
Returns
Returns a temperature reading in degrees fahrenheit.

◆ Initialize()

override void Apac.Dallas.OneWire.OneWireDevice10.Initialize ( OneWire.Configuration.OneWireDeviceConfig  config)
inline

Lets individual sensor implementations do routines to put the sensor in its expected state, such as setting the number of bits to resolve temperature readings. This method is a no-op for this device because it is not programmable.

◆ Read()

override byte [] Apac.Dallas.OneWire.OneWireDevice10.Read ( )
inlinevirtual

Reads this sensor's value.

Returns

Implements Apac.Dallas.OneWire.OneWireDevice.

Property Documentation

◆ InputResolutionBits

override ushort Apac.Dallas.OneWire.OneWireDevice10.InputResolutionBits
getset

Gets the input resolution bits.

The input resolution bits.

◆ IsFunctionalSensor

override bool Apac.Dallas.OneWire.OneWireDevice10.IsFunctionalSensor
get

Gets a value indicating whether this instance is functional sensor.

Always returns true for this type of sensor.


The documentation for this class was generated from the following file: