1-Wire API for Compact.NET Version 4.00
|
UPacketBuilder contains the methods to build a communication packet to the DS2480 based serial adapter. More...
Public Member Functions | |
UPacketBuilder (UAdapterState startUState) | |
Constructs a new u packet builder. | |
virtual void | Restart () |
Reset the packet builder to start a new one. | |
virtual void | NewPacket () |
Take the current packet and place it into the vector. | |
virtual int | OneWireReset () |
Add the command to reset the OneWire at the current speed. | |
virtual int | DataBytes (byte[] dataBytesValue) |
Append data bytes (read/write) to the packet. | |
virtual int | DataBytes (byte[] dataBytesValue, int off, int len) |
Append data bytes (read/write) to the packet. | |
virtual int | DataByte (byte dataByteValue) |
Append a data byte (read/write) to the packet. | |
virtual int | PrimedDataByte (byte dataByteValue) |
Append a data byte (read/write) to the packet. | |
virtual int | DataBit (bool dataBit, bool strong5V) |
Append a data bit (read/write) to the packet. | |
virtual int | Search (OneWireState mState) |
Append a Search to the packet. | |
virtual void | SetSpeed () |
Append a Search off to set the current speed. | |
virtual void | SetToCommandMode () |
Set the U state to command mode. | |
virtual void | SetToDataMode () |
Set the U state to data mode. | |
virtual int | GetParameter (Parameter parameter) |
Append a get parameter to the packet. | |
virtual int | SetParameter (SlewRate parameterValue) |
Append a set parameter to the packet. | |
virtual int | SetParameter (ProgramPulseTime12 parameterValue) |
Append a set parameter to the packet. | |
virtual int | SetParameter (ProgramPulseTime5 parameterValue) |
Append a set parameter to the packet. | |
virtual int | SetParameter (WriteOneLowTime parameterValue) |
Append a set parameter to the packet. | |
virtual int | SetParameter (SampleOffsetTime parameterValue) |
Append a set parameter to the packet. | |
virtual int | SetParameter (AdapterBaud parameterValue) |
Append a set parameter to the packet. | |
virtual int | SendCommand (byte command, bool expectResponse) |
Append a send command to the packet. | |
virtual void | InterpretDataBytes (byte[] dataByteResponse, int responseOffset, byte[] result, int offset, int len) |
Interpret the block of bytes. | |
virtual OWResetResult | InterpretOneWireReset (byte resetResponse) |
Interpret the reset response byte from a U adapter. | |
virtual bool | InterpretOneWireBit (byte bitResponse) |
Interpret the bit response byte from a U adapter. | |
virtual bool | InterpretSearch (OneWireState mState, byte[] searchResponse, int responseOffset) |
Interpret the Search response and set the 1-Wire state accordingly. | |
virtual byte | InterpretPrimedByte (byte[] primedDataResponse, int responseOffset) |
Interpret the data response byte from a primed byte operation. | |
virtual bool | BitRead (byte[] bitBuffer, int address) |
Bit utility to read a bit in the provided array of chars. | |
virtual void | BitWrite (byte[] bitBuffer, int address, bool newBitState) |
Bit utility to write a bit in the provided array of chars. | |
Static Public Member Functions | |
static uint | GetDesiredBaud (int operation, OWSpeed owSpeed, uint maxBaud) |
Request the maximum rate to do an operation. | |
Public Attributes | |
const int | OPERATION_BYTE = 0 |
Byte operation. | |
const int | OPERATION_SEARCH = 1 |
Byte operation. | |
const byte | MAX_BYTES_STREAMED = (byte)(64) |
Max bytes to stream at once. | |
const byte | FUNCTION_BIT = (byte)(0x81) |
DS9097U funciton command, single bit. | |
const byte | FUNCTION_SEARCHON = (byte)(0xB1) |
DS9097U funciton command, turn Search mode on. | |
const byte | FUNCTION_SEARCHOFF = (byte)(0xA1) |
DS9097U funciton command, turn Search mode off. | |
const byte | FUNCTION_RESET = (byte)(0xC1) |
DS9097U funciton command, OneWire reset. | |
const byte | FUNCTION_5VPULSE_NOW = (byte)(0xED) |
DS9097U funciton command, 5V pulse imediate. | |
const byte | FUNCTION_12VPULSE_NOW = (byte)(0xFD) |
DS9097U funciton command, 12V pulse imediate. | |
const byte | FUNCTION_5VPULSE_ARM = (byte)(0xEF) |
DS9097U funciton command, 5V pulse after next byte. | |
const byte | FUNCTION_STOP_PULSE = (byte)(0xF1) |
DS9097U funciton command to stop an ongoing pulse. | |
const byte | BIT_ONE = (byte)(0x10) |
DS9097U bit polarity one for function FUNCTION_BIT. | |
const byte | BIT_ZERO = (byte)(0x00) |
DS9097U bit polarity zero for function FUNCTION_BIT. | |
const byte | PRIME5V_TRUE = (byte)(0x02) |
DS9097U 5V prime on for function FUNCTION_BIT. | |
const byte | PRIME5V_FALSE = (byte)(0x00) |
DS9097U 5V prime off for function FUNCTION_BIT. | |
const byte | CONFIG_MASK = (byte)(0x01) |
DS9097U mask to read or write a configuration parameter. | |
const byte | RESPONSE_RESET_MASK = (byte)(0x03) |
DS9097U mask to read the OneWire reset response byte. | |
const byte | RESPONSE_RESET_SHORT = (byte)(0x00) |
DS9097U OneWire reset result = shorted. | |
const byte | RESPONSE_RESET_PRESENCE = (byte)(0x01) |
DS9097U OneWire reset result = presence. | |
const byte | RESPONSE_RESET_ALARM = (byte)(0x02) |
DS9097U OneWire reset result = alarm. | |
const byte | RESPONSE_RESET_NOPRESENCE = (byte)(0x03) |
DS9097U OneWire reset result = no presence. | |
const byte | RESPONSE_BIT_MASK = (byte)(0x03) |
DS9097U mask to read bit operation result. | |
const byte | RESPONSE_BIT_ONE = (byte)(0x03) |
DS9097U read bit operation 1. | |
const byte | RESPONSE_BIT_ZERO = (byte)(0x00) |
DS9097U read bit operation 0. | |
Static Public Attributes | |
static bool | doDebugMessages = false |
Enable/disable debug messages. | |
Protected Attributes | |
internal int | totalReturnLength |
The current current count for the number of return bytes from the packet being created. | |
internal RawSendPacket | packet |
Current raw send packet before it is added to the packetsVector. | |
internal System.Collections.ArrayList | packetsVector |
Vector of raw send packets. | |
internal bool | bitsOnly |
Flag to send only 'bit' commands to the DS2480. | |
Properties | |
System.Collections.IEnumerator | Packets [get] |
Retrieve enumeration of raw send packets. |
UPacketBuilder contains the methods to build a communication packet to the DS2480 based serial adapter.
<version>0.00</version> <author>DS, SH</author>
UPacketBuilder | ( | UAdapterState | startUState | ) |
Constructs a new u packet builder.
startUState | the object that contains the U brick state which is reference when creating packets |
virtual bool BitRead | ( | byte[] | bitBuffer, |
int | address | ||
) | [virtual] |
Bit utility to read a bit in the provided array of chars.
bitBuffer | array of chars where the bit to read is located |
address | bit location to read (LSBit of first Byte in bitBuffer is postion 0) |
virtual void BitWrite | ( | byte[] | bitBuffer, |
int | address, | ||
bool | newBitState | ||
) | [virtual] |
Bit utility to write a bit in the provided array of chars.
bitBuffer | array of chars where the bit to write is located |
address | bit location to write (LSBit of first Byte in bitBuffer is postion 0) |
newBitState | new bit state |
virtual int DataBit | ( | bool | dataBit, |
bool | strong5V | ||
) | [virtual] |
Append a data bit (read/write) to the packet.
DataBit | bit to append |
strong5V | true if want strong5V after bit |
virtual int DataByte | ( | byte | dataByteValue | ) | [virtual] |
Append a data byte (read/write) to the packet.
dataByteValue | data byte to append |
virtual int DataBytes | ( | byte[] | dataBytesValue, |
int | off, | ||
int | len | ||
) | [virtual] |
Append data bytes (read/write) to the packet.
dataBytesValue | byte array of data bytes |
off | offset into the array of data to start |
len | length of data to send / receive starting at 'off' |
virtual int DataBytes | ( | byte[] | dataBytesValue | ) | [virtual] |
Append data bytes (read/write) to the packet.
dataBytesValue | character array of data bytes |
static uint GetDesiredBaud | ( | int | operation, |
OWSpeed | owSpeed, | ||
uint | maxBaud | ||
) | [static] |
Request the maximum rate to do an operation.
virtual int GetParameter | ( | Parameter | parameter | ) | [virtual] |
Append a get parameter to the packet.
parameter | parameter to get |
virtual void InterpretDataBytes | ( | byte[] | dataByteResponse, |
int | responseOffset, | ||
byte[] | result, | ||
int | offset, | ||
int | len | ||
) | [virtual] |
Interpret the block of bytes.
dataByteResponse |
responseOffset
result
offset
len
virtual bool InterpretOneWireBit | ( | byte | bitResponse | ) | [virtual] |
Interpret the bit response byte from a U adapter.
bitResponse | bit response byte from U |
virtual OWResetResult InterpretOneWireReset | ( | byte | resetResponse | ) | [virtual] |
Interpret the reset response byte from a U adapter.
resetResponse | reset response byte from U |
virtual byte InterpretPrimedByte | ( | byte[] | primedDataResponse, |
int | responseOffset | ||
) | [virtual] |
Interpret the data response byte from a primed byte operation.
primedDataResponse
responseOffset
virtual bool InterpretSearch | ( | OneWireState | mState, |
byte[] | searchResponse, | ||
int | responseOffset | ||
) | [virtual] |
Interpret the Search response and set the 1-Wire state accordingly.
bitResponse | bit response byte from U |
mState
searchResponse
responseOffset
virtual void NewPacket | ( | ) | [virtual] |
Take the current packet and place it into the vector.
This indicates a place where we need to wait for the results from DS9097U adapter.
virtual int OneWireReset | ( | ) | [virtual] |
Add the command to reset the OneWire at the current speed.
virtual int PrimedDataByte | ( | byte | dataByteValue | ) | [virtual] |
Append a data byte (read/write) to the packet.
Do a strong pullup when the byte is complete
dataByteValue | data byte to append |
virtual void Restart | ( | ) | [virtual] |
Reset the packet builder to start a new one.
virtual int Search | ( | OneWireState | mState | ) | [virtual] |
Append a Search to the packet.
Assume that any reset and Search command have already been appended. This will add only the Search itself.
mState | OneWire state |
virtual int SendCommand | ( | byte | command, |
bool | expectResponse | ||
) | [virtual] |
Append a send command to the packet.
This command does not elicit a response byte.
command | command to send |
expectResponse
virtual int SetParameter | ( | ProgramPulseTime5 | parameterValue | ) | [virtual] |
Append a set parameter to the packet.
parameterValue | parameter value
|
virtual int SetParameter | ( | ProgramPulseTime12 | parameterValue | ) | [virtual] |
Append a set parameter to the packet.
parameterValue | parameter value
|
virtual int SetParameter | ( | AdapterBaud | parameterValue | ) | [virtual] |
Append a set parameter to the packet.
parameterValue | parameter value
|
virtual int SetParameter | ( | WriteOneLowTime | parameterValue | ) | [virtual] |
Append a set parameter to the packet.
parameterValue | parameter value
|
virtual int SetParameter | ( | SampleOffsetTime | parameterValue | ) | [virtual] |
Append a set parameter to the packet.
parameterValue | parameter value
|
virtual int SetParameter | ( | SlewRate | parameterValue | ) | [virtual] |
Append a set parameter to the packet.
parameterValue | parameter value
|
virtual void SetSpeed | ( | ) | [virtual] |
Append a Search off to set the current speed.
virtual void SetToCommandMode | ( | ) | [virtual] |
Set the U state to command mode.
virtual void SetToDataMode | ( | ) | [virtual] |
Set the U state to data mode.
const byte BIT_ONE = (byte)(0x10) |
DS9097U bit polarity one for function FUNCTION_BIT.
const byte BIT_ZERO = (byte)(0x00) |
DS9097U bit polarity zero for function FUNCTION_BIT.
internal bool bitsOnly [protected] |
Flag to send only 'bit' commands to the DS2480.
const byte CONFIG_MASK = (byte)(0x01) |
DS9097U mask to read or write a configuration parameter.
bool doDebugMessages = false [static] |
Enable/disable debug messages.
const byte FUNCTION_12VPULSE_NOW = (byte)(0xFD) |
DS9097U funciton command, 12V pulse imediate.
const byte FUNCTION_5VPULSE_ARM = (byte)(0xEF) |
DS9097U funciton command, 5V pulse after next byte.
const byte FUNCTION_5VPULSE_NOW = (byte)(0xED) |
DS9097U funciton command, 5V pulse imediate.
const byte FUNCTION_BIT = (byte)(0x81) |
DS9097U funciton command, single bit.
const byte FUNCTION_RESET = (byte)(0xC1) |
DS9097U funciton command, OneWire reset.
const byte FUNCTION_SEARCHOFF = (byte)(0xA1) |
DS9097U funciton command, turn Search mode off.
const byte FUNCTION_SEARCHON = (byte)(0xB1) |
DS9097U funciton command, turn Search mode on.
const byte FUNCTION_STOP_PULSE = (byte)(0xF1) |
DS9097U funciton command to stop an ongoing pulse.
const byte MAX_BYTES_STREAMED = (byte)(64) |
Max bytes to stream at once.
const int OPERATION_BYTE = 0 |
Byte operation.
const int OPERATION_SEARCH = 1 |
Byte operation.
internal RawSendPacket packet [protected] |
Current raw send packet before it is added to the packetsVector.
internal System.Collections.ArrayList packetsVector [protected] |
Vector of raw send packets.
const byte PRIME5V_FALSE = (byte)(0x00) |
DS9097U 5V prime off for function FUNCTION_BIT.
const byte PRIME5V_TRUE = (byte)(0x02) |
DS9097U 5V prime on for function FUNCTION_BIT.
const byte RESPONSE_BIT_MASK = (byte)(0x03) |
DS9097U mask to read bit operation result.
const byte RESPONSE_BIT_ONE = (byte)(0x03) |
DS9097U read bit operation 1.
const byte RESPONSE_BIT_ZERO = (byte)(0x00) |
DS9097U read bit operation 0.
const byte RESPONSE_RESET_ALARM = (byte)(0x02) |
DS9097U OneWire reset result = alarm.
const byte RESPONSE_RESET_MASK = (byte)(0x03) |
DS9097U mask to read the OneWire reset response byte.
const byte RESPONSE_RESET_NOPRESENCE = (byte)(0x03) |
DS9097U OneWire reset result = no presence.
const byte RESPONSE_RESET_PRESENCE = (byte)(0x01) |
DS9097U OneWire reset result = presence.
const byte RESPONSE_RESET_SHORT = (byte)(0x00) |
DS9097U OneWire reset result = shorted.
System.Collections.IEnumerator Packets [get] |
Retrieve enumeration of raw send packets.