1-Wire API for Compact.NET  Version 4.10
DalSemi.OneWire.Adapter Namespace Reference

Classes

class  AdapterException
 Exception object thrown by all PortAdapters, to represent adapter communication exceptions More...
 
class  DataIOEventInfo
 Argument for event handler for 1-Wire data IO events More...
 
class  OneWireState
 1-Wire Network State contains the current 1-Wire Network state information More...
 
class  PortAdapter
 Abstract base class for all 1-Wire Adapter objects. More...
 
class  RawSendPacket
 Raw Send Packet that contains a StingBuffer of bytes to send and an expected return length. More...
 
class  ResetEventInfo
 Argument for event handler for 1-Wire reset events, holds result of reset. More...
 
class  SpeedChangeEventInfo
 Argument for event handler for 1-Wire speed change events, holds old and new speed. More...
 
class  UAdapterState
 UAdapterState contains the communication state of the DS2480 based COM port adapter. More...
 
class  UPacketBuilder
 UPacketBuilder contains the methods to build a communication packet to the DS2480 based serial adapter. More...
 
struct  UParameterSettings
 UParameterSettings contains the parameter settings state for one speed on the DS2480 based iButton COM port adapter. More...
 

Enumerations

enum  OWSpeed : int { SPEED_REGULAR = 0, SPEED_OVERDRIVE = 1, SPEED_FLEX = 2, SPEED_HYPERDRIVE = 3 }
 Indicates the communication speed of the 1-Wire line More...
 
enum  OWLevel : int { LEVEL_NORMAL = 0, LEVEL_POWER_DELIVERY = 1, LEVEL_BREAK = 2, LEVEL_PROGRAM = 3 }
 Indicates the power level of the 1-Wire line More...
 
enum  OWResetResult : int { RESET_NOPRESENCE = 0x00, RESET_PRESENCE = 0x01, RESET_ALARM = 0x02, RESET_SHORT = 0x03 }
 Indicates result of 1-Wire line reset More...
 
enum  OWPowerStart : int { CONDITION_NOW = 0, CONDITION_AFTER_BIT = 1, CONDITION_AFTER_BYTE = 2 }
 Indicates the change condition to begin power delivery More...
 
enum  OWPowerTime : int {
  DELIVERY_HALF_SECOND = 0, DELIVERY_ONE_SECOND = 1, DELIVERY_TWO_SECONDS = 2, DELIVERY_FOUR_SECONDS = 3,
  DELIVERY_SMART_DONE = 4, DELIVERY_INFINITE = 5, DELIVERY_CURRENT_DETECT = 6, DELIVERY_EPROM = 7
}
 Indicates the amount of time to deliver power More...
 
enum  Parameter : byte {
  PARAMETER_SLEW = (byte)(0x10), PARAMETER_12VPULSE = (byte)(0x20), PARAMETER_5VPULSE = (byte)(0x30), PARAMETER_WRITE1LOW = (byte)(0x40),
  PARAMETER_SAMPLEOFFSET = (byte)(0x50), PARAMETER_BAUDRATE = (byte)(0x70)
}
 Parameter selection More...
 
enum  SlewRate : byte {
  SLEWRATE_15Vus = (byte)(0x00), SLEWRATE_2p2Vus = (byte)(0x02), SLEWRATE_1p65Vus = (byte)(0x04), SLEWRATE_1p37Vus = (byte)(0x06),
  SLEWRATE_1p1Vus = (byte)(0x08), SLEWRATE_0p83Vus = (byte)(0x0A), SLEWRATE_0p7Vus = (byte)(0x0C), SLEWRATE_0p55Vus = (byte)(0x0E)
}
 Pull down slew rate times More...
 
enum  ProgramPulseTime12 : byte {
  TIME12V_32us = (byte)(0x00), TIME12V_64us = (byte)(0x02), TIME12V_128us = (byte)(0x04), TIME12V_256us = (byte)(0x06),
  TIME12V_512us = (byte)(0x08), TIME12V_1024us = (byte)(0x0A), TIME12V_2048us = (byte)(0x0C), TIME12V_infinite = (byte)(0x0E)
}
 12 Volt programming pulse times More...
 
enum  ProgramPulseTime5 : byte {
  TIME5V_16p4ms = (byte)(0x00), TIME5V_65p5ms = (byte)(0x02), TIME5V_131ms = (byte)(0x04), TIME5V_262ms = (byte)(0x06),
  TIME5V_524ms = (byte)(0x08), TIME5V_1p05s = (byte)(0x0A), TIME5V_2p10s = (byte)(0x0C), TIME5V_dynamic = (byte)(0x0C),
  TIME5V_infinite = (byte)(0x0E)
}
 5 Volt programming pulse times More...
 
