Difference between revisions of "Unit PWM"
(7 intermediate revisions by the same user not shown) | |||
Line 5: | Line 5: | ||
---- | ---- | ||
− | '''Ultibo PWM | + | '''Ultibo PWM Interface unit''' |
Pulse Width Modulation (PWM) is a technique of encoding a pulsed signal so as to control the ratio of on to off by switching the signal between on and off at a very high rate. | Pulse Width Modulation (PWM) is a technique of encoding a pulsed signal so as to control the ratio of on to off by switching the signal between on and off at a very high rate. | ||
Line 37: | Line 37: | ||
| <code>PWM_TYPE_NONE = 0;</code> | | <code>PWM_TYPE_NONE = 0;</code> | ||
| style="width: 50%;"| | | style="width: 50%;"| | ||
+ | |- | ||
+ | |colspan="2"| | ||
+ | |- | ||
+ | | <code>PWM_TYPE_MAX = 0;</code> | ||
+ | | | ||
|- | |- | ||
|} | |} | ||
Line 94: | Line 99: | ||
| <code>PWM_MODE_SERIALIZED = 2;</code> | | <code>PWM_MODE_SERIALIZED = 2;</code> | ||
| Serialized mode (Device specific) | | Serialized mode (Device specific) | ||
+ | |- | ||
+ | |colspan="2"| | ||
+ | |- | ||
+ | | <code>PWM_MODE_MAX = 2;</code> | ||
+ | | | ||
|- | |- | ||
|} | |} | ||
Line 107: | Line 117: | ||
|- | |- | ||
| <code>PWM_POLARITY_INVERSE = 1;</code> | | <code>PWM_POLARITY_INVERSE = 1;</code> | ||
+ | | | ||
+ | |- | ||
+ | |colspan="2"| | ||
+ | |- | ||
+ | | <code>PWM_POLARITY_MAX = 1;</code> | ||
| | | | ||
|- | |- | ||
Line 122: | Line 137: | ||
| <code>PWM_LOG_LEVEL_INFO = LOG_LEVEL_INFO;</code> | | <code>PWM_LOG_LEVEL_INFO = LOG_LEVEL_INFO;</code> | ||
| PWM informational messages, such as a device being attached or detached | | PWM informational messages, such as a device being attached or detached | ||
+ | |- | ||
+ | | <code>PWM_LOG_LEVEL_WARN = LOG_LEVEL_WARN;</code> | ||
+ | | PWM warning messages | ||
|- | |- | ||
| <code>PWM_LOG_LEVEL_ERROR = LOG_LEVEL_ERROR;</code> | | <code>PWM_LOG_LEVEL_ERROR = LOG_LEVEL_ERROR;</code> | ||
Line 320: | Line 338: | ||
|} | |} | ||
− | '''PWM device properties''' | + | '''PWM device get properties''' |
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;" | {| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;" | ||
|- | |- | ||
− | | <code> | + | | <code>TPWMDeviceGetProperties = function(PWM:PPWMDevice; Properties:PPWMProperties):LongWord;</code> |
| style="width: 40%;"| | | style="width: 40%;"| | ||
|- | |- | ||
Line 393: | Line 411: | ||
| A Device specific DeviceConfigure method implementing the standard PWM device interface (Mandatory) | | A Device specific DeviceConfigure method implementing the standard PWM device interface (Mandatory) | ||
|- | |- | ||
− | | <code> | + | | <code>DeviceGetProperties:TPWMDeviceGetProperties;</code> |
− | | A Device specific | + | | A Device specific DeviceGetProperties method implementing the standard PWM device interface (Or nil if the default method is suitable) |
|- | |- | ||
|colspan="2"|''Statistics Properties'' | |colspan="2"|''Statistics Properties'' | ||
Line 483: | Line 501: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
− | ! | + | ! Note |
| Called only during system startup | | Called only during system startup | ||
|- | |- | ||
Line 498: | Line 516: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
− | ! | + | ! PWM |
| The PWM device to start | | The PWM device to start | ||
|- | |- | ||
− | ! | + | ! Return |
| ERROR_SUCCESS if completed or another error code on failure | | ERROR_SUCCESS if completed or another error code on failure | ||
|- | |- | ||
Line 513: | Line 531: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
− | ! | + | ! PWM |
| The PWM device to stop | | The PWM device to stop | ||
|- | |- | ||
− | ! | + | ! Return |
| ERROR_SUCCESS if completed or another error code on failure | | ERROR_SUCCESS if completed or another error code on failure | ||
|- | |- | ||
Line 528: | Line 546: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
− | ! | + | ! PWM |
| The PWM device to write to | | The PWM device to write to | ||
|- | |- | ||
− | ! | + | ! Value |
| The value to write | | The value to write | ||
|- | |- | ||
− | ! | + | ! Return |
| ERROR_SUCCESS if completed or another error code on failure | | ERROR_SUCCESS if completed or another error code on failure | ||
|- | |- | ||
− | ! | + | ! Note |
− | | The exact meaning of value may depend on the device and other configured options, in many cases the value will represent the "on" time of each pulse with regard to the duty cycle of the waveform output by the device | + | | The exact meaning of value may depend on the device and other configured options, in many cases the value will represent the "on" time of each pulse with regard to the duty cycle of the waveform output by the device. |
|- | |- | ||
|} | |} | ||
Line 549: | Line 567: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
− | ! | + | ! PWM |
| The PWM device to get the GPIO pin from | | The PWM device to get the GPIO pin from | ||
|- | |- | ||
− | ! | + | ! Return |
| The current GPIO pin or GPIO_PIN_UNKNOWN on failure | | The current GPIO pin or GPIO_PIN_UNKNOWN on failure | ||
|- | |- | ||
Line 564: | Line 582: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
− | ! | + | ! PWM |
| The PWM device to set the GPIO pin for | | The PWM device to set the GPIO pin for | ||
|- | |- | ||
− | ! | + | ! GPIO |
| The GPIO pin to set (eg GPIO_PIN_12) | | The GPIO pin to set (eg GPIO_PIN_12) | ||
|- | |- | ||
− | ! | + | ! Return |
| ERROR_SUCCESS if completed or another error code on failure | | ERROR_SUCCESS if completed or another error code on failure | ||
|- | |- | ||
Line 582: | Line 600: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
− | ! | + | ! PWM |
| The PWM device to get the mode from | | The PWM device to get the mode from | ||
|- | |- | ||
− | ! | + | ! Return |
| The current mode or a default value of PWM_MODE_MARKSPACE | | The current mode or a default value of PWM_MODE_MARKSPACE | ||
|- | |- | ||
Line 597: | Line 615: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
− | ! | + | ! PWM |
| The PWM device to set the mode for | | The PWM device to set the mode for | ||
|- | |- | ||
− | ! | + | ! Mode |
| The mode value to set (eg PWM_MODE_MARKSPACE) | | The mode value to set (eg PWM_MODE_MARKSPACE) | ||
|- | |- | ||
− | ! | + | ! Return |
| ERROR_SUCCESS if completed or another error code on failure | | ERROR_SUCCESS if completed or another error code on failure | ||
|- | |- | ||
Line 615: | Line 633: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
− | ! | + | ! PWM |
| The PWM device to get the range from | | The PWM device to get the range from | ||
|- | |- | ||
− | ! | + | ! Return |
| The current range or 0 on failure | | The current range or 0 on failure | ||
|- | |- | ||
Line 630: | Line 648: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
− | ! | + | ! PWM |
| The PWM device to set the clock rate for | | The PWM device to set the clock rate for | ||
|- | |- | ||
− | ! | + | ! Range |
| The range value to set | | The range value to set | ||
|- | |- | ||
− | ! | + | ! Return |
| ERROR_SUCCESS if completed or another error code on failure | | ERROR_SUCCESS if completed or another error code on failure | ||
|- | |- | ||
− | ! | + | ! Note |
− | | The exact meaning of range may depend on the device and other configured options, in many cases the range will represent the period of one full cycle of the waveform output by the device | + | | The exact meaning of range may depend on the device and other configured options, in many cases the range will represent the period of one full cycle of the waveform output by the device. |
|- | |- | ||
|} | |} | ||
Line 651: | Line 669: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
− | ! | + | ! PWM |
| The PWM device to get the clock frequency from | | The PWM device to get the clock frequency from | ||
|- | |- | ||
− | ! | + | ! Return |
| The clock frequency in Hz or 0 on failure | | The clock frequency in Hz or 0 on failure | ||
|- | |- | ||
Line 666: | Line 684: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
− | ! | + | ! PWM |
| The PWM device to set the clock frequency for | | The PWM device to set the clock frequency for | ||
|- | |- | ||
− | ! | + | ! Frequency |
| The clock frequency to set in Hz | | The clock frequency to set in Hz | ||
|- | |- | ||
− | ! | + | ! Return |
| ERROR_SUCCESS if completed or another error code on failure | | ERROR_SUCCESS if completed or another error code on failure | ||
|- | |- | ||
Line 684: | Line 702: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
− | ! | + | ! PWM |
| The PWM device to get the polarity from | | The PWM device to get the polarity from | ||
|- | |- | ||
− | ! | + | ! Return |
| The current polarity or a default value of PWM_POLARITY_NORMAL | | The current polarity or a default value of PWM_POLARITY_NORMAL | ||
|- | |- | ||
Line 699: | Line 717: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
− | ! | + | ! PWM |
| The PWM device to set the polarity for | | The PWM device to set the polarity for | ||
|- | |- | ||
− | ! | + | ! Polarity |
| The polarity value to set (eg PWM_POLARITY_NORMAL) | | The polarity value to set (eg PWM_POLARITY_NORMAL) | ||
|- | |- | ||
− | ! | + | ! Return |
| ERROR_SUCCESS if completed or another error code on failure | | ERROR_SUCCESS if completed or another error code on failure | ||
|- | |- | ||
Line 717: | Line 735: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
− | ! | + | ! PWM |
| The PWM device to set the configuration for | | The PWM device to set the configuration for | ||
|- | |- | ||
− | ! | + | ! DutyNS |
| The "on" time part of the cycle (Nanoseconds) | | The "on" time part of the cycle (Nanoseconds) | ||
|- | |- | ||
− | ! | + | ! PeriodNS |
| The duration of one full cycle (Nanoseconds) | | The duration of one full cycle (Nanoseconds) | ||
|- | |- | ||
− | ! | + | ! Return |
| ERROR_SUCCESS if completed or another error code on failure | | ERROR_SUCCESS if completed or another error code on failure | ||
|- | |- | ||
Line 733: | Line 751: | ||
<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 PWMDeviceProperties(PWM:PPWMDevice; Properties:PPWMProperties):LongWord;</pre> | + | <pre style="border: 0; padding-bottom:0px;">function PWMDeviceProperties(PWM:PPWMDevice; Properties:PPWMProperties):LongWord; inline;</pre> |
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the properties for the specified PWM device</div> | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the properties for the specified PWM 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;" | ||
|- | |- | ||
− | ! | + | ! PWM |
| The PWM device to get properties from | | The PWM device to get properties from | ||
|- | |- | ||
− | ! | + | ! Properties |
| Pointer to a TPWMProperties structure to fill in | | Pointer to a TPWMProperties structure to fill in | ||
|- | |- | ||
− | ! ''' | + | ! Return |
+ | | ERROR_SUCCESS if completed or another error code on failure | ||
+ | |- | ||
+ | ! Note | ||
+ | | Replaced by PWMDeviceGetProperties for consistency | ||
+ | |- | ||
+ | |} | ||
+ | </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;">function PWMDeviceGetProperties(PWM:PPWMDevice; Properties:PPWMProperties):LongWord;</pre> | ||
+ | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the properties for the specified PWM device</div> | ||
+ | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;"> | ||
+ | {| class="wikitable" style="font-size: 14px; background: white;" | ||
+ | |- | ||
+ | ! PWM | ||
+ | | The PWM device to get properties from | ||
+ | |- | ||
+ | ! Properties | ||
+ | | Pointer to a TPWMProperties structure to fill in | ||
+ | |- | ||
+ | ! Return | ||
| ERROR_SUCCESS if completed or another error code on failure | | ERROR_SUCCESS if completed or another error code on failure | ||
|- | |- | ||
Line 756: | Line 795: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
− | ! | + | ! Return |
| Pointer to new PWM entry or nil if PWM could not be created | | Pointer to new PWM entry or nil if PWM could not be created | ||
|- | |- | ||
Line 768: | Line 807: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
− | ! | + | ! Size |
| Size in bytes to allocate for new PWM (Including the PWM entry) | | Size in bytes to allocate for new PWM (Including the PWM entry) | ||
|- | |- | ||
− | ! | + | ! Return |
| Pointer to new PWM entry or nil if PWM could not be created | | Pointer to new PWM entry or nil if PWM could not be created | ||
|- | |- | ||
Line 783: | Line 822: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
− | ! | + | ! Note |
| None documented | | None documented | ||
|- | |- | ||
Line 795: | Line 834: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
− | ! | + | ! Note |
| None documented | | None documented | ||
|- | |- | ||
Line 807: | Line 846: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
− | ! | + | ! Note |
| None documented | | None documented | ||
|- | |- | ||
Line 819: | Line 858: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
− | ! | + | ! Note |
| None documented | | None documented | ||
|- | |- | ||
Line 831: | Line 870: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
− | ! | + | ! Note |
| None documented | | None documented | ||
|- | |- | ||
Line 843: | Line 882: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
− | ! | + | ! Note |
| None documented | | None documented | ||
|- | |- | ||
Line 855: | Line 894: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
− | ! | + | ! Note |
| None documented | | None documented | ||
|- | |- | ||
Line 867: | Line 906: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
− | ! | + | ! Note |
| None documented | | None documented | ||
|- | |- | ||
Line 882: | Line 921: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
− | ! | + | ! Note |
| None documented | | None documented | ||
|- | |- | ||
Line 894: | Line 933: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
− | ! | + | ! Return |
| ERROR_SUCCESS if completed or another error code on failure | | ERROR_SUCCESS if completed or another error code on failure | ||
|- | |- | ||
Line 906: | Line 945: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
− | ! | + | ! Return |
| ERROR_SUCCESS if completed or another error code on failure | | ERROR_SUCCESS if completed or another error code on failure | ||
|- | |- | ||
Line 918: | Line 957: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
− | ! | + | ! Value |
| The value to write | | The value to write | ||
|- | |- | ||
− | ! | + | ! Return |
| ERROR_SUCCESS if completed or another error code on failure | | ERROR_SUCCESS if completed or another error code on failure | ||
|- | |- | ||
− | ! | + | ! Note |
− | | The exact meaning of value may depend on the device and other configured options, in many cases the value will represent the "on" time of each pulse with regard to the duty cycle of the waveform output by the device | + | | The exact meaning of value may depend on the device and other configured options, in many cases the value will represent the "on" time of each pulse with regard to the duty cycle of the waveform output by the device. |
|- | |- | ||
|} | |} | ||
Line 936: | Line 975: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
− | ! | + | ! Mode |
| The mode value to set (eg PWM_MODE_MARKSPACE) | | The mode value to set (eg PWM_MODE_MARKSPACE) | ||
|- | |- | ||
− | ! | + | ! Return |
| ERROR_SUCCESS if completed or another error code on failure | | ERROR_SUCCESS if completed or another error code on failure | ||
|- | |- | ||
Line 951: | Line 990: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
− | ! | + | ! Range |
| The range value to set | | The range value to set | ||
|- | |- | ||
− | ! | + | ! Return |
| ERROR_SUCCESS if completed or another error code on failure | | ERROR_SUCCESS if completed or another error code on failure | ||
|- | |- | ||
− | ! | + | ! Note |
− | | The exact meaning of range may depend on the device and other configured options, in many cases the range will represent the period of one full cycle of the waveform output by the device | + | | The exact meaning of range may depend on the device and other configured options, in many cases the range will represent the period of one full cycle of the waveform output by the device. |
|- | |- | ||
|} | |} | ||
Line 969: | Line 1,008: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
− | ! | + | ! Frequency |
| The frequency to set in Hz | | The frequency to set in Hz | ||
|- | |- | ||
− | ! | + | ! Return |
| ERROR_SUCCESS if completed or another error code on failure | | ERROR_SUCCESS if completed or another error code on failure | ||
|- | |- | ||
Line 984: | Line 1,023: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
− | ! | + | ! DutyNS |
| The "on" time part of the cycle (Nanoseconds) | | The "on" time part of the cycle (Nanoseconds) | ||
|- | |- | ||
− | ! | + | ! PeriodNS |
| The duration of one full cycle (Nanoseconds) | | The duration of one full cycle (Nanoseconds) | ||
|- | |- | ||
− | ! | + | ! Return |
| ERROR_SUCCESS if completed or another error code on failure | | ERROR_SUCCESS if completed or another error code on failure | ||
|- | |- | ||
Line 1,000: | Line 1,039: | ||
<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 PWMGetCount:LongWord | + | <pre style="border: 0; padding-bottom:0px;">function PWMGetCount:LongWord;</pre> |
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the current PWM count</div> | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the current PWM 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 |
| None documented | | None documented | ||
|- | |- | ||
Line 1,012: | Line 1,051: | ||
<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 PWMDeviceGetDefault:PPWMDevice | + | <pre style="border: 0; padding-bottom:0px;">function PWMDeviceGetDefault:PPWMDevice;</pre> |
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the current default PWM device</div> | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the current default PWM 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 |
| None documented | | None documented | ||
|- | |- | ||
Line 1,029: | Line 1,068: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
− | ! | + | ! Note |
| None documented | | None documented | ||
|- | |- | ||
Line 1,041: | Line 1,080: | ||
{| 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;">function PWMTypeToString(PWMType:LongWord):String;</pre> | ||
+ | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' Convert a PWM type value to a string</div> | ||
+ | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;"> | ||
+ | {| class="wikitable" style="font-size: 14px; background: white;" | ||
+ | |- | ||
+ | ! 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;">function PWMStateToString(PWMState:LongWord):String;</pre> | ||
+ | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' Convert a PWM state value to a string</div> | ||
+ | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;"> | ||
+ | {| class="wikitable" style="font-size: 14px; background: white;" | ||
+ | |- | ||
+ | ! 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;">function PWMModeToString(PWMMode:LongWord):String;</pre> | ||
+ | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' Convert a PWM mode value to a string</div> | ||
+ | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;"> | ||
+ | {| class="wikitable" style="font-size: 14px; background: white;" | ||
+ | |- | ||
+ | ! 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;">function PWMPolarityToString(PWMPolarity:LongWord):String;</pre> | ||
+ | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' Convert a PWM polarity value to a string</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 1,053: | Line 1,140: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
− | ! | + | ! Note |
| None documented | | None documented | ||
|- | |- | ||
Line 1,065: | Line 1,152: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
− | ! ''' | + | ! 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 PWMLogWarn(PWM:PPWMDevice; 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 1,077: | Line 1,176: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
− | ! | + | ! Note |
| None documented | | None documented | ||
|- | |- | ||
Line 1,089: | Line 1,188: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
− | ! | + | ! Note |
| None documented | | None documented | ||
|- | |- |
Latest revision as of 03:37, 15 December 2022
Return to Unit Reference
Description
Ultibo PWM Interface unit
Pulse Width Modulation (PWM) is a technique of encoding a pulsed signal so as to control the ratio of on to off by switching the signal between on and off at a very high rate.
This on and off switching allows control of the average power supplied to the load and therefore gives fine grained control of things such as motor speeds, lamp dimming and heating elements.
PWM is also used in many low power applications as well such as controlling servo motors and can even by used for audio applications such as class D amplifiers.
This unit deals with the usage of PWM for control applications (for audio applications see the Audio unit) and provides methods to control the state, frequency, duty cycle, range and mode of PWM host controllers. Not all devices support all of these concepts so this API includes a properties function to allow obtaining information about a PWM device and its capabilities.
Constants
PWM_*
PWM_NAME_PREFIX = 'PWM';
|
Name prefix for PWM Devices |
PWM_TYPE_*
PWM_TYPE_NONE = 0;
|
|
PWM_TYPE_MAX = 0;
|
PWM_STATE_*
PWM_STATE_DISABLED = 0;
|
|
PWM_STATE_ENABLED = 1;
|
PWM_FLAG_*
PWM_FLAG_NONE = $00000000;
|
|
PWM_FLAG_GPIO = $00000001;
|
Device supports Get/Set GPIO |
PWM_FLAG_MODE = $00000002;
|
Device supports Get/Set Mode |
PWM_FLAG_RANGE = $00000004;
|
Device supports Get/Set Range |
PWM_FLAG_FREQUENCY = $00000008;
|
Device supports Get/Set Frequency |
PWM_FLAG_POLARITY = $00000010;
|
Device supports Get/Set Polarity |
PWM_MODE_*
PWM_MODE_MARKSPACE = 0;
|
Standard PWM Mark/Space mode |
PWM_MODE_BALANCED = 1;
|
Balanced mode (Device specific) |
PWM_MODE_SERIALIZED = 2;
|
Serialized mode (Device specific) |
PWM_MODE_MAX = 2;
|
PWM_POLARITY_*
PWM_POLARITY_NORMAL = 0;
|
|
PWM_POLARITY_INVERSE = 1;
|
|
PWM_POLARITY_MAX = 1;
|
PWM_LOG_*
PWM_LOG_LEVEL_DEBUG = LOG_LEVEL_DEBUG;
|
PWM debugging messages |
PWM_LOG_LEVEL_INFO = LOG_LEVEL_INFO;
|
PWM informational messages, such as a device being attached or detached |
PWM_LOG_LEVEL_WARN = LOG_LEVEL_WARN;
|
PWM warning messages |
PWM_LOG_LEVEL_ERROR = LOG_LEVEL_ERROR;
|
PWM error messages |
PWM_LOG_LEVEL_NONE = LOG_LEVEL_NONE;
|
No PWM messages |
Type definitions
PWM properties
PPWMProperties = ^TPWMProperties;
TPWMProperties = record
Flags:LongWord;
|
Device flags (eg PWM_FLAG_MODE) |
GPIO:LongWord;
|
|
Mode:LongWord;
|
|
Range:LongWord;
|
|
Frequency:LongWord;
|
|
Polarity:LongWord;
|
|
DutyNS:LongWord;
|
|
PeriodNS:LongWord;
|
|
MinPeriod:LongWord;
|
PWM enumeration callback
TPWMEnumerate = function(PWM:PPWMDevice; Data:Pointer):LongWord;
|
PWM notification callback
TPWMNotification = function(Device:PDevice; Data:Pointer; Notification:LongWord):LongWord;
|
PWM device start
TPWMDeviceStart = function(PWM:PPWMDevice):LongWord;
|
PWM device stop
TPWMDeviceStop = function(PWM:PPWMDevice):LongWord;
|
PWM device write
TPWMDeviceWrite = function(PWM:PPWMDevice; Value:LongWord):LongWord;
|
PWM device get GPIO
TPWMDeviceGetGPIO = function(PWM:PPWMDevice):LongWord;
|
PWM device set GPIO
TPWMDeviceSetGPIO = function(PWM:PPWMDevice; GPIO:LongWord):LongWord;
|
PWM device get mode
TPWMDeviceGetMode = function(PWM:PPWMDevice):LongWord;
|
PWM device set mode
TPWMDeviceSetMode = function(PWM:PPWMDevice; Mode:LongWord):LongWord;
|
PWM device get range
TPWMDeviceGetRange = function(PWM:PPWMDevice):LongWord;
|
PWM device set range
TPWMDeviceSetRange = function(PWM:PPWMDevice; Range:LongWord):LongWord;
|
PWM device get frequency
TPWMDeviceGetFrequency = function(PWM:PPWMDevice):LongWord;
|
PWM device set frequency
TPWMDeviceSetFrequency = function(PWM:PPWMDevice; Frequency:LongWord):LongWord;
|
PWM device get polarity
TPWMDeviceGetPolarity = function(PWM:PPWMDevice):LongWord;
|
PWM device set polarity
TPWMDeviceSetPolarity = function(PWM:PPWMDevice; Polarity:LongWord):LongWord;
|
PWM device configure
TPWMDeviceConfigure = function(PWM:PPWMDevice; DutyNS,PeriodNS:LongWord):LongWord;
|
PWM device get properties
TPWMDeviceGetProperties = function(PWM:PPWMDevice; Properties:PPWMProperties):LongWord;
|
PWM device
PPWMDevice = ^TPWMDevice;
TPWMDevice = record
Device Properties | |
Device:TDevice;
|
The Device entry for this PWM |
PWM Properties | |
PWMId:LongWord;
|
Unique Id of this PWM in the PWM table |
PWMState:LongWord;
|
PWM state (eg PWM_STATE_ENABLED) |
DeviceStart:TPWMDeviceStart;
|
A Device specific DeviceStart method implementing the standard PWM device interface (Mandatory) |
DeviceStop:TPWMDeviceStop;
|
A Device specific DeviceStop method implementing the standard PWM device interface (Mandatory) |
DeviceWrite:TPWMDeviceWrite;
|
A Device specific DeviceWrite method implementing the standard PWM device interface (Mandatory) |
DeviceGetGPIO:TPWMDeviceGetGPIO;
|
A Device specific DeviceGetGPIO method implementing the standard PWM device interface (Or nil if the operation is not supported) |
DeviceSetGPIO:TPWMDeviceSetGPIO;
|
A Device specific DeviceSetGPIO method implementing the standard PWM device interface (Or nil if the operation is not supported) |
DeviceGetMode:TPWMDeviceGetMode;
|
A Device specific DeviceGetMode method implementing the standard PWM device interface (Or nil if the operation is not supported) |
DeviceSetMode:TPWMDeviceSetMode;
|
A Device specific DeviceSetMode method implementing the standard PWM device interface (Or nil if the operation is not supported) |
DeviceGetRange:TPWMDeviceGetRange;
|
A Device specific DeviceGetRange method implementing the standard PWM device interface (Or nil if the operation is not supported) |
DeviceSetRange:TPWMDeviceSetRange;
|
A Device specific DeviceSetRange method implementing the standard PWM device interface (Or nil if the operation is not supported) |
DeviceGetFrequency:TPWMDeviceGetFrequency;
|
A Device specific DeviceGetFrequency method implementing the standard PWM device interface (Or nil if the operation is not supported) |
DeviceSetFrequency:TPWMDeviceSetFrequency;
|
A Device specific DeviceSetFrequency method implementing the standard PWM device interface (Or nil if the operation is not supported) |
DeviceGetPolarity:TPWMDeviceGetPolarity;
|
A Device specific DeviceGetPolarity method implementing the standard PWM device interface (Or nil if the operation is not supported) |
DeviceSetPolarity:TPWMDeviceSetPolarity;
|
A Device specific DeviceSetPolarity method implementing the standard PWM device interface (Or nil if the operation is not supported) |
DeviceConfigure:TPWMDeviceConfigure;
|
A Device specific DeviceConfigure method implementing the standard PWM device interface (Mandatory) |
DeviceGetProperties:TPWMDeviceGetProperties;
|
A Device specific DeviceGetProperties method implementing the standard PWM device interface (Or nil if the default method is suitable) |
Statistics Properties | |
GetCount:LongWord;
|
|
SetCount:LongWord;
|
|
WriteCount:LongWord;
|
|
ConfigCount:LongWord;
|
|
Driver Properties | |
Lock:TMutexHandle;
|
Device lock |
GPIO:LongWord;
|
GPIO Pin |
Mode:LongWord;
|
Device Mode |
Range:LongWord;
|
Device Range |
Frequency:LongWord;
|
Clock Frequency |
Polarity:LongWord;
|
Output Polarity |
DutyNS:LongWord;
|
Duty Nanoseconds |
PeriodNS:LongWord;
|
Period Nanonseconds |
Properties:TPWMProperties;
|
Device properties |
Internal Properties | |
Prev:PPWMDevice;
|
Previous entry in PWM table |
Next:PPWMDevice;
|
Next entry in PWM table |
Public variables
PWM logging
PWM_DEFAULT_LOG_LEVEL:LongWord = PWM_LOG_LEVEL_DEBUG;
|
Minimum level for PWM messages. Only messages with level greater than or equal to this will be printed. |
PWM_LOG_ENABLED:Boolean;
|
Function declarations
Initialization functions
procedure PWMInit;
Note | Called only during system startup |
---|
PWM functions
function PWMDeviceStart(PWM:PPWMDevice):LongWord;
PWM | The PWM device to start |
---|---|
Return | ERROR_SUCCESS if completed or another error code on failure |
function PWMDeviceStop(PWM:PPWMDevice):LongWord;
PWM | The PWM device to stop |
---|---|
Return | ERROR_SUCCESS if completed or another error code on failure |
function PWMDeviceWrite(PWM:PPWMDevice; Value:LongWord):LongWord;
PWM | The PWM device to write to |
---|---|
Value | The value to write |
Return | ERROR_SUCCESS if completed or another error code on failure |
Note | The exact meaning of value may depend on the device and other configured options, in many cases the value will represent the "on" time of each pulse with regard to the duty cycle of the waveform output by the device. |
function PWMDeviceGetGPIO(PWM:PPWMDevice):LongWord;
PWM | The PWM device to get the GPIO pin from |
---|---|
Return | The current GPIO pin or GPIO_PIN_UNKNOWN on failure |
function PWMDeviceSetGPIO(PWM:PPWMDevice; GPIO:LongWord):LongWord;
PWM | The PWM device to set the GPIO pin for |
---|---|
GPIO | The GPIO pin to set (eg GPIO_PIN_12) |
Return | ERROR_SUCCESS if completed or another error code on failure |
function PWMDeviceGetMode(PWM:PPWMDevice):LongWord;
PWM | The PWM device to get the mode from |
---|---|
Return | The current mode or a default value of PWM_MODE_MARKSPACE |
function PWMDeviceSetMode(PWM:PPWMDevice; Mode:LongWord):LongWord;
PWM | The PWM device to set the mode for |
---|---|
Mode | The mode value to set (eg PWM_MODE_MARKSPACE) |
Return | ERROR_SUCCESS if completed or another error code on failure |
function PWMDeviceGetRange(PWM:PPWMDevice):LongWord;
PWM | The PWM device to get the range from |
---|---|
Return | The current range or 0 on failure |
function PWMDeviceSetRange(PWM:PPWMDevice; Range:LongWord):LongWord;
PWM | The PWM device to set the clock rate for |
---|---|
Range | The range value to set |
Return | ERROR_SUCCESS if completed or another error code on failure |
Note | The exact meaning of range may depend on the device and other configured options, in many cases the range will represent the period of one full cycle of the waveform output by the device. |
function PWMDeviceGetFrequency(PWM:PPWMDevice):LongWord;
PWM | The PWM device to get the clock frequency from |
---|---|
Return | The clock frequency in Hz or 0 on failure |
function PWMDeviceSetFrequency(PWM:PPWMDevice; Frequency:LongWord):LongWord;
PWM | The PWM device to set the clock frequency for |
---|---|
Frequency | The clock frequency to set in Hz |
Return | ERROR_SUCCESS if completed or another error code on failure |
function PWMDeviceGetPolarity(PWM:PPWMDevice):LongWord;
PWM | The PWM device to get the polarity from |
---|---|
Return | The current polarity or a default value of PWM_POLARITY_NORMAL |
function PWMDeviceSetPolarity(PWM:PPWMDevice; Polarity:LongWord):LongWord;
PWM | The PWM device to set the polarity for |
---|---|
Polarity | The polarity value to set (eg PWM_POLARITY_NORMAL) |
Return | ERROR_SUCCESS if completed or another error code on failure |
function PWMDeviceConfigure(PWM:PPWMDevice; DutyNS,PeriodNS:LongWord):LongWord;
PWM | The PWM device to set the configuration for |
---|---|
DutyNS | The "on" time part of the cycle (Nanoseconds) |
PeriodNS | The duration of one full cycle (Nanoseconds) |
Return | ERROR_SUCCESS if completed or another error code on failure |
function PWMDeviceProperties(PWM:PPWMDevice; Properties:PPWMProperties):LongWord; inline;
PWM | The PWM device to get properties from |
---|---|
Properties | Pointer to a TPWMProperties structure to fill in |
Return | ERROR_SUCCESS if completed or another error code on failure |
Note | Replaced by PWMDeviceGetProperties for consistency |
function PWMDeviceGetProperties(PWM:PPWMDevice; Properties:PPWMProperties):LongWord;
PWM | The PWM device to get properties from |
---|---|
Properties | Pointer to a TPWMProperties structure to fill in |
Return | ERROR_SUCCESS if completed or another error code on failure |
function PWMDeviceCreate:PPWMDevice;
Return | Pointer to new PWM entry or nil if PWM could not be created |
---|
function PWMDeviceCreateEx(Size:LongWord):PPWMDevice;
Size | Size in bytes to allocate for new PWM (Including the PWM entry) |
---|---|
Return | Pointer to new PWM entry or nil if PWM could not be created |
function PWMDeviceDestroy(PWM:PPWMDevice):LongWord;
Note | None documented |
---|
function PWMDeviceRegister(PWM:PPWMDevice):LongWord;
Note | None documented |
---|
function PWMDeviceDeregister(PWM:PPWMDevice):LongWord;
Note | None documented |
---|
function PWMDeviceFind(PWMId:LongWord):PPWMDevice;
Note | None documented |
---|
function PWMDeviceFindByName(const Name:String):PPWMDevice; inline;
Note | None documented |
---|
function PWMDeviceFindByDescription(const Description:String):PPWMDevice; inline;
Note | None documented |
---|
function PWMDeviceEnumerate(Callback:TPWMEnumerate; Data:Pointer):LongWord;
Note | None documented |
---|
function PWMDeviceNotification(PWM:PPWMDevice; Callback:TPWMNotification; Data:Pointer; Notification,Flags:LongWord):LongWord;
Note | None documented |
---|
RTL PWM functions
function SysPWMAvailable:Boolean;
Note | None documented |
---|
function SysPWMStart:LongWord;
Return | ERROR_SUCCESS if completed or another error code on failure |
---|
function SysPWMStop:LongWord;
Return | ERROR_SUCCESS if completed or another error code on failure |
---|
function SysPWMWrite(Value:LongWord):LongWord;
Value | The value to write |
---|---|
Return | ERROR_SUCCESS if completed or another error code on failure |
Note | The exact meaning of value may depend on the device and other configured options, in many cases the value will represent the "on" time of each pulse with regard to the duty cycle of the waveform output by the device. |
function SysPWMSetMode(Mode:LongWord):LongWord;
Mode | The mode value to set (eg PWM_MODE_MARKSPACE) |
---|---|
Return | ERROR_SUCCESS if completed or another error code on failure |
function SysPWMSetRange(Range:LongWord):LongWord;
Range | The range value to set |
---|---|
Return | ERROR_SUCCESS if completed or another error code on failure |
Note | The exact meaning of range may depend on the device and other configured options, in many cases the range will represent the period of one full cycle of the waveform output by the device. |
function SysPWMSetFrequency(Frequency:LongWord):LongWord;
Frequency | The frequency to set in Hz |
---|---|
Return | ERROR_SUCCESS if completed or another error code on failure |
function SysPWMConfigure(DutyNS,PeriodNS:LongWord):LongWord;
DutyNS | The "on" time part of the cycle (Nanoseconds) |
---|---|
PeriodNS | The duration of one full cycle (Nanoseconds) |
Return | ERROR_SUCCESS if completed or another error code on failure |
PWM helper functions
function PWMGetCount:LongWord;
Note | None documented |
---|
function PWMDeviceGetDefault:PPWMDevice;
Note | None documented |
---|
function PWMDeviceSetDefault(PWM:PPWMDevice):LongWord;
Note | None documented |
---|
function PWMDeviceCheck(PWM:PPWMDevice):PPWMDevice;
Note | None documented |
---|
function PWMTypeToString(PWMType:LongWord):String;
Note | None documented |
---|
function PWMStateToString(PWMState:LongWord):String;
Note | None documented |
---|
function PWMModeToString(PWMMode:LongWord):String;
Note | None documented |
---|
function PWMPolarityToString(PWMPolarity:LongWord):String;
Note | None documented |
---|
procedure PWMLog(Level:LongWord; PWM:PPWMDevice; const AText:String);
Note | None documented |
---|
procedure PWMLogInfo(PWM:PPWMDevice; const AText:String); inline;
Note | None documented |
---|
procedure PWMLogWarn(PWM:PPWMDevice; const AText:String); inline;
Note | None documented |
---|
procedure PWMLogError(PWM:PPWMDevice; const AText:String); inline;
Note | None documented |
---|
procedure PWMLogDebug(PWM:PPWMDevice; const AText:String); inline;
Note | None documented |
---|
Return to Unit Reference