The 1-Wire adapter for the DS18B20 programmable, and software compatible, temperature sensors.
More...

Inheritance diagram for Apac.Dallas.OneWire.OneWireDevice28:

Classes
class	TempCalculatorC

class	TempCalculatorF

Public Member Functions
	OneWireDevice28 (int port, byte[] serialNumBuffer, owApi.FamilyCodes fc)

override byte[]	Read ()
	Reads this sensor's value. More...

void	PushScratchpad ()
	Commits scratchpad data to EEPROM on the sensor. More...

void	PushResolution ()

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. For this device, we first recall EEPROM contents to the scratchpad, then read the scratchpad contents, determine if they match our configuration, and then, if necessary, change the scratchpad and copy the scratchpad to EEPROM. 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	DecodeReadingC (byte[] data)
	Converts the raw data to a temperature in degrees celsius. More...

static decimal	DecodeReadingF (byte[] data)
	Converts the raw data to a temperature in degrees fahrenheit. More...

static ushort	DecodeResolutionBits (byte data)

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 or sets 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 DS18B20 programmable, and software compatible, temperature sensors.

Interfaces with devices:

DS18B20	http://www.maxim-ic.com/datasheet/index.mvp/id/2812
DS1822	http://www.maxim-ic.com/datasheet/index.mvp/id/2795

Member Function Documentation

◆ DecodeReadingC()

static decimal Apac.Dallas.OneWire.OneWireDevice28.DecodeReadingC ( byte[] data )

inlinestatic

Converts the raw data to a temperature in degrees celsius.

Parameters

data	The raw data from the DS18B20

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.

◆ DecodeReadingF()

static decimal Apac.Dallas.OneWire.OneWireDevice28.DecodeReadingF ( byte[] data )

inlinestatic

Converts the raw data to a temperature in degrees fahrenheit.

Parameters

data	The raw data from the DS18B20

Returns: Returns a temperature reading in degrees fahrenheit.

◆ Initialize()

override void Apac.Dallas.OneWire.OneWireDevice28.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. For this device, we first recall EEPROM contents to the scratchpad, then read the scratchpad contents, determine if they match our configuration, and then, if necessary, change the scratchpad and copy the scratchpad to EEPROM.

◆ PushScratchpad()

void Apac.Dallas.OneWire.OneWireDevice28.PushScratchpad ( )

inline

Commits scratchpad data to EEPROM on the sensor.

◆ Read()

override byte [] Apac.Dallas.OneWire.OneWireDevice28.Read ( )

inlinevirtual

Reads this sensor's value.

Returns: Returns the byte[] with the data from the device.

Implements Apac.Dallas.OneWire.OneWireDevice.

Property Documentation

◆ InputResolutionBits

override ushort Apac.Dallas.OneWire.OneWireDevice28.InputResolutionBits

getset

Gets or sets the input resolution bits.

The input resolution bits.

◆ IsFunctionalSensor

override bool Apac.Dallas.OneWire.OneWireDevice28.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:

/var/lib/jenkins/workspace/apac/APAC/Apac.Dallas.OneWire/OneWireDevice28.cs

Classes

Public Member Functions

Static Public Member Functions

Properties

Additional Inherited Members