enum  WriteOneLowTime : byte {
  WRITE1TIME_8us = (byte)(0x00), WRITE1TIME_9us = (byte)(0x02), WRITE1TIME_10us = (byte)(0x04), WRITE1TIME_11us = (byte)(0x06),
  WRITE1TIME_12us = (byte)(0x08), WRITE1TIME_13us = (byte)(0x0A), WRITE1TIME_14us = (byte)(0x0C), WRITE1TIME_15us = (byte)(0x0E)
}
 Write 1 low time More...
 
enum  SampleOffsetTime : byte {
  SAMPLEOFFSET_TIME_4us = (byte)(0x00), SAMPLEOFFSET_TIME_5us = (byte)(0x02), SAMPLEOFFSET_TIME_6us = (byte)(0x04), SAMPLEOFFSET_TIME_7us = (byte)(0x06),
  SAMPLEOFFSET_TIME_8us = (byte)(0x08), SAMPLEOFFSET_TIME_9us = (byte)(0x0A), SAMPLEOFFSET_TIME_10us = (byte)(0x0C), SAMPLEOFFSET_TIME_11us = (byte)(0x0E)
}
 Data sample offset and write 0 recovery times More...
 
enum  AdapterBaud : byte { BAUD_9600 = (byte)(0x00), BAUD_19200 = (byte)(0x02), BAUD_57600 = (byte)(0x04), BAUD_115200 = (byte)(0x06) }
 DS9097U brick baud rates expressed for the DS2480 ichip More...
 

Functions

delegate void ResetEventHandler (object src, ResetEventInfo args)
 Event handler for 1-Wire Reset events More...
 
delegate void SpeedChangeEventHandler (object src, SpeedChangeEventInfo args)
 Event handler for 1-Wire Speed change events More...
 
delegate void DataIOEventHandler (object src, DataIOEventInfo args)
 Event handler for 1-Wire IOEvents events More...
 

Enumeration Type Documentation

◆ AdapterBaud

enum AdapterBaud : byte
strong

DS9097U brick baud rates expressed for the DS2480 ichip

Enumerator
BAUD_9600 

DS9097U brick baud rate expressed for the DS2480 ichip, 9600 baud

BAUD_19200 

DS9097U brick baud rate expressed for the DS2480 ichip, 19200 baud

BAUD_57600 

DS9097U brick baud rate expressed for the DS2480 ichip, 57600 baud

BAUD_115200 

DS9097U brick baud rate expressed for the DS2480 ichip, 115200 baud

◆ OWLevel

enum OWLevel : int
strong

Indicates the power level of the 1-Wire line

Enumerator
LEVEL_NORMAL 

1-Wire Network level, normal (weak 5Volt pullup)

LEVEL_POWER_DELIVERY 

1-Wire Network level, (strong 5Volt pullup, used for power delivery)

LEVEL_BREAK 

1-Wire Network level, (strong pulldown to 0Volts, reset 1-Wire)

LEVEL_PROGRAM 

1-Wire Network level, (strong 12Volt pullup, used to program eprom )

◆ OWPowerStart

enum OWPowerStart : int
strong

Indicates the change condition to begin power delivery

Enumerator
CONDITION_NOW 

Condition for power state change, immediate

CONDITION_AFTER_BIT 

Condition for power state change, after next bit communication

CONDITION_AFTER_BYTE 

Condition for power state change, after next byte communication

◆ OWPowerTime

enum OWPowerTime : int
strong

Indicates the amount of time to deliver power

Enumerator
DELIVERY_HALF_SECOND 

Duration used in delivering power to the 1-Wire, 1/2 second

DELIVERY_ONE_SECOND 

Duration used in delivering power to the 1-Wire, 1 second

DELIVERY_TWO_SECONDS 

Duration used in delivering power to the 1-Wire, 2 seconds

DELIVERY_FOUR_SECONDS 

Duration used in delivering power to the 1-Wire, 4 second

DELIVERY_SMART_DONE 

Duration used in delivering power to the 1-Wire, smart complete

DELIVERY_INFINITE 

Duration used in delivering power to the 1-Wire, infinite

DELIVERY_CURRENT_DETECT 

Duration used in delivering power to the 1-Wire, current detect

DELIVERY_EPROM 

Duration used in delivering power to the 1-Wire, 480 us

◆ OWResetResult

enum OWResetResult : int
strong

Indicates result of 1-Wire line reset

Enumerator
RESET_NOPRESENCE 

1-Wire Network reset result = no presence

RESET_PRESENCE 

1-Wire Network reset result = presence

RESET_ALARM 

1-Wire Network reset result = alarm

RESET_SHORT 

1-Wire Network reset result = shorted

◆ OWSpeed

enum OWSpeed : int
strong

Indicates the communication speed of the 1-Wire line

Enumerator
SPEED_REGULAR 

Speed modes for 1-Wire Network, regular

SPEED_OVERDRIVE 

Speed modes for 1-Wire Network, overdrive

SPEED_FLEX 

Speed modes for 1-Wire Network, flexible for long lines

SPEED_HYPERDRIVE 

Speed modes for 1-Wire Network, hyperdrive

◆ Parameter

enum Parameter : byte
strong

