Difference between revisions of "Unit W1"
| Line 5: | Line 5: | ||
---- | ---- | ||
| − | '''Ultibo 1-Wire | + | '''Ultibo 1-Wire Interface unit''' |
1-Wire is a communications bus designed by Dallas Semiconductor Corp that combines low speed signalling, data and power over a single signal line. It is often used for small devices such as digital thermometers. | 1-Wire is a communications bus designed by Dallas Semiconductor Corp that combines low speed signalling, data and power over a single signal line. It is often used for small devices such as digital thermometers. | ||
Revision as of 05:09, 31 August 2021
Return to Unit Reference
Contents
[hide]Description
Ultibo 1-Wire Interface unit
1-Wire is a communications bus designed by Dallas Semiconductor Corp that combines low speed signalling, data and power over a single signal line. It is often used for small devices such as digital thermometers.
Devices can actually be powered over the 1-Wire interface allowing the use of just data and ground lines.
Note: Because FreePascal does not permit the use of functions or variables that begin with a numeric value such as 1WIRE we use the term W1 throughout this unit to refer to a 1-Wire device. This is the same terminology as used in Linux and other systems.
Constants
W1_*
W1_TYPE_*
W1_STATE_*
W1_FLAG_*
W1_LOG_*
Type definitions
W1 properties
W1 enumeration callback
TW1Enumerate = function(W1:PW1Device; Data:Pointer):LongWord;
|
W1 notification callback
TW1Notification = function(Device:PDevice; Data:Pointer; Notification:LongWord):LongWord;
|
W1 device get properties
TW1DeviceGetProperties = function(W1:PW1Device; Properties:PW1Properties):LongWord;
|
W1 device
Public variables
W1 logging
W1_DEFAULT_LOG_LEVEL:LongWord = W1_LOG_LEVEL_DEBUG;
|
Minimum level for W1 messages. Only messages with level greater than or equal to this will be printed. |
W1_LOG_ENABLED:Boolean;
|
Function declarations
Initialization functions
W1 functions
function W1DeviceGetProperties(W1:PW1Device; Properties:PW1Properties):LongWord;
function W1DeviceRegister(W1:PW1Device):LongWord;
function W1DeviceDeregister(W1:PW1Device):LongWord;
function W1DeviceFindByName(const Name:String):PW1Device; inline;
function W1DeviceFindByDescription(const Description:String):PW1Device; inline;
function W1DeviceEnumerate(Callback:TW1Enumerate; Data:Pointer):LongWord;
function W1DeviceNotification(W1:PW1Device; Callback:TW1Notification; Data:Pointer; Notification,Flags:LongWord):LongWord;
W1 helper functions
function W1DeviceGetDefault:PW1Device; inline;
function W1DeviceSetDefault(W1:PW1Device):LongWord;
function W1DeviceCheck(W1:PW1Device):PW1Device;
procedure W1Log(Level:LongWord; W1:PW1Device; const AText:String);
procedure W1LogInfo(W1:PW1Device; const AText:String); inline;
procedure W1LogWarn(W1:PW1Device; const AText:String); inline;
procedure W1LogError(W1:PW1Device; const AText:String); inline;
procedure W1LogDebug(W1:PW1Device; const AText:String); inline;
Return to Unit Reference
