Difference between revisions of "Unit W1"

From Ultibo.org
Jump to: navigation, search
 
(3 intermediate revisions by the same user not shown)
Line 5: Line 5:
 
----
 
----
  
−
'''Ultibo 1-Wire interface unit'''
+
'''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.
Line 74: Line 74:
 
| <code>W1_LOG_LEVEL_INFO = LOG_LEVEL_INFO;</code>
 
| <code>W1_LOG_LEVEL_INFO = LOG_LEVEL_INFO;</code>
 
| W1 informational messages, such as a device being attached or detached
 
| W1 informational messages, such as a device being attached or detached
 +
|-
 +
| <code> W1_LOG_LEVEL_WARN = LOG_LEVEL_WARN;</code>
 +
| W1 warning messages
 
|-
 
|-
 
| <code>W1_LOG_LEVEL_ERROR = LOG_LEVEL_ERROR;</code>
 
| <code>W1_LOG_LEVEL_ERROR = LOG_LEVEL_ERROR;</code>
Line 212: Line 215:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| Called only during system startup
 
| Called only during system startup
 
|-
 
|-
Line 227: Line 230:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''W1'''
+
! W1
 
| The W1 device to get properties from
 
| The W1 device to get properties from
 
|-
 
|-
−
! '''Properties'''
+
! Properties
 
| Pointer to a TW1Properties structure to fill in
 
| Pointer to a TW1Properties structure to fill in
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| ERROR_SUCCESS if completed or another error code on failure
 
| ERROR_SUCCESS if completed or another error code on failure
 
|-
 
|-
Line 245: Line 248:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| Pointer to new W1 entry or nil if W1 could not be created
 
| Pointer to new W1 entry or nil if W1 could not be created
 
|-
 
|-
Line 257: Line 260:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Size'''
+
! Size
 
| Size in bytes to allocate for new W1 (Including the W1 entry)
 
| Size in bytes to allocate for new W1 (Including the W1 entry)
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| Pointer to new W1 entry or nil if W1 could not be created
 
| Pointer to new W1 entry or nil if W1 could not be created
 
|-
 
|-
Line 272: Line 275:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 284: Line 287:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 296: Line 299:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 308: Line 311:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 320: Line 323:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 332: Line 335:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 344: Line 347:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 356: Line 359:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 366: Line 369:
  
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
−
<pre style="border: 0; padding-bottom:0px;">function W1GetCount:LongWord; inline;</pre>
+
<pre style="border: 0; padding-bottom:0px;">function W1GetCount:LongWord;</pre>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the current W1 count</div>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the current W1 count</div>
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 378: Line 381:
 
<br />
 
<br />
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
−
<pre style="border: 0; padding-bottom:0px;">function W1DeviceGetDefault:PW1Device; inline;</pre>
+
<pre style="border: 0; padding-bottom:0px;">function W1DeviceGetDefault:PW1Device;</pre>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the current default W1 device</div>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the current default W1 device</div>
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 395: Line 398:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 407: Line 410:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 414: Line 417:
 
<br />
 
<br />
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
−
<pre style="border: 0; padding-bottom:0px;">procedure W1Log(Level:LongWord; W1:PW1Device;const AText:String);</pre>
+
<pre style="border: 0; padding-bottom:0px;">procedure W1Log(Level:LongWord; W1:PW1Device; const AText:String);</pre>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 431: Line 434:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 +
| None documented
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 +
<pre style="border: 0; padding-bottom:0px;">procedure W1LogWarn(W1:PW1Device; const AText:String); inline;</pre>
 +
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 443: Line 458:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 455: Line 470:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-

Latest revision as of 02:31, 15 December 2022

Return to Unit Reference


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


[Expand]
W1 specific constants W1_*


[Expand]
W1 device types W1_TYPE_*


[Expand]
W1 device states W1_STATE_*


[Expand]
W1 device flags W1_FLAG_*


[Expand]
W1 logging W1_LOG_*


Type definitions


W1 properties

[Expand]

PW1Properties = ^TW1Properties;

TW1Properties = record

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

[Expand]

PW1Device = ^TW1Device;

TW1Device = record


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

[Expand] 
procedure W1Init;
Description: Initialize the W1 unit and W1 device table


W1 functions

[Expand] 
function W1DeviceGetProperties(W1:PW1Device; Properties:PW1Properties):LongWord;
Description: Get the properties for the specified W1 device


[Expand] 
function W1DeviceCreate:PW1Device;
Description: Create a new W1 entry


[Expand] 
function W1DeviceCreateEx(Size:LongWord):PW1Device;
Description: Create a new W1 entry


[Expand] 
function W1DeviceDestroy(W1:PW1Device):LongWord;
Description: Destroy an existing W1 entry


[Expand] 
function W1DeviceRegister(W1:PW1Device):LongWord;
Description: Register a new W1 in the W1 table


[Expand] 
function W1DeviceDeregister(W1:PW1Device):LongWord;
Description: Deregister a W1 from the W1 table


[Expand] 
function W1DeviceFind(W1Id:LongWord):PW1Device;
Description: To be documented


[Expand] 
function W1DeviceFindByName(const Name:String):PW1Device; inline;
Description: To be documented


[Expand] 
function W1DeviceFindByDescription(const Description:String):PW1Device; inline;
Description: To be documented


[Expand] 
function W1DeviceEnumerate(Callback:TW1Enumerate; Data:Pointer):LongWord;
Description: To be documented


[Expand] 
function W1DeviceNotification(W1:PW1Device; Callback:TW1Notification; Data:Pointer; Notification,Flags:LongWord):LongWord;
Description: To be documented


W1 helper functions

[Expand] 
function W1GetCount:LongWord;
Description: Get the current W1 count


[Expand] 
function W1DeviceGetDefault:PW1Device;
Description: Get the current default W1 device


[Expand] 
function W1DeviceSetDefault(W1:PW1Device):LongWord;
Description: Set the current default W1 device


[Expand] 
function W1DeviceCheck(W1:PW1Device):PW1Device;
Description: Check if the supplied W1 is in the W1 table


[Expand] 
procedure W1Log(Level:LongWord; W1:PW1Device; const AText:String);
Description: To be documented


[Expand] 
procedure W1LogInfo(W1:PW1Device; const AText:String); inline;
Description: To be documented


[Expand] 
procedure W1LogWarn(W1:PW1Device; const AText:String); inline;
Description: To be documented


[Expand] 
procedure W1LogError(W1:PW1Device; const AText:String); inline;
Description: To be documented


[Expand] 
procedure W1LogDebug(W1:PW1Device; const AText:String); inline;
Description: To be documented


Return to Unit Reference

Retrieved from "https://ultibo.org/mediawiki_ultibo_org/index.php?title=Unit_W1&oldid=5679"