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

A simple class that allows loading a representation of the Serial ID iButton device. As far as I can tell, there is no possible interaction with this device type. More...

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

Public Member Functions

 OneWireDevice81 (int port, byte[] serialNumberBuffer, 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 ()
 

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

- 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)
 
- 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

A simple class that allows loading a representation of the Serial ID iButton device. As far as I can tell, there is no possible interaction with this device type.

Member Function Documentation

◆ Initialize()

override void Apac.Dallas.OneWire.OneWireDevice81.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.OneWireDevice81.Read ( )
inlinevirtual

Reads this sensor's value.

Returns
Returns the raw data read from the sensor.

Implements Apac.Dallas.OneWire.OneWireDevice.

Property Documentation

◆ InputResolutionBits

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

Gets the input resolution bits.

The input resolution bits.

◆ IsFunctionalSensor

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

Gets a value indicating whether this instance is functional sensor.

Always returns false for this type of sensor.


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