Parameter selection

Enumerator
PARAMETER_SLEW 

Parameter selection, pull-down slew rate

PARAMETER_12VPULSE 

Parameter selection, 12 volt pulse time

PARAMETER_5VPULSE 

Parameter selection, 5 volt pulse time

PARAMETER_WRITE1LOW 

Parameter selection, write 1 low time

PARAMETER_SAMPLEOFFSET 

Parameter selection, sample offset

PARAMETER_BAUDRATE 

Parameter selection, baud rate

◆ ProgramPulseTime12

enum ProgramPulseTime12 : byte
strong

12 Volt programming pulse times

Enumerator
TIME12V_32us 

12 Volt programming pulse, time 32us

TIME12V_64us 

12 Volt programming pulse, time 64us

TIME12V_128us 

12 Volt programming pulse, time 128us

TIME12V_256us 

12 Volt programming pulse, time 256us

TIME12V_512us 

12 Volt programming pulse, time 512us

TIME12V_1024us 

12 Volt programming pulse, time 1024us

TIME12V_2048us 

12 Volt programming pulse, time 2048us

TIME12V_infinite 

12 Volt programming pulse, time (infinite)

◆ ProgramPulseTime5

enum ProgramPulseTime5 : byte
strong

5 Volt programming pulse times

Enumerator
TIME5V_16p4ms 

5 Volt programming pulse, time 16.4ms

TIME5V_65p5ms 

5 Volt programming pulse, time 65.5ms

TIME5V_131ms 

5 Volt programming pulse, time 131ms

TIME5V_262ms 

5 Volt programming pulse, time 262ms

TIME5V_524ms 

5 Volt programming pulse, time 524ms

TIME5V_1p05s 

5 Volt programming pulse, time 1.05s

TIME5V_2p10s 

5 Volt programming pulse, time 2.10sms

TIME5V_dynamic 

5 Volt programming pulse, dynamic current detect

TIME5V_infinite 

5 Volt programming pulse, time (infinite)

◆ SampleOffsetTime

enum SampleOffsetTime : byte
strong

Data sample offset and write 0 recovery times

Enumerator
SAMPLEOFFSET_TIME_4us 

Data sample offset and Write 0 recovery time, 4us

SAMPLEOFFSET_TIME_5us 

Data sample offset and Write 0 recovery time, 5us

SAMPLEOFFSET_TIME_6us 

Data sample offset and Write 0 recovery time, 6us

SAMPLEOFFSET_TIME_7us 

Data sample offset and Write 0 recovery time, 7us

SAMPLEOFFSET_TIME_8us 

Data sample offset and Write 0 recovery time, 8us

SAMPLEOFFSET_TIME_9us 

Data sample offset and Write 0 recovery time, 9us

SAMPLEOFFSET_TIME_10us 

Data sample offset and Write 0 recovery time, 10us

SAMPLEOFFSET_TIME_11us 

Data sample offset and Write 0 recovery time, 11us

◆ SlewRate

enum SlewRate : byte
strong

Pull down slew rate times

Enumerator
SLEWRATE_15Vus 

Pull down slew rate, 15V/us

SLEWRATE_2p2Vus 

Pull down slew rate, 2.2V/us

SLEWRATE_1p65Vus 

Pull down slew rate, 1.65V/us

SLEWRATE_1p37Vus 

Pull down slew rate, 1.37V/us

SLEWRATE_1p1Vus 

Pull down slew rate, 1.1V/us

SLEWRATE_0p83Vus 

Pull down slew rate, 0.83V/us

SLEWRATE_0p7Vus 

Pull down slew rate, 0.7V/us

SLEWRATE_0p55Vus 

Pull down slew rate, 0.55V/us

◆ WriteOneLowTime

enum WriteOneLowTime : byte
strong

Write 1 low time

Enumerator
WRITE1TIME_8us 

Write 1 low time, 8us

WRITE1TIME_9us 

Write 1 low time, 9us

WRITE1TIME_10us 

Write 1 low time, 10us

WRITE1TIME_11us 

Write 1 low time, 11us

WRITE1TIME_12us 

Write 1 low time, 12us

WRITE1TIME_13us 

Write 1 low time, 13us

WRITE1TIME_14us 

Write 1 low time, 14us

WRITE1TIME_15us 

Write 1 low time, 15us

Function Documentation

◆ DataIOEventHandler()

delegate void DalSemi.OneWire.Adapter.DataIOEventHandler ( object  src,
DataIOEventInfo  args 
)

Event handler for 1-Wire IOEvents events

◆ ResetEventHandler()

delegate void DalSemi.OneWire.Adapter.ResetEventHandler ( object  src,
ResetEventInfo  args 
)

Event handler for 1-Wire Reset events

◆ SpeedChangeEventHandler()

delegate void DalSemi.OneWire.Adapter.SpeedChangeEventHandler ( object  src,
SpeedChangeEventInfo  args 
)

Event handler for 1-Wire Speed change events