Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Fork of Pulse1 by
PulseInOut Class Reference
Pulse Input/Output Class(es) More...
#include <Pulse1.h>
Public Member Functions | |
PulseInOut (PinName) | |
Create a PulseInOut object connected to the specified pin. | |
void | write (int val) |
Set the value of the pin. | |
void | write_us (int val, int time) |
Send a pulse of a given value for a specified time. | |
int | read_high_us () |
Return the length of the next HIGH pulse in microsconds. | |
int | read_high_us (int timeout) |
Return the length of the next HIGH pulse in microseconds or -1 if longer than timeout. | |
int | read_low_us () |
Return the length of the next LOW pulse in microsconds. | |
int | read_low_us (int timeout) |
Return the length of the next LOW pulse in microseconds or -1 if longer than timeout. | |
int | read_us () |
Return the length of the next pulse in microsconds. | |
int | read_us (int timeout) |
Return the length of the next pulse in microseconds or -1 if longer than timeout. |
Detailed Description
Pulse Input/Output Class(es)
Definition at line 10 of file Pulse1.h.
Constructor & Destructor Documentation
PulseInOut | ( | PinName | pin ) |
Create a PulseInOut object connected to the specified pin.
- Parameters:
-
pin i/o pin to connect to
Definition at line 4 of file Pulse1.cpp.
Member Function Documentation
int read_high_us | ( | ) |
Return the length of the next HIGH pulse in microsconds.
Definition at line 24 of file Pulse1.cpp.
int read_high_us | ( | int | timeout ) |
Return the length of the next HIGH pulse in microseconds or -1 if longer than timeout.
- Parameters:
-
timeout Time before pulse reading aborts and returns -1, in microseconds
Definition at line 38 of file Pulse1.cpp.
int read_low_us | ( | ) |
Return the length of the next LOW pulse in microsconds.
Definition at line 57 of file Pulse1.cpp.
int read_low_us | ( | int | timeout ) |
Return the length of the next LOW pulse in microseconds or -1 if longer than timeout.
- Parameters:
-
timeout Time before pulse reading aborts and returns -1, in microseconds
Definition at line 74 of file Pulse1.cpp.
int read_us | ( | ) |
Return the length of the next pulse in microsconds.
Definition at line 93 of file Pulse1.cpp.
int read_us | ( | int | timeout ) |
Return the length of the next pulse in microseconds or -1 if longer than timeout.
- Parameters:
-
timeout Time before pulse reading aborts and returns -1, in microseconds
Definition at line 106 of file Pulse1.cpp.
void write | ( | int | val ) |
Set the value of the pin.
- Parameters:
-
val Value to set, 0 for LOW, otherwise HIGH
Definition at line 12 of file Pulse1.cpp.
void write_us | ( | int | val, |
int | time | ||
) |
Send a pulse of a given value for a specified time.
- Parameters:
-
val Value to set, 0 for LOW, otherwise HIGH time Length of pulse in microseconds
Definition at line 17 of file Pulse1.cpp.
Generated on Tue Jul 19 2022 06:41:15 by
