pigpio/pigpiod_if2.3

." Process this file with
." groff -man -Tascii pigpiod_if2.3
."
.TH pigpiod_if2 3 2012-2020 Linux "pigpio archive"
.SH NAME
pigpiod_if2 - A C library to interface to the pigpio daemon.

.SH SYNOPSIS

#include <pigpiod_if2.h>


gcc -Wall -pthread -o prog prog.c -lpigpiod_if2 -lrt

 ./prog
.SH DESCRIPTION


.ad l

.nh

.br

.br
pigpiod_if2 is a C library for the Raspberry which allows control
of the GPIO via the socket interface to the pigpio daemon.
.br

.br

.br
.SS Features
.br

.br
o hardware timed PWM on any of GPIO 0-31

.br

.br
o hardware timed servo pulses on any of GPIO 0-31

.br

.br
o callbacks when any of GPIO 0-31 change state

.br

.br
o callbacks at timed intervals

.br

.br
o reading/writing all of the GPIO in a bank as one operation

.br

.br
o individually setting GPIO modes, reading and writing

.br

.br
o notifications when any of GPIO 0-31 change state

.br

.br
o the construction of output waveforms with microsecond timing

.br

.br
o rudimentary permission control over GPIO

.br

.br
o a simple interface to start and stop new threads

.br

.br
o I2C, SPI, and serial link wrappers

.br

.br
o creating and running scripts on the pigpio daemon

.br

.br
.SS GPIO
.br

.br
ALL GPIO are identified by their Broadcom number.

.br

.br
.SS Notes
.br

.br
The PWM and servo pulses are timed using the DMA and PWM/PCM peripherals.

.br

.br
.SS Usage
.br

.br
Include <pigpiod_if2.h> in your source files.

.br

.br
Assuming your source is in prog.c use the following command to build

.br

.br

.EX
gcc -Wall -pthread -o prog prog.c -lpigpiod_if2 -lrt
.br

.EE

.br

.br
to run make sure the pigpio daemon is running

.br

.br

.EX
sudo pigpiod
.br

.br
 ./prog # sudo is not required to run programs linked to pigpiod_if2
.br

.EE

.br

.br
For examples see x_pigpiod_if2.c within the pigpio archive file.

.br

.br
.SS Notes
.br

.br
All the functions which return an int return < 0 on error

.br

.br

.SH OVERVIEW

.br
.SS ESSENTIAL
.br

.br
pigpio_start               Connects to a pigpio daemon
.br
pigpio_stop                Disconnects from a pigpio daemon
.br
.SS BASIC
.br

.br
set_mode                   Set a GPIO mode
.br
get_mode                   Get a GPIO mode
.br

.br
set_pull_up_down           Set/clear GPIO pull up/down resistor
.br

.br
gpio_read                  Read a GPIO
.br
gpio_write                 Write a GPIO
.br
.SS PWM (overrides servo commands on same GPIO)
.br

.br
set_PWM_dutycycle          Start/stop PWM pulses on a GPIO
.br
set_PWM_frequency          Configure PWM frequency for a GPIO
.br
set_PWM_range              Configure PWM range for a GPIO
.br

.br
get_PWM_dutycycle          Get the PWM dutycycle in use on a GPIO
.br
get_PWM_frequency          Get configured PWM frequency for a GPIO
.br
get_PWM_range              Get configured PWM range for a GPIO
.br

.br
get_PWM_real_range         Get underlying PWM range for a GPIO
.br
.SS Servo (overrides PWM commands on same GPIO)
.br

.br
set_servo_pulsewidth       Start/stop servo pulses on a GPIO
.br

.br
get_servo_pulsewidth       Get the servo pulsewidth in use on a GPIO
.br
.SS INTERMEDIATE
.br

.br
gpio_trigger               Send a trigger pulse to a GPIO.
.br

.br
set_watchdog               Set a watchdog on a GPIO.
.br

.br
read_bank_1                Read all GPIO in bank 1
.br
read_bank_2                Read all GPIO in bank 2
.br

.br
clear_bank_1               Clear selected GPIO in bank 1
.br
clear_bank_2               Clear selected GPIO in bank 2
.br

.br
set_bank_1                 Set selected GPIO in bank 1
.br
set_bank_2                 Set selected GPIO in bank 2
.br

.br
callback                   Create GPIO level change callback
.br
callback_ex                Create GPIO level change callback, extended
.br

.br
callback_cancel            Cancel a callback
.br

.br
wait_for_edge              Wait for GPIO level change
.br

.br
start_thread               Start a new thread
.br
stop_thread                Stop a previously started thread
.br
.SS ADVANCED
.br

.br
notify_open                Request a notification handle
.br
notify_begin               Start notifications for selected GPIO
.br
notify_pause               Pause notifications
.br
notify_close               Close a notification
.br

.br
hardware_clock             Start hardware clock on supported GPIO
.br

.br
hardware_PWM               Start hardware PWM on supported GPIO
.br

.br
set_glitch_filter          Set a glitch filter on a GPIO
.br
set_noise_filter           Set a noise filter on a GPIO
.br

.br
set_pad_strength           Sets a pads drive strength
.br
get_pad_strength           Gets a pads drive strength
.br

.br
shell_                     Executes a shell command
.br
.SS Custom
.br

.br
custom_1                   User custom function 1
.br
custom_2                   User custom function 2
.br
.SS Events
.br

.br
event_callback            Sets a callback for an event
.br
event_callback_ex         Sets a callback for an event, extended
.br

.br
event_callback_cancel     Cancel an event callback
.br

.br
event_trigger             Triggers an event
.br

.br
wait_for_event            Wait for an event
.br
.SS Scripts
.br

.br
store_script               Store a script
.br
run_script                 Run a stored script
.br
update_script              Set a scripts parameters
.br
script_status              Get script status and parameters
.br
stop_script                Stop a running script
.br
delete_script              Delete a stored script
.br
.SS I2C
.br

.br
i2c_open                   Opens an I2C device
.br
i2c_close                  Closes an I2C device
.br

.br
i2c_write_quick            smbus write quick
.br

.br
i2c_read_byte              smbus read byte
.br
i2c_write_byte             smbus write byte
.br

.br
i2c_read_byte_data         smbus read byte data
.br
i2c_write_byte_data        smbus write byte data
.br

.br
i2c_read_word_data         smbus read word data
.br
i2c_write_word_data        smbus write word data
.br

.br
i2c_read_block_data        smbus read block data
.br
i2c_write_block_data       smbus write block data
.br

.br
i2c_read_i2c_block_data    smbus read I2C block data
.br
i2c_write_i2c_block_data   smbus write I2C block data
.br

.br
i2c_read_device            Reads the raw I2C device
.br
i2c_write_device           Writes the raw I2C device
.br

.br
i2c_process_call           smbus process call
.br
i2c_block_process_call     smbus block process call
.br

.br
i2c_zip                    Performs multiple I2C transactions
.br
.SS I2C BIT BANG
.br

.br
bb_i2c_open                Opens GPIO for bit banging I2C
.br
bb_i2c_close               Closes GPIO for bit banging I2C
.br

.br
bb_i2c_zip                 Performs bit banged I2C transactions
.br
.SS I2C/SPI SLAVE
.br

.br
bsc_xfer                   I2C/SPI as slave transfer
.br
bsc_i2c                    I2C as slave transfer
.br
.SS SERIAL
.br

.br
serial_open                Opens a serial device
.br
serial_close               Closes a serial device
.br

.br
serial_read_byte           Reads a byte from a serial device
.br
serial_write_byte          Writes a byte to a serial device
.br

.br
serial_read                Reads bytes from a serial device
.br
serial_write               Writes bytes to a serial device
.br

.br
serial_data_available      Returns number of bytes ready to be read
.br
.SS SERIAL BIT BANG (read only)
.br

.br
bb_serial_read_open        Opens a GPIO for bit bang serial reads
.br
bb_serial_read_close       Closes a GPIO for bit bang serial reads
.br

.br
bb_serial_invert           Invert serial logic (1 invert, 0 normal)
.br

.br
bb_serial_read             Reads bit bang serial data from a GPIO
.br
.SS SPI
.br

.br
spi_open                   Opens a SPI device
.br
spi_close                  Closes a SPI device
.br

.br
spi_read                   Reads bytes from a SPI device
.br
spi_write                  Writes bytes to a SPI device
.br
spi_xfer                   Transfers bytes with a SPI device
.br
.SS SPI BIT BANG
.br

.br
bb_spi_open                Opens GPIO for bit banging SPI
.br
bb_spi_close               Closes GPIO for bit banging SPI
.br

.br
bb_spi_xfer                Transfers bytes with bit banging SPI
.br
.SS FILES
.br

.br
file_open                  Opens a file
.br
file_close                 Closes a file
.br

.br
file_read                  Reads bytes from a file
.br
file_write                 Writes bytes to a file
.br

.br
file_seek                  Seeks to a position within a file
.br

.br
file_list                  List files which match a pattern
.br
.SS WAVES
.br

.br
wave_clear                 Deletes all waveforms
.br

.br
wave_add_new               Starts a new waveform
.br
wave_add_generic           Adds a series of pulses to the waveform
.br
wave_add_serial            Adds serial data to the waveform
.br

.br
wave_create                Creates a waveform from added data
.br
wave_create_and_pad        Creates a waveform of fixed size from added data
.br
wave_delete                Deletes one or more waveforms
.br

.br
wave_send_once             Transmits a waveform once
.br
wave_send_repeat           Transmits a waveform repeatedly
.br
wave_send_using_mode       Transmits a waveform in the chosen mode
.br

.br
wave_chain                 Transmits a chain of waveforms
.br

.br
wave_tx_at                 Returns the current transmitting waveform
.br

.br
wave_tx_busy               Checks to see if the waveform has ended
.br

.br
wave_tx_stop               Aborts the current waveform
.br

.br
wave_get_cbs               Length in cbs of the current waveform
.br
wave_get_high_cbs          Length of longest waveform so far
.br
wave_get_max_cbs           Absolute maximum allowed cbs
.br

.br
wave_get_micros            Length in micros of the current waveform
.br
wave_get_high_micros       Length of longest waveform so far
.br
wave_get_max_micros        Absolute maximum allowed micros
.br

.br
wave_get_pulses            Length in pulses of the current waveform
.br
wave_get_high_pulses       Length of longest waveform so far
.br
wave_get_max_pulses        Absolute maximum allowed pulses
.br
.SS UTILITIES
.br

.br
get_current_tick           Get current tick (microseconds)
.br

.br
get_hardware_revision      Get hardware revision
.br
get_pigpio_version         Get the pigpio version
.br
pigpiod_if_version         Get the pigpiod_if2 version
.br

.br
pigpio_error               Get a text description of an error code.
.br

.br
time_sleep                 Sleeps for a float number of seconds
.br
time_time                  Float number of seconds since the epoch
.br
.SH FUNCTIONS

.IP "\fBdouble time_time(void)\fP"
.IP "" 4
Return the current time in seconds since the Epoch.

.IP "\fBvoid time_sleep(double seconds)\fP"
.IP "" 4
Delay execution for a given number of seconds.

.br

.br

.EX
seconds: the number of seconds to delay.
.br

.EE

.IP "\fBchar *pigpio_error(int errnum)\fP"
.IP "" 4
Return a text description for an error code.

.br

.br

.EX
errnum: the error code.
.br

.EE

.IP "\fBunsigned pigpiod_if_version(void)\fP"
.IP "" 4
Return the pigpiod_if2 version.

.IP "\fBpthread_t *start_thread(gpioThreadFunc_t thread_func, void *userdata)\fP"
.IP "" 4
Starts a new thread of execution with thread_func as the main routine.

.br

.br

.EX
thread_func: the main function for the new thread.
.br
   userdata: a pointer to an arbitrary argument.
.br

.EE

.br

.br
Returns a pointer to pthread_t if OK, otherwise NULL.

.br

.br
The function is passed the single argument userdata.

.br

.br
The thread can be cancelled by passing the pointer to pthread_t to
\fBstop_thread\fP.

.IP "\fBvoid stop_thread(pthread_t *pth)\fP"
.IP "" 4
Cancels the thread pointed at by pth.

.br

.br

.EX
pth: the thread to be stopped.
.br

.EE

.br

.br
No value is returned.

.br

.br
The thread to be stopped should have been started with \fBstart_thread\fP.

.IP "\fBint pigpio_start(const char *addrStr, const char *portStr)\fP"
.IP "" 4
Connect to the pigpio daemon.  Reserving command and
notification streams.

.br

.br

.EX
addrStr: specifies the host or IP address of the Pi running the
.br
         pigpio daemon.  It may be NULL in which case localhost
.br
         is used unless overridden by the PIGPIO_ADDR environment
.br
         variable.
.br

.br
portStr: specifies the port address used by the Pi running the
.br
         pigpio daemon.  It may be NULL in which case "8888"
.br
         is used unless overridden by the PIGPIO_PORT environment
.br
         variable.
.br

.EE

.br

.br
Returns an integer value greater than or equal to zero if OK.

.br

.br
This value is passed to the GPIO routines to specify the Pi
to be operated on.

.IP "\fBvoid pigpio_stop(int pi)\fP"
.IP "" 4
Terminates the connection to a pigpio daemon and releases
resources used by the library.

.br

.br

.EX
pi: >=0 (as returned by \fBpigpio_start\fP).
.br

.EE

.IP "\fBint set_mode(int pi, unsigned gpio, unsigned mode)\fP"
.IP "" 4
Set the GPIO mode.

.br

.br

.EX
  pi: >=0 (as returned by \fBpigpio_start\fP).
.br
gpio: 0-53.
.br
mode: PI_INPUT, PI_OUTPUT, PI_ALT0, PI_ALT1,
.br
      PI_ALT2, PI_ALT3, PI_ALT4, PI_ALT5.
.br

.EE

.br

.br
Returns 0 if OK, otherwise PI_BAD_GPIO, PI_BAD_MODE,
or PI_NOT_PERMITTED.

.IP "\fBint get_mode(int pi, unsigned gpio)\fP"
.IP "" 4
Get the GPIO mode.

.br

.br

.EX
  pi: >=0 (as returned by \fBpigpio_start\fP).
.br
gpio: 0-53.
.br

.EE

.br

.br
Returns the GPIO mode if OK, otherwise PI_BAD_GPIO.

.IP "\fBint set_pull_up_down(int pi, unsigned gpio, unsigned pud)\fP"
.IP "" 4
Set or clear the GPIO pull-up/down resistor.

.br

.br

.EX
  pi: >=0 (as returned by \fBpigpio_start\fP).
.br
gpio: 0-53.
.br
 pud: PI_PUD_UP, PI_PUD_DOWN, PI_PUD_OFF.
.br

.EE

.br

.br
Returns 0 if OK, otherwise PI_BAD_GPIO, PI_BAD_PUD,
or PI_NOT_PERMITTED.

.IP "\fBint gpio_read(int pi, unsigned gpio)\fP"
.IP "" 4
Read the GPIO level.

.br

.br

.EX
  pi: >=0 (as returned by \fBpigpio_start\fP).
.br
gpio:0-53.
.br

.EE

.br

.br
Returns the GPIO level if OK, otherwise PI_BAD_GPIO.

.IP "\fBint gpio_write(int pi, unsigned gpio, unsigned level)\fP"
.IP "" 4
Write the GPIO level.

.br

.br

.EX
   pi: >=0 (as returned by \fBpigpio_start\fP).
.br
 gpio: 0-53.
.br
level: 0, 1.
.br

.EE

.br

.br
Returns 0 if OK, otherwise PI_BAD_GPIO, PI_BAD_LEVEL,
or PI_NOT_PERMITTED.

.br

.br
Notes

.br

.br
If PWM or servo pulses are active on the GPIO they are switched off.

.IP "\fBint set_PWM_dutycycle(int pi, unsigned user_gpio, unsigned dutycycle)\fP"
.IP "" 4
Start (non-zero dutycycle) or stop (0) PWM pulses on the GPIO.

.br

.br

.EX
       pi: >=0 (as returned by \fBpigpio_start\fP).
.br
user_gpio: 0-31.
.br
dutycycle: 0-range (range defaults to 255).
.br

.EE

.br

.br
Returns 0 if OK, otherwise PI_BAD_USER_GPIO, PI_BAD_DUTYCYCLE,
or PI_NOT_PERMITTED.
Notes

.br

.br
The \fBset_PWM_range\fP function may be used to change the
default range of 255.

.IP "\fBint get_PWM_dutycycle(int pi, unsigned user_gpio)\fP"
.IP "" 4
Return the PWM dutycycle in use on a GPIO.

.br

.br

.EX
       pi: >=0 (as returned by \fBpigpio_start\fP).
.br
user_gpio: 0-31.
.br

.EE

.br

.br
Returns current PWM dutycycle if OK,
otherwise PI_BAD_USER_GPIO or PI_NOT_PWM_GPIO.

.br

.br
For normal PWM the dutycycle will be out of the defined range
for the GPIO (see \fBget_PWM_range\fP).

.br

.br
If a hardware clock is active on the GPIO the reported dutycycle
will be 500000 (500k) out of 1000000 (1M).

.br

.br
If hardware PWM is active on the GPIO the reported dutycycle
will be out of a 1000000 (1M).

.IP "\fBint set_PWM_range(int pi, unsigned user_gpio, unsigned range)\fP"
.IP "" 4
Set the range of PWM values to be used on the GPIO.

.br

.br

.EX
       pi: >=0 (as returned by \fBpigpio_start\fP).
.br
user_gpio: 0-31.
.br
    range: 25-40000.
.br

.EE

.br

.br
Returns 0 if OK, otherwise PI_BAD_USER_GPIO, PI_BAD_DUTYRANGE,
or PI_NOT_PERMITTED.

.br

.br
Notes

.br

.br
If PWM is currently active on the GPIO its dutycycle will be
scaled to reflect the new range.

.br

.br
The real range, the number of steps between fully off and fully on
for each of the 18 available GPIO frequencies is

.br

.br

.EX
  25(#1),    50(#2),   100(#3),   125(#4),    200(#5),    250(#6),
.br
 400(#7),   500(#8),   625(#9),   800(#10),  1000(#11),  1250(#12),
.br
2000(#13), 2500(#14), 4000(#15), 5000(#16), 10000(#17), 20000(#18)
.br

.EE

.br

.br
The real value set by set_PWM_range is (dutycycle * real range) / range.

.IP "\fBint get_PWM_range(int pi, unsigned user_gpio)\fP"
.IP "" 4
Get the range of PWM values being used on the GPIO.

.br

.br

.EX
       pi: >=0 (as returned by \fBpigpio_start\fP).
.br
user_gpio: 0-31.
.br

.EE

.br

.br
Returns the dutycycle range used for the GPIO if OK,
otherwise PI_BAD_USER_GPIO.

.br

.br
If a hardware clock or hardware PWM is active on the GPIO the
reported range will be 1000000 (1M).

.IP "\fBint get_PWM_real_range(int pi, unsigned user_gpio)\fP"
.IP "" 4
Get the real underlying range of PWM values being used on the GPIO.

.br

.br

.EX
       pi: >=0 (as returned by \fBpigpio_start\fP).
.br
user_gpio: 0-31.
.br

.EE

.br

.br
Returns the real range used for the GPIO if OK,
otherwise PI_BAD_USER_GPIO.

.br

.br
If a hardware clock is active on the GPIO the reported
real range will be 1000000 (1M).

.br

.br
If hardware PWM is active on the GPIO the reported real range
will be approximately 250M divided by the set PWM frequency.

.br

.br

.IP "\fBint set_PWM_frequency(int pi, unsigned user_gpio, unsigned frequency)\fP"
.IP "" 4
Set the frequency (in Hz) of the PWM to be used on the GPIO.

.br

.br

.EX
       pi: >=0 (as returned by \fBpigpio_start\fP).
.br
user_gpio: 0-31.
.br
frequency: >=0 (Hz).
.br

.EE

.br

.br
Returns the numerically closest frequency if OK, otherwise
PI_BAD_USER_GPIO or PI_NOT_PERMITTED.

.br

.br
If PWM is currently active on the GPIO it will be switched
off and then back on at the new frequency.

.br

.br
Each GPIO can be independently set to one of 18 different
PWM frequencies.

.br

.br
The selectable frequencies depend upon the sample rate which
may be 1, 2, 4, 5, 8, or 10 microseconds (default 5).  The
sample rate is set when the pigpio daemon is started.

.br

.br
The frequencies for each sample rate are:

.br

.br

.EX
                       Hertz
.br

.br
       1: 40000 20000 10000 8000 5000 4000 2500 2000 1600
.br
           1250  1000   800  500  400  250  200  100   50
.br

.br
       2: 20000 10000  5000 4000 2500 2000 1250 1000  800
.br
            625   500   400  250  200  125  100   50   25
.br

.br
       4: 10000  5000  2500 2000 1250 1000  625  500  400
.br
            313   250   200  125  100   63   50   25   13
.br
sample
.br
 rate
.br
 (us)  5:  8000  4000  2000 1600 1000  800  500  400  320
.br
            250   200   160  100   80   50   40   20   10
.br

.br
       8:  5000  2500  1250 1000  625  500  313  250  200
.br
            156   125   100   63   50   31   25   13    6
.br

.br
      10:  4000  2000  1000  800  500  400  250  200  160
.br
            125   100    80   50   40   25   20   10    5
.br

.EE

.IP "\fBint get_PWM_frequency(int pi, unsigned user_gpio)\fP"
.IP "" 4
Get the frequency of PWM being used on the GPIO.

.br

.br

.EX
       pi: >=0 (as returned by \fBpigpio_start\fP).
.br
user_gpio: 0-31.
.br

.EE

.br

.br
For normal PWM the frequency will be that defined for the GPIO by
\fBset_PWM_frequency\fP.

.br

.br
If a hardware clock is active on the GPIO the reported frequency
will be that set by \fBhardware_clock\fP.

.br

.br
If hardware PWM is active on the GPIO the reported frequency
will be that set by \fBhardware_PWM\fP.

.br

.br
Returns the frequency (in hertz) used for the GPIO if OK,
otherwise PI_BAD_USER_GPIO.

.IP "\fBint set_servo_pulsewidth(int pi, unsigned user_gpio, unsigned pulsewidth)\fP"
.IP "" 4
Start (500-2500) or stop (0) servo pulses on the GPIO.

.br

.br

.EX
        pi: >=0 (as returned by \fBpigpio_start\fP).
.br
 user_gpio: 0-31.
.br
pulsewidth: 0 (off), 500 (anti-clockwise) - 2500 (clockwise).
.br

.EE

.br

.br
Returns 0 if OK, otherwise PI_BAD_USER_GPIO, PI_BAD_PULSEWIDTH or
PI_NOT_PERMITTED.

.br

.br
The selected pulsewidth will continue to be transmitted until
changed by a subsequent call to set_servo_pulsewidth.

.br

.br
The pulsewidths supported by servos varies and should probably be
determined by experiment. A value of 1500 should always be safe and
represents the mid-point of rotation.

.br

.br
You can DAMAGE a servo if you command it to move beyond its limits.

.br

.br
OTHER UPDATE RATES:

.br

.br
This function updates servos at 50Hz.  If you wish to use a different
update frequency you will have to use the PWM functions.

.br

.br

.EX
Update Rate (Hz)     50   100  200  400  500
.br
1E6/Hz            20000 10000 5000 2500 2000
.br

.EE

.br

.br
Firstly set the desired PWM frequency using \fBset_PWM_frequency\fP.

.br

.br
Then set the PWM range using \fBset_PWM_range\fP to 1E6/Hz.
Doing this allows you to use units of microseconds when setting
the servo pulsewidth.

.br

.br
E.g. If you want to update a servo connected to GPIO 25 at 400Hz

.br

.br

.EX
set_PWM_frequency(25, 400);
.br
set_PWM_range(25, 2500);
.br

.EE

.br

.br
Thereafter use the \fBset_PWM_dutycycle\fP function to move the servo,
e.g. set_PWM_dutycycle(25, 1500) will set a 1500 us pulse.
.br

.IP "\fBint get_servo_pulsewidth(int pi, unsigned user_gpio)\fP"
.IP "" 4
Return the servo pulsewidth in use on a GPIO.

.br

.br

.EX
       pi: >=0 (as returned by \fBpigpio_start\fP).
.br
user_gpio: 0-31.
.br

.EE

.br

.br
Returns 0 if OK, otherwise PI_BAD_USER_GPIO or PI_NOT_SERVO_GPIO.

.IP "\fBint notify_open(int pi)\fP"
.IP "" 4
Get a free notification handle.

.br

.br

.EX
pi: >=0 (as returned by \fBpigpio_start\fP).
.br

.EE

.br

.br
Returns a handle greater than or equal to zero if OK,
otherwise PI_NO_HANDLE.

.br

.br
A notification is a method for being notified of GPIO state
changes via a pipe.

.br

.br
Pipes are only accessible from the local machine so this function
serves no purpose if you are using the library from a remote machine.
The in-built (socket) notifications provided by \fBcallback\fP
should be used instead.

.br

.br
Notifications for handle x will be available at the pipe
named /dev/pigpiox (where x is the handle number).
E.g. if the function returns 15 then the notifications must be
read from /dev/pigpio15.

.IP "\fBint notify_begin(int pi, unsigned handle, uint32_t bits)\fP"
.IP "" 4
Start notifications on a previously opened handle.

.br

.br

.EX
    pi: >=0 (as returned by \fBpigpio_start\fP).
.br
handle: 0-31 (as returned by \fBnotify_open\fP)
.br
  bits: a mask indicating the GPIO to be notified.
.br

.EE

.br

.br
Returns 0 if OK, otherwise PI_BAD_HANDLE.

.br

.br
The notification sends state changes for each GPIO whose
corresponding bit in bits is set.

.br

.br
Each notification occupies 12 bytes in the fifo as follows:

.br

.br

.EX
typedef struct
.br
{
.br
   uint16_t seqno;
.br
   uint16_t flags;
.br
   uint32_t tick;
.br
   uint32_t level;
.br
} gpioReport_t;
.br

.EE

.br

.br
seqno: starts at 0 each time the handle is opened and then increments
by one for each report.

.br

.br
flags: three flags are defined, PI_NTFY_FLAGS_WDOG,
PI_NTFY_FLAGS_ALIVE, and PI_NTFY_FLAGS_EVENT.

.br

.br
If bit 5 is set (PI_NTFY_FLAGS_WDOG) then bits 0-4 of the flags
indicate a GPIO which has had a watchdog timeout.

.br

.br
If bit 6 is set (PI_NTFY_FLAGS_ALIVE) this indicates a keep alive
signal on the pipe/socket and is sent once a minute in the absence
of other notification activity.

.br

.br
If bit 7 is set (PI_NTFY_FLAGS_EVENT) then bits 0-4 of the flags
indicate an event which has been triggered.

.br

.br
tick: the number of microseconds since system boot.  It wraps around
after 1h12m.

.br

.br
level: indicates the level of each GPIO.  If bit 1<<x is set then
GPIO x is high.

.IP "\fBint notify_pause(int pi, unsigned handle)\fP"
.IP "" 4
Pause notifications on a previously opened handle.

.br

.br

.EX
    pi: >=0 (as returned by \fBpigpio_start\fP).
.br
handle: 0-31 (as returned by \fBnotify_open\fP)
.br

.EE

.br

.br
Returns 0 if OK, otherwise PI_BAD_HANDLE.

.br

.br
Notifications for the handle are suspended until
\fBnotify_begin\fP is called again.

.IP "\fBint notify_close(int pi, unsigned handle)\fP"
.IP "" 4
Stop notifications on a previously opened handle and
release the handle for reuse.

.br

.br

.EX
    pi: >=0 (as returned by \fBpigpio_start\fP).
.br
handle: 0-31 (as returned by \fBnotify_open\fP)
.br

.EE

.br

.br
Returns 0 if OK, otherwise PI_BAD_HANDLE.

.IP "\fBint set_watchdog(int pi, unsigned user_gpio, unsigned timeout)\fP"
.IP "" 4
Sets a watchdog for a GPIO.

.br

.br

.EX
       pi: >=0 (as returned by \fBpigpio_start\fP).
.br
user_gpio: 0-31.
.br
  timeout: 0-60000.
.br

.EE

.br

.br
Returns 0 if OK, otherwise PI_BAD_USER_GPIO
or PI_BAD_WDOG_TIMEOUT.

.br

.br
The watchdog is nominally in milliseconds.

.br

.br
Only one watchdog may be registered per GPIO.

.br

.br
The watchdog may be cancelled by setting timeout to 0.

.br

.br
Once a watchdog has been started callbacks for the GPIO will be
triggered every timeout interval after the last GPIO activity.

.br

.br
The callback will receive the special level PI_TIMEOUT.

.IP "\fBint set_glitch_filter(int pi, unsigned user_gpio, unsigned steady)\fP"
.IP "" 4
Sets a glitch filter on a GPIO.

.br

.br
Level changes on the GPIO are not reported unless the level
has been stable for at least \fBsteady\fP microseconds.  The
level is then reported.  Level changes of less than
\fBsteady\fP microseconds are ignored.

.br

.br

.EX
       pi: >=0 (as returned by \fBpigpio_start\fP).
.br
user_gpio: 0-31
.br
   steady: 0-300000
.br

.EE

.br

.br
Returns 0 if OK, otherwise PI_BAD_USER_GPIO, or PI_BAD_FILTER.

.br

.br
This filter affects the GPIO samples returned to callbacks set up
with \fBcallback\fP, \fBcallback_ex\fP and \fBwait_for_edge\fP.

.br

.br
It does not affect levels read by \fBgpio_read\fP,
\fBread_bank_1\fP, or \fBread_bank_2\fP.

.br

.br
Each (stable) edge will be timestamped \fBsteady\fP microseconds
after it was first detected.

.IP "\fBint set_noise_filter(int pi, unsigned user_gpio, unsigned steady, unsigned active)\fP"
.IP "" 4
Sets a noise filter on a GPIO.

.br

.br
Level changes on the GPIO are ignored until a level which has
been stable for \fBsteady\fP microseconds is detected.  Level changes
on the GPIO are then reported for \fBactive\fP microseconds after
which the process repeats.

.br

.br

.EX
       pi: >=0 (as returned by \fBpigpio_start\fP).
.br
user_gpio: 0-31
.br
   steady: 0-300000
.br
   active: 0-1000000
.br

.EE

.br

.br
Returns 0 if OK, otherwise PI_BAD_USER_GPIO, or PI_BAD_FILTER.

.br

.br
This filter affects the GPIO samples returned to callbacks set up
with \fBcallback\fP, \fBcallback_ex\fP and \fBwait_for_edge\fP.

.br

.br
It does not affect levels read by \fBgpio_read\fP,
\fBread_bank_1\fP, or \fBread_bank_2\fP.

.br

.br
Level changes before and after the active period may
be reported.  Your software must be designed to cope with
such reports.

.IP "\fBuint32_t read_bank_1(int pi)\fP"
.IP "" 4
Read the levels of the bank 1 GPIO (GPIO 0-31).

.br

.br

.EX
pi: >=0 (as returned by \fBpigpio_start\fP).
.br

.EE

.br

.br
The returned 32 bit integer has a bit set if the corresponding
GPIO is logic 1.  GPIO n has bit value (1<<n).

.IP "\fBuint32_t read_bank_2(int pi)\fP"
.IP "" 4
Read the levels of the bank 2 GPIO (GPIO 32-53).

.br

.br

.EX
pi: >=0 (as returned by \fBpigpio_start\fP).
.br

.EE

.br

.br
The returned 32 bit integer has a bit set if the corresponding
GPIO is logic 1.  GPIO n has bit value (1<<(n-32)).

.IP "\fBint clear_bank_1(int pi, uint32_t bits)\fP"
.IP "" 4
Clears GPIO 0-31 if the corresponding bit in bits is set.

.br

.br

.EX
  pi: >=0 (as returned by \fBpigpio_start\fP).
.br
bits: a bit mask with 1 set if the corresponding GPIO is
.br
      to be cleared.
.br

.EE

.br

.br
Returns 0 if OK, otherwise PI_SOME_PERMITTED.

.br

.br
A status of PI_SOME_PERMITTED indicates that the user is not
allowed to write to one or more of the GPIO.

.IP "\fBint clear_bank_2(int pi, uint32_t bits)\fP"
.IP "" 4
Clears GPIO 32-53 if the corresponding bit (0-21) in bits is set.

.br

.br

.EX
  pi: >=0 (as returned by \fBpigpio_start\fP).
.br
bits: a bit mask with 1 set if the corresponding GPIO is
.br
      to be cleared.
.br

.EE

.br

.br
Returns 0 if OK, otherwise PI_SOME_PERMITTED.

.br

.br
A status of PI_SOME_PERMITTED indicates that the user is not
allowed to write to one or more of the GPIO.

.IP "\fBint set_bank_1(int pi, uint32_t bits)\fP"
.IP "" 4
Sets GPIO 0-31 if the corresponding bit in bits is set.

.br

.br

.EX
  pi: >=0 (as returned by \fBpigpio_start\fP).
.br
bits: a bit mask with 1 set if the corresponding GPIO is
.br
      to be set.
.br

.EE

.br

.br
Returns 0 if OK, otherwise PI_SOME_PERMITTED.

.br

.br
A status of PI_SOME_PERMITTED indicates that the user is not
allowed to write to one or more of the GPIO.

.IP "\fBint set_bank_2(int pi, uint32_t bits)\fP"
.IP "" 4
Sets GPIO 32-53 if the corresponding bit (0-21) in bits is set.

.br

.br

.EX
  pi: >=0 (as returned by \fBpigpio_start\fP).
.br
bits: a bit mask with 1 set if the corresponding GPIO is
.br
      to be set.
.br

.EE

.br

.br
Returns 0 if OK, otherwise PI_SOME_PERMITTED.

.br

.br
A status of PI_SOME_PERMITTED indicates that the user is not
allowed to write to one or more of the GPIO.

.IP "\fBint hardware_clock(int pi, unsigned gpio, unsigned clkfreq)\fP"
.IP "" 4
Starts a hardware clock on a GPIO at the specified frequency.
Frequencies above 30MHz are unlikely to work.

.br

.br

.EX
       pi: >=0 (as returned by \fBpigpio_start\fP).
.br
     gpio: see description
.br
frequency: 0 (off) or 4689-250M (13184-375M for the BCM2711)
.br

.EE

.br

.br
Returns 0 if OK, otherwise PI_NOT_PERMITTED, PI_BAD_GPIO,
PI_NOT_HCLK_GPIO, PI_BAD_HCLK_FREQ,or PI_BAD_HCLK_PASS.

.br

.br
The same clock is available on multiple GPIO.  The latest
frequency setting will be used by all GPIO which share a clock.

.br

.br
The GPIO must be one of the following.

.br

.br

.EX
4   clock 0  All models
.br
5   clock 1  All models but A and B (reserved for system use)
.br
6   clock 2  All models but A and B
.br
20  clock 0  All models but A and B
.br
21  clock 1  All models but A and Rev.2 B (reserved for system use)
.br

.br
32  clock 0  Compute module only
.br
34  clock 0  Compute module only
.br
42  clock 1  Compute module only (reserved for system use)
.br
43  clock 2  Compute module only
.br
44  clock 1  Compute module only (reserved for system use)
.br

.EE

.br

.br
Access to clock 1 is protected by a password as its use will likely
crash the Pi.  The password is given by or'ing 0x5A000000 with the
GPIO number.

.IP "\fBint hardware_PWM(int pi, unsigned gpio, unsigned PWMfreq, uint32_t PWMduty)\fP"
.IP "" 4
Starts hardware PWM on a GPIO at the specified frequency and dutycycle.
Frequencies above 30MHz are unlikely to work.

.br

.br
NOTE: Any waveform started by \fBwave_send_*\fP or \fBwave_chain\fP
will be cancelled.

.br

.br
This function is only valid if the pigpio main clock is PCM.  The
main clock defaults to PCM but may be overridden when the pigpio
daemon is started (option -t).

.br

.br

.EX
     pi: >=0 (as returned by \fBpigpio_start\fP).
.br
   gpio: see descripton
.br
PWMfreq: 0 (off) or 1-125M (1-187.5M for the BCM2711)
.br
PWMduty: 0 (off) to 1000000 (1M)(fully on)
.br

.EE

.br

.br
Returns 0 if OK, otherwise PI_NOT_PERMITTED, PI_BAD_GPIO,
PI_NOT_HPWM_GPIO, PI_BAD_HPWM_DUTY, PI_BAD_HPWM_FREQ,
or PI_HPWM_ILLEGAL.

.br

.br
The same PWM channel is available on multiple GPIO.  The latest
frequency and dutycycle setting will be used by all GPIO which
share a PWM channel.

.br

.br
The GPIO must be one of the following.

.br

.br

.EX
12  PWM channel 0  All models but A and B
.br
13  PWM channel 1  All models but A and B
.br
18  PWM channel 0  All models
.br
19  PWM channel 1  All models but A and B
.br

.br
40  PWM channel 0  Compute module only
.br
41  PWM channel 1  Compute module only
.br
45  PWM channel 1  Compute module only
.br
52  PWM channel 0  Compute module only
.br
53  PWM channel 1  Compute module only
.br

.EE

.br

.br
The actual number of steps beween off and fully on is the
integral part of 250M/PWMfreq (375M/PWMfreq for the BCM2711).

.br

.br
The actual frequency set is 250M/steps (375M/steps for the BCM2711).

.br

.br
There will only be a million steps for a PWMfreq of 250 (375 for
the BCM2711). Lower frequencies will have more steps and higher
frequencies will have fewer steps.  PWMduty is
automatically scaled to take this into account.

.IP "\fBuint32_t get_current_tick(int pi)\fP"
.IP "" 4
Gets the current system tick.

.br

.br

.EX
pi: >=0 (as returned by \fBpigpio_start\fP).
.br

.EE

.br

.br
Tick is the number of microseconds since system boot.

.br

.br
As tick is an unsigned 32 bit quantity it wraps around after
2**32 microseconds, which is approximately 1 hour 12 minutes.

.br

.br

.IP "\fBuint32_t get_hardware_revision(int pi)\fP"
.IP "" 4
Get the Pi's hardware revision number.

.br

.br

.EX
pi: >=0 (as returned by \fBpigpio_start\fP).
.br

.EE

.br

.br
The hardware revision is the last few characters on the Revision line
of /proc/cpuinfo.

.br

.br
If the hardware revision can not be found or is not a valid
hexadecimal number the function returns 0.

.br

.br
The revision number can be used to determine the assignment of GPIO
to pins (see \fBgpio\fP).

.br

.br
There are at least three types of board.

.br

.br
Type 1 boards have hardware revision numbers of 2 and 3.

.br

.br
Type 2 boards have hardware revision numbers of 4, 5, 6, and 15.

.br

.br
Type 3 boards have hardware revision numbers of 16 or greater.

.IP "\fBuint32_t get_pigpio_version(int pi)\fP"
.IP "" 4
Returns the pigpio version.

.br

.br

.EX
pi: >=0 (as returned by \fBpigpio_start\fP).
.br

.EE

.IP "\fBint wave_clear(int pi)\fP"
.IP "" 4
This function clears all waveforms and any data added by calls to the
\fBwave_add_*\fP functions.

.br

.br

.EX
pi: >=0 (as returned by \fBpigpio_start\fP).
.br

.EE

.br

.br
Returns 0 if OK.

.IP "\fBint wave_add_new(int pi)\fP"
.IP "" 4
This function starts a new empty waveform.  You wouldn't normally need
to call this function as it is automatically called after a waveform is
created with the \fBwave_create\fP function.

.br

.br

.EX
pi: >=0 (as returned by \fBpigpio_start\fP).
.br

.EE

.br

.br
Returns 0 if OK.

.IP "\fBint wave_add_generic(int pi, unsigned numPulses, gpioPulse_t *pulses)\fP"
.IP "" 4
This function adds a number of pulses to the current waveform.

.br

.br

.EX
       pi: >=0 (as returned by \fBpigpio_start\fP).
.br
numPulses: the number of pulses.
.br
   pulses: an array of pulses.
.br

.EE

.br

.br
Returns the new total number of pulses in the current waveform if OK,
otherwise PI_TOO_MANY_PULSES.

.br

.br
The pulses are interleaved in time order within the existing waveform
(if any).

.br

.br
Merging allows the waveform to be built in parts, that is the settings
for GPIO#1 can be added, and then GPIO#2 etc.

.br

.br
If the added waveform is intended to start after or within the existing
waveform then the first pulse should consist solely of a delay.

.IP "\fBint wave_add_serial(int pi, unsigned user_gpio, unsigned baud, unsigned data_bits, unsigned stop_bits, unsigned offset, unsigned numBytes, char *str)\fP"
.IP "" 4
This function adds a waveform representing serial data to the
existing waveform (if any).  The serial data starts offset
microseconds from the start of the waveform.

.br

.br

.EX
       pi: >=0 (as returned by \fBpigpio_start\fP).
.br
user_gpio: 0-31.
.br
     baud: 50-1000000
.br
data_bits: number of data bits (1-32)
.br
stop_bits: number of stop half bits (2-8)
.br
   offset: >=0
.br
 numBytes: >=1
.br
      str: an array of chars.
.br

.EE

.br

.br
Returns the new total number of pulses in the current waveform if OK,
otherwise PI_BAD_USER_GPIO, PI_BAD_WAVE_BAUD, PI_BAD_DATABITS,
PI_BAD_STOP_BITS, PI_TOO_MANY_CHARS, PI_BAD_SER_OFFSET,
or PI_TOO_MANY_PULSES.

.br

.br
NOTES:

.br

.br
The serial data is formatted as one start bit, \fBdata_bits\fP data bits,
and \fBstop_bits\fP/2 stop bits.

.br

.br
It is legal to add serial data streams with different baud rates to
the same waveform.

.br

.br
\fBnumBytes\fP is the number of bytes of data in str.

.br

.br
The bytes required for each character depend upon \fBdata_bits\fP.

.br

.br
For \fBdata_bits\fP 1-8 there will be one byte per character.
.br
For \fBdata_bits\fP 9-16 there will be two bytes per character.
.br
For \fBdata_bits\fP 17-32 there will be four bytes per character.

.IP "\fBint wave_create(int pi)\fP"
.IP "" 4
This function creates a waveform from the data provided by the prior
calls to the \fBwave_add_*\fP functions.  Upon success a wave id
greater than or equal to 0 is returned, otherwise PI_EMPTY_WAVEFORM,
PI_TOO_MANY_CBS, PI_TOO_MANY_OOL, or PI_NO_WAVEFORM_ID.

.br

.br

.EX
pi: >=0 (as returned by \fBpigpio_start\fP).
.br

.EE

.br

.br
The data provided by the \fBwave_add_*\fP functions is consumed by this
function.

.br

.br
As many waveforms may be created as there is space available.  The
wave id is passed to \fBwave_send_*\fP to specify the waveform to transmit.

.br

.br
Normal usage would be

.br

.br
Step 1. \fBwave_clear\fP to clear all waveforms and added data.

.br

.br
Step 2. \fBwave_add_*\fP calls to supply the waveform data.

.br

.br
Step 3. \fBwave_create\fP to create the waveform and get a unique id

.br

.br
Repeat steps 2 and 3 as needed.

.br

.br
Step 4. \fBwave_send_*\fP with the id of the waveform to transmit.

.br

.br
A waveform comprises one or more pulses.  Each pulse consists of a
\fBgpioPulse_t\fP structure.

.br

.br

.EX
typedef struct
.br
{
.br
   uint32_t gpioOn;
.br
   uint32_t gpioOff;
.br
   uint32_t usDelay;
.br
} gpioPulse_t;
.br

.EE

.br

.br
The fields specify

.br

.br
1) the GPIO to be switched on at the start of the pulse.
.br
2) the GPIO to be switched off at the start of the pulse.
.br
3) the delay in microseconds before the next pulse.
.br

.br

.br
Any or all the fields can be zero.  It doesn't make any sense to
set all the fields to zero (the pulse will be ignored).

.br

.br
When a waveform is started each pulse is executed in order with the
specified delay between the pulse and the next.

.br

.br
Returns the new waveform id if OK, otherwise PI_EMPTY_WAVEFORM,
PI_NO_WAVEFORM_ID, PI_TOO_MANY_CBS, or PI_TOO_MANY_OOL.

.IP "\fBint wave_create_and_pad(int pi, int percent)\fP"
.IP "" 4
This function creates a waveform like \fBwave_create\fP but pads the consumed
resources. Where percent gives the percentage of the resources to use (in terms
of the theoretical maximum, not the current amount free). This allows the reuse
.br
of deleted waves while a transmission is active.

.br

.br

.EX
pi: >=0 (as returned by \fBpigpio_start\fP).
.br
percent: 0-100, size of waveform as percentage of maximum available.
.br

.EE

.br

.br
The data provided by the \fBwave_add_*\fP functions are consumed by this
function.

.br

.br
As many waveforms may be created as there is space available. The
wave id is passed to \fBwave_send_*\fP to specify the waveform to transmit.

.br

.br
A usage would be the creation of two waves where one is filled while the other
is being transmitted. Each wave is assigned 50% of the resources.
This buffer structure allows the transmission of infinite wave sequences.

.br

.br
Normal usage:

.br

.br
Step 1. \fBwave_clear\fP to clear all waveforms and added data.

.br

.br
Step 2. \fBwave_add_*\fP calls to supply the waveform data.

.br

.br
Step 3. \fBwave_create_and_pad\fP to create a waveform of uniform size.

.br

.br
Step 4. \fBwave_send_*\fP with the id of the waveform to transmit.

.br

.br
Repeat steps 2-4 as needed.

.br

.br
Step 5. Any wave id can now be deleted and another wave of the same size
        can be created in its place.

.br

.br
Returns the new waveform id if OK, otherwise PI_EMPTY_WAVEFORM,
PI_NO_WAVEFORM_ID, PI_TOO_MANY_CBS, or PI_TOO_MANY_OOL.

.IP "\fBint wave_delete(int pi, unsigned wave_id)\fP"
.IP "" 4
This function deletes the waveform with id wave_id.

.br

.br

.EX
     pi: >=0 (as returned by \fBpigpio_start\fP).
.br
wave_id: >=0, as returned by \fBwave_create\fP.
.br

.EE

.br

.br
Wave ids are allocated in order, 0, 1, 2, etc.

.br

.br
The wave is flagged for deletion.  The resources used by the wave
will only be reused when either of the following apply.

.br

.br
- all waves with higher numbered wave ids have been deleted or have
been flagged for deletion.

.br

.br
- a new wave is created which uses exactly the same resources as
the current wave (see the C source for gpioWaveCreate for details).

.br

.br
Returns 0 if OK, otherwise PI_BAD_WAVE_ID.

.IP "\fBint wave_send_once(int pi, unsigned wave_id)\fP"
.IP "" 4
This function transmits the waveform with id wave_id.  The waveform
is sent once.

.br

.br
NOTE: Any hardware PWM started by \fBhardware_PWM\fP will be cancelled.

.br

.br

.EX
     pi: >=0 (as returned by \fBpigpio_start\fP).
.br
wave_id: >=0, as returned by \fBwave_create\fP.
.br

.EE

.br

.br
Returns the number of DMA control blocks in the waveform if OK,
otherwise PI_BAD_WAVE_ID, or PI_BAD_WAVE_MODE.

.IP "\fBint wave_send_repeat(int pi, unsigned wave_id)\fP"
.IP "" 4
This function transmits the waveform with id wave_id.  The waveform
cycles until cancelled (either by the sending of a new waveform or
by \fBwave_tx_stop\fP).

.br

.br
NOTE: Any hardware PWM started by \fBhardware_PWM\fP will be cancelled.

.br

.br

.EX
     pi: >=0 (as returned by \fBpigpio_start\fP).
.br
wave_id: >=0, as returned by \fBwave_create\fP.
.br

.EE

.br

.br
Returns the number of DMA control blocks in the waveform if OK,
otherwise PI_BAD_WAVE_ID, or PI_BAD_WAVE_MODE.

.IP "\fBint wave_send_using_mode(int pi, unsigned wave_id, unsigned mode)\fP"
.IP "" 4
Transmits the waveform with id wave_id using mode mode.

.br

.br

.EX
     pi: >=0 (as returned by \fBpigpio_start\fP).
.br
wave_id: >=0, as returned by \fBwave_create\fP.
.br
   mode: PI_WAVE_MODE_ONE_SHOT, PI_WAVE_MODE_REPEAT,
.br
         PI_WAVE_MODE_ONE_SHOT_SYNC, or PI_WAVE_MODE_REPEAT_SYNC.
.br

.EE

.br

.br
PI_WAVE_MODE_ONE_SHOT: same as \fBwave_send_once\fP.

.br

.br
PI_WAVE_MODE_REPEAT same as \fBwave_send_repeat\fP.

.br

.br
PI_WAVE_MODE_ONE_SHOT_SYNC same as \fBwave_send_once\fP but tries
to sync with the previous waveform.

.br

.br
PI_WAVE_MODE_REPEAT_SYNC same as \fBwave_send_repeat\fP but tries
to sync with the previous waveform.

.br

.br
WARNING: bad things may happen if you delete the previous
waveform before it has been synced to the new waveform.

.br

.br
NOTE: Any hardware PWM started by \fBhardware_PWM\fP will be cancelled.

.br

.br
Returns the number of DMA control blocks in the waveform if OK,
otherwise PI_BAD_WAVE_ID, or PI_BAD_WAVE_MODE.

.IP "\fBint wave_chain(int pi, char *buf, unsigned bufSize)\fP"
.IP "" 4
This function transmits a chain of waveforms.

.br

.br
NOTE: Any hardware PWM started by \fBhardware_PWM\fP will be cancelled.

.br

.br
The waves to be transmitted are specified by the contents of buf
which contains an ordered list of \fBwave_id\fPs and optional command
codes and related data.

.br

.br

.EX
     pi: >=0 (as returned by \fBpigpio_start\fP).
.br
    buf: pointer to the wave_ids and optional command codes
.br
bufSize: the number of bytes in buf
.br

.EE

.br

.br
Returns 0 if OK, otherwise PI_CHAIN_NESTING, PI_CHAIN_LOOP_CNT, PI_BAD_CHAIN_LOOP, PI_BAD_CHAIN_CMD, PI_CHAIN_COUNTER,
PI_BAD_CHAIN_DELAY, PI_CHAIN_TOO_BIG, or PI_BAD_WAVE_ID.

.br

.br
Each wave is transmitted in the order specified.  A wave may
occur multiple times per chain.

.br

.br
A blocks of waves may be transmitted multiple times by using
the loop commands. The block is bracketed by loop start and
end commands.  Loops may be nested.

.br

.br
Delays between waves may be added with the delay command.

.br

.br
The following command codes are supported:

.br

.br
Name           Cmd & Data   Meaning
.br
Loop Start     255 0        Identify start of a wave block
.br
Loop Repeat    255 1 x y    loop x + y*256 times
.br
Delay          255 2 x y    delay x + y*256 microseconds
.br
Loop Forever   255 3        loop forever
.br

.br

.br
If present Loop Forever must be the last entry in the chain.

.br

.br
The code is currently dimensioned to support a chain with roughly
600 entries and 20 loop counters.

.br

.br
\fBExample\fP
.br

.EX
#include <stdio.h>
.br
#include <pigpiod_if2.h>
.br

.br
#define WAVES 5
.br
#define GPIO 4
.br

.br
int main(int argc, char *argv[])
.br
{
.br
   int i, pi, wid[WAVES];
.br

.br
   pi = pigpio_start(0, 0);
.br
   if (pi<0) return -1;
.br

.br
   set_mode(pi, GPIO, PI_OUTPUT);
.br

.br
   for (i=0; i<WAVES; i++)
.br
   {
.br
      wave_add_generic(pi, 2, (gpioPulse_t[])
.br
         {{1<<GPIO, 0,        20},
.br
          {0, 1<<GPIO, (i+1)*200}});
.br

.br
      wid[i] = wave_create(pi);
.br
   }
.br

.br
   wave_chain(pi, (char []) {
.br
      wid[4], wid[3], wid[2],       // transmit waves 4+3+2
.br
      255, 0,                       // loop start
.br
         wid[0], wid[0], wid[0],    // transmit waves 0+0+0
.br
         255, 0,                    // loop start
.br
            wid[0], wid[1],         // transmit waves 0+1
.br
            255, 2, 0x88, 0x13,     // delay 5000us
.br
         255, 1, 30, 0,             // loop end (repeat 30 times)
.br
         255, 0,                    // loop start
.br
            wid[2], wid[3], wid[0], // transmit waves 2+3+0
.br
            wid[3], wid[1], wid[2], // transmit waves 3+1+2
.br
         255, 1, 10, 0,             // loop end (repeat 10 times)
.br
      255, 1, 5, 0,                 // loop end (repeat 5 times)
.br
      wid[4], wid[4], wid[4],       // transmit waves 4+4+4
.br
      255, 2, 0x20, 0x4E,           // delay 20000us
.br
      wid[0], wid[0], wid[0],       // transmit waves 0+0+0
.br

.br
      }, 46);
.br

.br
   while (wave_tx_busy(pi)) time_sleep(0.1);
.br

.br
   for (i=0; i<WAVES; i++) wave_delete(pi, wid[i]);
.br

.br
   pigpio_stop(pi);
.br
}
.br

.EE

.IP "\fBint wave_tx_at(int pi)\fP"
.IP "" 4
This function returns the id of the waveform currently being
transmitted by \fBwave_send*\fP.  Chained waves are not supported.

.br

.br

.EX
pi: >=0 (as returned by \fBpigpio_start\fP).
.br

.EE

.br

.br
Returns the waveform id or one of the following special values:

.br

.br
PI_WAVE_NOT_FOUND (9998) - transmitted wave not found.
.br
PI_NO_TX_WAVE (9999) - no wave being transmitted.

.IP "\fBint wave_tx_busy(int pi)\fP"
.IP "" 4
This function checks to see if a waveform is currently being
transmitted.

.br

.br

.EX
pi: >=0 (as returned by \fBpigpio_start\fP).
.br

.EE

.br

.br
Returns 1 if a waveform is currently being transmitted, otherwise 0.

.IP "\fBint wave_tx_stop(int pi)\fP"
.IP "" 4
This function stops the transmission of the current waveform.

.br

.br

.EX
pi: >=0 (as returned by \fBpigpio_start\fP).
.br

.EE

.br

.br
Returns 0 if OK.

.br

.br
This function is intended to stop a waveform started with the repeat mode.

.IP "\fBint wave_get_micros(int pi)\fP"
.IP "" 4
This function returns the length in microseconds of the current
waveform.

.br

.br

.EX
pi: >=0 (as returned by \fBpigpio_start\fP).
.br

.EE

.IP "\fBint wave_get_high_micros(int pi)\fP"
.IP "" 4
This function returns the length in microseconds of the longest waveform
created since the pigpio daemon was started.

.br

.br

.EX
pi: >=0 (as returned by \fBpigpio_start\fP).
.br

.EE

.IP "\fBint wave_get_max_micros(int pi)\fP"
.IP "" 4
This function returns the maximum possible size of a waveform in
.br
microseconds.

.br

.br

.EX
pi: >=0 (as returned by \fBpigpio_start\fP).
.br

.EE

.IP "\fBint wave_get_pulses(int pi)\fP"
.IP "" 4
This function returns the length in pulses of the current waveform.

.br

.br

.EX
pi: >=0 (as returned by \fBpigpio_start\fP).
.br

.EE

.IP "\fBint wave_get_high_pulses(int pi)\fP"
.IP "" 4
This function returns the length in pulses of the longest waveform
created since the pigpio daemon was started.

.br

.br

.EX
pi: >=0 (as returned by \fBpigpio_start\fP).
.br

.EE

.IP "\fBint wave_get_max_pulses(int pi)\fP"
.IP "" 4
This function returns the maximum possible size of a waveform in pulses.

.br

.br

.EX
pi: >=0 (as returned by \fBpigpio_start\fP).
.br

.EE

.IP "\fBint wave_get_cbs(int pi)\fP"
.IP "" 4
This function returns the length in DMA control blocks of the current
waveform.

.br

.br

.EX
pi: >=0 (as returned by \fBpigpio_start\fP).
.br

.EE

.IP "\fBint wave_get_high_cbs(int pi)\fP"
.IP "" 4
This function returns the length in DMA control blocks of the longest
waveform created since the pigpio daemon was started.

.br

.br

.EX
pi: >=0 (as returned by \fBpigpio_start\fP).
.br

.EE

.IP "\fBint wave_get_max_cbs(int pi)\fP"
.IP "" 4
This function returns the maximum possible size of a waveform in DMA
control blocks.

.br

.br

.EX
pi: >=0 (as returned by \fBpigpio_start\fP).
.br

.EE

.IP "\fBint gpio_trigger(int pi, unsigned user_gpio, unsigned pulseLen, unsigned level)\fP"
.IP "" 4
This function sends a trigger pulse to a GPIO.  The GPIO is set to
level for pulseLen microseconds and then reset to not level.

.br

.br

.EX
       pi: >=0 (as returned by \fBpigpio_start\fP).
.br
user_gpio: 0-31.
.br
 pulseLen: 1-100.
.br
    level: 0,1.
.br

.EE

.br

.br
Returns 0 if OK, otherwise PI_BAD_USER_GPIO, PI_BAD_LEVEL,
PI_BAD_PULSELEN, or PI_NOT_PERMITTED.

.IP "\fBint store_script(int pi, char *script)\fP"
.IP "" 4
This function stores a script for later execution.

.br

.br
See \fBhttp://abyz.me.uk/rpi/pigpio/pigs.html#Scripts\fP for details.

.br

.br

.EX
    pi: >=0 (as returned by \fBpigpio_start\fP).
.br
script: the text of the script.
.br

.EE

.br

.br
The function returns a script id if the script is valid,
otherwise PI_BAD_SCRIPT.

.IP "\fBint run_script(int pi, unsigned script_id, unsigned numPar, uint32_t *param)\fP"
.IP "" 4
This function runs a stored script.

.br

.br

.EX
       pi: >=0 (as returned by \fBpigpio_start\fP).
.br
script_id: >=0, as returned by \fBstore_script\fP.
.br
   numPar: 0-10, the number of parameters.
.br
    param: an array of parameters.
.br

.EE

.br

.br
The function returns 0 if OK, otherwise PI_BAD_SCRIPT_ID, or
PI_TOO_MANY_PARAM

.br

.br
param is an array of up to 10 parameters which may be referenced in
the script as p0 to p9.

.IP "\fBint update_script(int pi, unsigned script_id, unsigned numPar, uint32_t *param)\fP"
.IP "" 4
This function sets the parameters of a script.  The script may or
may not be running.  The first numPar parameters of the script are
overwritten with the new values.

.br

.br

.EX
       pi: >=0 (as returned by \fBpigpio_start\fP).
.br
script_id: >=0, as returned by \fBstore_script\fP.
.br
   numPar: 0-10, the number of parameters.
.br
    param: an array of parameters.
.br

.EE

.br

.br
The function returns 0 if OK, otherwise PI_BAD_SCRIPT_ID, or
PI_TOO_MANY_PARAM.

.br

.br
param is an array of up to 10 parameters which may be referenced in
the script as p0 to p9.

.IP "\fBint script_status(int pi, unsigned script_id, uint32_t *param)\fP"
.IP "" 4
This function returns the run status of a stored script as well
as the current values of parameters 0 to 9.

.br

.br

.EX
       pi: >=0 (as returned by \fBpigpio_start\fP).
.br
script_id: >=0, as returned by \fBstore_script\fP.
.br
    param: an array to hold the returned 10 parameters.
.br

.EE

.br

.br
The function returns greater than or equal to 0 if OK,
otherwise PI_BAD_SCRIPT_ID.

.br

.br
The run status may be

.br

.br

.EX
PI_SCRIPT_INITING
.br
PI_SCRIPT_HALTED
.br
PI_SCRIPT_RUNNING
.br
PI_SCRIPT_WAITING
.br
PI_SCRIPT_FAILED
.br

.EE

.br

.br
The current value of script parameters 0 to 9 are returned in param.

.IP "\fBint stop_script(int pi, unsigned script_id)\fP"
.IP "" 4
This function stops a running script.

.br

.br

.EX
       pi: >=0 (as returned by \fBpigpio_start\fP).
.br
script_id: >=0, as returned by \fBstore_script\fP.
.br

.EE

.br

.br
The function returns 0 if OK, otherwise PI_BAD_SCRIPT_ID.

.IP "\fBint delete_script(int pi, unsigned script_id)\fP"
.IP "" 4
This function deletes a stored script.

.br

.br

.EX
       pi: >=0 (as returned by \fBpigpio_start\fP).
.br
script_id: >=0, as returned by \fBstore_script\fP.
.br

.EE

.br

.br
The function returns 0 if OK, otherwise PI_BAD_SCRIPT_ID.

.IP "\fBint bb_serial_read_open(int pi, unsigned user_gpio, unsigned baud, unsigned data_bits)\fP"
.IP "" 4
This function opens a GPIO for bit bang reading of serial data.

.br

.br

.EX
       pi: >=0 (as returned by \fBpigpio_start\fP).
.br
user_gpio: 0-31.
.br
     baud: 50-250000
.br
data_bits: 1-32
.br

.EE

.br

.br
Returns 0 if OK, otherwise PI_BAD_USER_GPIO, PI_BAD_WAVE_BAUD,
or PI_GPIO_IN_USE.

.br

.br
The serial data is returned in a cyclic buffer and is read using
bb_serial_read.

.br

.br
It is the caller's responsibility to read data from the cyclic buffer
in a timely fashion.

.IP "\fBint bb_serial_read(int pi, unsigned user_gpio, void *buf, size_t bufSize)\fP"
.IP "" 4
This function copies up to bufSize bytes of data read from the
bit bang serial cyclic buffer to the buffer starting at buf.

.br

.br

.EX
       pi: >=0 (as returned by \fBpigpio_start\fP).
.br
user_gpio: 0-31, previously opened with \fBbb_serial_read_open\fP.
.br
      buf: an array to receive the read bytes.
.br
  bufSize: >=0
.br

.EE

.br

.br
Returns the number of bytes copied if OK, otherwise PI_BAD_USER_GPIO
or PI_NOT_SERIAL_GPIO.

.br

.br
The bytes returned for each character depend upon the number of
data bits \fBdata_bits\fP specified in the \fBbb_serial_read_open\fP command.

.br

.br
For \fBdata_bits\fP 1-8 there will be one byte per character.
.br
For \fBdata_bits\fP 9-16 there will be two bytes per character.
.br
For \fBdata_bits\fP 17-32 there will be four bytes per character.

.IP "\fBint bb_serial_read_close(int pi, unsigned user_gpio)\fP"
.IP "" 4
This function closes a GPIO for bit bang reading of serial data.

.br

.br

.EX
       pi: >=0 (as returned by \fBpigpio_start\fP).
.br
user_gpio: 0-31, previously opened with \fBbb_serial_read_open\fP.
.br

.EE

.br

.br
Returns 0 if OK, otherwise PI_BAD_USER_GPIO, or PI_NOT_SERIAL_GPIO.

.IP "\fBint bb_serial_invert(int pi, unsigned user_gpio, unsigned invert)\fP"
.IP "" 4
This function inverts serial logic for big bang serial reads.

.br

.br

.EX
       pi: >=0 (as returned by \fBpigpio_start\fP).
.br
user_gpio: 0-31, previously opened with \fBbb_serial_read_open\fP.
.br
   invert: 0-1, 1 invert, 0 normal.
.br

.EE

.br

.br
Returns 0 if OK, otherwise PI_NOT_SERIAL_GPIO or PI_BAD_SER_INVERT.

.IP "\fBint i2c_open(int pi, unsigned i2c_bus, unsigned i2c_addr, unsigned i2c_flags)\fP"
.IP "" 4
This returns a handle for the device at address i2c_addr on bus i2c_bus.

.br

.br

.EX
       pi: >=0 (as returned by \fBpigpio_start\fP).
.br
  i2c_bus: >=0.
.br
 i2c_addr: 0-0x7F.
.br
i2c_flags: 0.
.br

.EE

.br

.br
No flags are currently defined.  This parameter should be set to zero.

.br

.br
Physically buses 0 and 1 are available on the Pi.  Higher numbered buses
will be available if a kernel supported bus multiplexor is being used.

.br

.br
The GPIO used are given in the following table.

.br

.br
        SDA   SCL
.br
I2C 0    0     1
.br
I2C 1    2     3
.br

.br

.br
Returns a handle (>=0) if OK, otherwise PI_BAD_I2C_BUS, PI_BAD_I2C_ADDR,
PI_BAD_FLAGS, PI_NO_HANDLE, or PI_I2C_OPEN_FAILED.

.br

.br
For the SMBus commands the low level transactions are shown at the end
of the function description.  The following abbreviations are used.

.br

.br

.EX
S       (1 bit) : Start bit
.br
P       (1 bit) : Stop bit
.br
Rd/Wr   (1 bit) : Read/Write bit. Rd equals 1, Wr equals 0.
.br
A, NA   (1 bit) : Accept and not accept bit.
.br
.br
.br
Addr    (7 bits): I2C 7 bit address.
.br
i2c_reg (8 bits): A byte which often selects a register.
.br
Data    (8 bits): A data byte.
.br
Count   (8 bits): A byte defining the length of a block operation.
.br

.br
[..]: Data sent by the device.
.br

.EE

.IP "\fBint i2c_close(int pi, unsigned handle)\fP"
.IP "" 4
This closes the I2C device associated with the handle.

.br

.br

.EX
    pi: >=0 (as returned by \fBpigpio_start\fP).
.br
handle: >=0, as returned by a call to \fBi2c_open\fP.
.br

.EE

.br

.br
Returns 0 if OK, otherwise PI_BAD_HANDLE.

.IP "\fBint i2c_write_quick(int pi, unsigned handle, unsigned bit)\fP"
.IP "" 4
This sends a single bit (in the Rd/Wr bit) to the device associated
with handle.

.br

.br

.EX
    pi: >=0 (as returned by \fBpigpio_start\fP).
.br
handle: >=0, as returned by a call to \fBi2c_open\fP.
.br
   bit: 0-1, the value to write.
.br

.EE

.br

.br
Returns 0 if OK, otherwise PI_BAD_HANDLE, PI_BAD_PARAM, or
PI_I2C_WRITE_FAILED.

.br

.br
Quick command. SMBus 2.0 5.5.1

.EX
S Addr bit [A] P
.br

.EE

.IP "\fBint i2c_write_byte(int pi, unsigned handle, unsigned bVal)\fP"
.IP "" 4
This sends a single byte to the device associated with handle.

.br

.br

.EX
    pi: >=0 (as returned by \fBpigpio_start\fP).
.br
handle: >=0, as returned by a call to \fBi2c_open\fP.
.br
  bVal: 0-0xFF, the value to write.
.br

.EE

.br

.br
Returns 0 if OK, otherwise PI_BAD_HANDLE, PI_BAD_PARAM, or
PI_I2C_WRITE_FAILED.

.br

.br
Send byte. SMBus 2.0 5.5.2

.EX
S Addr Wr [A] bVal [A] P
.br

.EE

.IP "\fBint i2c_read_byte(int pi, unsigned handle)\fP"
.IP "" 4
This reads a single byte from the device associated with handle.

.br

.br

.EX
    pi: >=0 (as returned by \fBpigpio_start\fP).
.br
handle: >=0, as returned by a call to \fBi2c_open\fP.
.br

.EE

.br

.br
Returns the byte read (>=0) if OK, otherwise PI_BAD_HANDLE,
or PI_I2C_READ_FAILED.

.br

.br
Receive byte. SMBus 2.0 5.5.3

.EX
S Addr Rd [A] [Data] NA P
.br

.EE

.IP "\fBint i2c_write_byte_data(int pi, unsigned handle, unsigned i2c_reg, unsigned bVal)\fP"
.IP "" 4
This writes a single byte to the specified register of the device
associated with handle.

.br

.br

.EX
     pi: >=0 (as returned by \fBpigpio_start\fP).
.br
 handle: >=0, as returned by a call to \fBi2c_open\fP.
.br
i2c_reg: 0-255, the register to write.
.br
   bVal: 0-0xFF, the value to write.
.br

.EE

.br

.br
Returns 0 if OK, otherwise PI_BAD_HANDLE, PI_BAD_PARAM, or
PI_I2C_WRITE_FAILED.

.br

.br
Write byte. SMBus 2.0 5.5.4

.EX
S Addr Wr [A] i2c_reg [A] bVal [A] P
.br

.EE

.IP "\fBint i2c_write_word_data(int pi, unsigned handle, unsigned i2c_reg, unsigned wVal)\fP"
.IP "" 4
This writes a single 16 bit word to the specified register of the device
associated with handle.

.br

.br

.EX
     pi: >=0 (as returned by \fBpigpio_start\fP).
.br
 handle: >=0, as returned by a call to \fBi2c_open\fP.
.br
i2c_reg: 0-255, the register to write.
.br
   wVal: 0-0xFFFF, the value to write.
.br

.EE

.br

.br
Returns 0 if OK, otherwise PI_BAD_HANDLE, PI_BAD_PARAM, or
PI_I2C_WRITE_FAILED.

.br

.br
Write word. SMBus 2.0 5.5.4

.EX
S Addr Wr [A] i2c_reg [A] wval_Low [A] wVal_High [A] P
.br

.EE

.IP "\fBint i2c_read_byte_data(int pi, unsigned handle, unsigned i2c_reg)\fP"
.IP "" 4
This reads a single byte from the specified register of the device
associated with handle.

.br

.br

.EX
     pi: >=0 (as returned by \fBpigpio_start\fP).
.br
 handle: >=0, as returned by a call to \fBi2c_open\fP.
.br
i2c_reg: 0-255, the register to read.
.br

.EE

.br

.br
Returns the byte read (>=0) if OK, otherwise PI_BAD_HANDLE,
PI_BAD_PARAM, or PI_I2C_READ_FAILED.

.br

.br
Read byte. SMBus 2.0 5.5.5

.EX
S Addr Wr [A] i2c_reg [A] S Addr Rd [A] [Data] NA P
.br

.EE

.IP "\fBint i2c_read_word_data(int pi, unsigned handle, unsigned i2c_reg)\fP"
.IP "" 4
This reads a single 16 bit word from the specified register of the device
associated with handle.

.br

.br

.EX
     pi: >=0 (as returned by \fBpigpio_start\fP).
.br
 handle: >=0, as returned by a call to \fBi2c_open\fP.
.br
i2c_reg: 0-255, the register to read.
.br

.EE

.br

.br
Returns the word read (>=0) if OK, otherwise PI_BAD_HANDLE,
PI_BAD_PARAM, or PI_I2C_READ_FAILED.

.br

.br
Read word. SMBus 2.0 5.5.5

.EX
S Addr Wr [A] i2c_reg [A]
.br
   S Addr Rd [A] [DataLow] A [DataHigh] NA P
.br

.EE

.IP "\fBint i2c_process_call(int pi, unsigned handle, unsigned i2c_reg, unsigned wVal)\fP"
.IP "" 4
This writes 16 bits of data to the specified register of the device
associated with handle and and reads 16 bits of data in return.

.br

.br

.EX
     pi: >=0 (as returned by \fBpigpio_start\fP).
.br
 handle: >=0, as returned by a call to \fBi2c_open\fP.
.br
i2c_reg: 0-255, the register to write/read.
.br
   wVal: 0-0xFFFF, the value to write.
.br

.EE

.br

.br
Returns the word read (>=0) if OK, otherwise PI_BAD_HANDLE,
PI_BAD_PARAM, or PI_I2C_READ_FAILED.

.br

.br
Process call. SMBus 2.0 5.5.6

.EX
S Addr Wr [A] i2c_reg [A] wVal_Low [A] wVal_High [A]
.br
   S Addr Rd [A] [DataLow] A [DataHigh] NA P
.br

.EE

.IP "\fBint i2c_write_block_data(int pi, unsigned handle, unsigned i2c_reg, char *buf, unsigned count)\fP"
.IP "" 4
This writes up to 32 bytes to the specified register of the device
associated with handle.

.br

.br

.EX
     pi: >=0 (as returned by \fBpigpio_start\fP).
.br
 handle: >=0, as returned by a call to \fBi2c_open\fP.
.br
i2c_reg: 0-255, the register to write.
.br
    buf: an array with the data to send.
.br
  count: 1-32, the number of bytes to write.
.br

.EE

.br

.br
Returns 0 if OK, otherwise PI_BAD_HANDLE, PI_BAD_PARAM, or
PI_I2C_WRITE_FAILED.

.br

.br
Block write. SMBus 2.0 5.5.7

.EX
S Addr Wr [A] i2c_reg [A] count [A] buf0 [A] buf1 [A] ...
.br
   [A] bufn [A] P
.br

.EE

.IP "\fBint i2c_read_block_data(int pi, unsigned handle, unsigned i2c_reg, char *buf)\fP"
.IP "" 4
This reads a block of up to 32 bytes from the specified register of
the device associated with handle.

.br

.br

.EX
     pi: >=0 (as returned by \fBpigpio_start\fP).
.br
 handle: >=0, as returned by a call to \fBi2c_open\fP.
.br
i2c_reg: 0-255, the register to read.
.br
    buf: an array to receive the read data.
.br

.EE

.br

.br
The amount of returned data is set by the device.

.br

.br
Returns the number of bytes read (>=0) if OK, otherwise PI_BAD_HANDLE,
PI_BAD_PARAM, or PI_I2C_READ_FAILED.

.br

.br
Block read. SMBus 2.0 5.5.7

.EX
S Addr Wr [A] i2c_reg [A]
.br
   S Addr Rd [A] [Count] A [buf0] A [buf1] A ... A [bufn] NA P
.br

.EE

.IP "\fBint i2c_block_process_call(int pi, unsigned handle, unsigned i2c_reg, char *buf, unsigned count)\fP"
.IP "" 4
This writes data bytes to the specified register of the device
associated with handle and reads a device specified number
of bytes of data in return.

.br

.br

.EX
     pi: >=0 (as returned by \fBpigpio_start\fP).
.br
 handle: >=0, as returned by a call to \fBi2c_open\fP.
.br
i2c_reg: 0-255, the register to write/read.
.br
    buf: an array with the data to send and to receive the read data.
.br
  count: 1-32, the number of bytes to write.
.br

.EE

.br

.br

.br

.br
Returns the number of bytes read (>=0) if OK, otherwise PI_BAD_HANDLE,
PI_BAD_PARAM, or PI_I2C_READ_FAILED.

.br

.br
The smbus 2.0 documentation states that a minimum of 1 byte may be
sent and a minimum of 1 byte may be received.  The total number of
bytes sent/received must be 32 or less.

.br

.br
Block write-block read. SMBus 2.0 5.5.8

.EX
S Addr Wr [A] i2c_reg [A] count [A] buf0 [A] ...
.br
   S Addr Rd [A] [Count] A [Data] ... A P
.br

.EE

.IP "\fBint i2c_read_i2c_block_data(int pi, unsigned handle, unsigned i2c_reg, char *buf, unsigned count)\fP"
.IP "" 4
This reads count bytes from the specified register of the device
associated with handle .  The count may be 1-32.

.br

.br

.EX
     pi: >=0 (as returned by \fBpigpio_start\fP).
.br
 handle: >=0, as returned by a call to \fBi2c_open\fP.
.br
i2c_reg: 0-255, the register to read.
.br
    buf: an array to receive the read data.
.br
  count: 1-32, the number of bytes to read.
.br

.EE

.br

.br
Returns the number of bytes read (>0) if OK, otherwise PI_BAD_HANDLE,
PI_BAD_PARAM, or PI_I2C_READ_FAILED.

.br

.br

.EX
S Addr Wr [A] i2c_reg [A]
.br
   S Addr Rd [A] [buf0] A [buf1] A ... A [bufn] NA P
.br

.EE

.IP "\fBint i2c_write_i2c_block_data(int pi, unsigned handle, unsigned i2c_reg, char *buf, unsigned count)\fP"
.IP "" 4
This writes 1 to 32 bytes to the specified register of the device
associated with handle.

.br

.br

.EX
     pi: >=0 (as returned by \fBpigpio_start\fP).
.br
 handle: >=0, as returned by a call to \fBi2c_open\fP.
.br
i2c_reg: 0-255, the register to write.
.br
    buf: the data to write.
.br
  count: 1-32, the number of bytes to write.
.br

.EE

.br

.br
Returns 0 if OK, otherwise PI_BAD_HANDLE, PI_BAD_PARAM, or
PI_I2C_WRITE_FAILED.

.br

.br

.EX
S Addr Wr [A] i2c_reg [A] buf0 [A] buf1 [A] ... [A] bufn [A] P
.br

.EE

.IP "\fBint i2c_read_device(int pi, unsigned handle, char *buf, unsigned count)\fP"
.IP "" 4
This reads count bytes from the raw device into buf.

.br

.br

.EX
    pi: >=0 (as returned by \fBpigpio_start\fP).
.br
handle: >=0, as returned by a call to \fBi2c_open\fP.
.br
   buf: an array to receive the read data bytes.
.br
 count: >0, the number of bytes to read.
.br

.EE

.br

.br
Returns count (>0) if OK, otherwise PI_BAD_HANDLE, PI_BAD_PARAM, or
PI_I2C_READ_FAILED.

.br

.br

.EX
S Addr Rd [A] [buf0] A [buf1] A ... A [bufn] NA P
.br

.EE

.IP "\fBint i2c_write_device(int pi, unsigned handle, char *buf, unsigned count)\fP"
.IP "" 4
This writes count bytes from buf to the raw device.

.br

.br

.EX
    pi: >=0 (as returned by \fBpigpio_start\fP).
.br
handle: >=0, as returned by a call to \fBi2c_open\fP.
.br
   buf: an array containing the data bytes to write.
.br
 count: >0, the number of bytes to write.
.br

.EE

.br

.br
Returns 0 if OK, otherwise PI_BAD_HANDLE, PI_BAD_PARAM, or
PI_I2C_WRITE_FAILED.

.br

.br

.EX
S Addr Wr [A] buf0 [A] buf1 [A] ... [A] bufn [A] P
.br

.EE

.IP "\fBint i2c_zip(int pi, unsigned handle, char *inBuf, unsigned inLen, char *outBuf, unsigned outLen)\fP"
.IP "" 4
This function executes a sequence of I2C operations.  The
operations to be performed are specified by the contents of inBuf
which contains the concatenated command codes and associated data.

.br

.br

.EX
    pi: >=0 (as returned by \fBpigpio_start\fP).
.br
handle: >=0, as returned by a call to \fBi2cOpen\fP
.br
 inBuf: pointer to the concatenated I2C commands, see below
.br
 inLen: size of command buffer
.br
outBuf: pointer to buffer to hold returned data
.br
outLen: size of output buffer
.br

.EE

.br

.br
Returns >= 0 if OK (the number of bytes read), otherwise
PI_BAD_HANDLE, PI_BAD_POINTER, PI_BAD_I2C_CMD, PI_BAD_I2C_RLEN.
PI_BAD_I2C_WLEN, or PI_BAD_I2C_SEG.

.br

.br
The following command codes are supported:

.br

.br
Name      Cmd & Data   Meaning
.br
End       0            No more commands
.br
Escape    1            Next P is two bytes
.br
On        2            Switch combined flag on
.br
Off       3            Switch combined flag off
.br
Address   4 P          Set I2C address to P
.br
Flags     5 lsb msb    Set I2C flags to lsb + (msb << 8)
.br
Read      6 P          Read P bytes of data
.br
Write     7 P ...      Write P bytes of data
.br

.br

.br
The address, read, and write commands take a parameter P.
Normally P is one byte (0-255).  If the command is preceded by
the Escape command then P is two bytes (0-65535, least significant
byte first).

.br

.br
The address defaults to that associated with the handle.
The flags default to 0.  The address and flags maintain their
previous value until updated.

.br

.br
The returned I2C data is stored in consecutive locations of outBuf.

.br

.br
\fBExample\fP
.br

.EX
Set address 0x53, write 0x32, read 6 bytes
.br
Set address 0x1E, write 0x03, read 6 bytes
.br
Set address 0x68, write 0x1B, read 8 bytes
.br
End
.br

.br
0x04 0x53   0x07 0x01 0x32   0x06 0x06
.br
0x04 0x1E   0x07 0x01 0x03   0x06 0x06
.br
0x04 0x68   0x07 0x01 0x1B   0x06 0x08
.br
0x00
.br

.EE

.br

.br

.IP "\fBint bb_i2c_open(int pi, unsigned SDA, unsigned SCL, unsigned baud)\fP"
.IP "" 4
This function selects a pair of GPIO for bit banging I2C at a
specified baud rate.

.br

.br
Bit banging I2C allows for certain operations which are not possible
with the standard I2C driver.

.br

.br
o baud rates as low as 50
.br
o repeated starts
.br
o clock stretching
.br
o I2C on any pair of spare GPIO

.br

.br

.EX
  pi: >=0 (as returned by \fBpigpio_start\fP).
.br
 SDA: 0-31
.br
 SCL: 0-31
.br
baud: 50-500000
.br

.EE

.br

.br
Returns 0 if OK, otherwise PI_BAD_USER_GPIO, PI_BAD_I2C_BAUD, or
PI_GPIO_IN_USE.

.br

.br
NOTE:

.br

.br
The GPIO used for SDA and SCL must have pull-ups to 3V3 connected.  As
a guide the hardware pull-ups on pins 3 and 5 are 1k8 in value.

.IP "\fBint bb_i2c_close(int pi, unsigned SDA)\fP"
.IP "" 4
This function stops bit banging I2C on a pair of GPIO previously
opened with \fBbb_i2c_open\fP.

.br

.br

.EX
 pi: >=0 (as returned by \fBpigpio_start\fP).
.br
SDA: 0-31, the SDA GPIO used in a prior call to \fBbb_i2c_open\fP
.br

.EE

.br

.br
Returns 0 if OK, otherwise PI_BAD_USER_GPIO, or PI_NOT_I2C_GPIO.

.IP "\fBint bb_i2c_zip(int pi, unsigned SDA, char *inBuf, unsigned inLen, char *outBuf, unsigned outLen)\fP"
.IP "" 4
This function executes a sequence of bit banged I2C operations.  The
operations to be performed are specified by the contents of inBuf
which contains the concatenated command codes and associated data.

.br

.br

.EX
    pi: >=0 (as returned by \fBpigpio_start\fP).
.br
   SDA: 0-31 (as used in a prior call to \fBbb_i2c_open\fP)
.br
 inBuf: pointer to the concatenated I2C commands, see below
.br
 inLen: size of command buffer
.br
outBuf: pointer to buffer to hold returned data
.br
outLen: size of output buffer
.br

.EE

.br

.br
Returns >= 0 if OK (the number of bytes read), otherwise
PI_BAD_USER_GPIO, PI_NOT_I2C_GPIO, PI_BAD_POINTER,
PI_BAD_I2C_CMD, PI_BAD_I2C_RLEN, PI_BAD_I2C_WLEN,
PI_I2C_READ_FAILED, or PI_I2C_WRITE_FAILED.

.br

.br
The following command codes are supported:

.br

.br
Name      Cmd & Data     Meaning
.br
End       0              No more commands
.br
Escape    1              Next P is two bytes
.br
Start     2              Start condition
.br
Stop      3              Stop condition
.br
Address   4 P            Set I2C address to P
.br
Flags     5 lsb msb      Set I2C flags to lsb + (msb << 8)
.br
Read      6 P            Read P bytes of data
.br
Write     7 P ...        Write P bytes of data
.br

.br

.br
The address, read, and write commands take a parameter P.
Normally P is one byte (0-255).  If the command is preceded by
the Escape command then P is two bytes (0-65535, least significant
byte first).

.br

.br
The address and flags default to 0.  The address and flags maintain
their previous value until updated.

.br

.br
No flags are currently defined.

.br

.br
The returned I2C data is stored in consecutive locations of outBuf.

.br

.br
\fBExample\fP
.br

.EX
Set address 0x53
.br
start, write 0x32, (re)start, read 6 bytes, stop
.br
Set address 0x1E
.br
start, write 0x03, (re)start, read 6 bytes, stop
.br
Set address 0x68
.br
start, write 0x1B, (re)start, read 8 bytes, stop
.br
End
.br

.br
0x04 0x53
.br
0x02 0x07 0x01 0x32   0x02 0x06 0x06 0x03
.br

.br
0x04 0x1E
.br
0x02 0x07 0x01 0x03   0x02 0x06 0x06 0x03
.br

.br
0x04 0x68
.br
0x02 0x07 0x01 0x1B   0x02 0x06 0x08 0x03
.br

.br
0x00
.br

.EE

.IP "\fBint bb_spi_open(int pi, unsigned CS, unsigned MISO, unsigned MOSI, unsigned SCLK, unsigned baud, unsigned spi_flags)\fP"
.IP "" 4
This function selects a set of GPIO for bit banging SPI at a
specified baud rate.

.br

.br

.EX
       pi: >=0 (as returned by \fBpigpio_start\fP).
.br
       CS: 0-31
.br
     MISO: 0-31
.br
     MOSI: 0-31
.br
     SCLK: 0-31
.br
     baud: 50-250000
.br
spi_flags: see below
.br

.EE

.br

.br
spi_flags consists of the least significant 22 bits.

.br

.br

.EX
21 20 19 18 17 16 15 14 13 12 11 10  9  8  7  6  5  4  3  2  1  0
.br
 0  0  0  0  0  0  R  T  0  0  0  0  0  0  0  0  0  0  0  p  m  m
.br

.EE

.br

.br
mm defines the SPI mode, defaults to 0

.br

.br

.EX
Mode CPOL CPHA
.br
 0    0    0
.br
 1    0    1
.br
 2    1    0
.br
 3    1    1
.br

.EE

.br

.br
p is 0 if CS is active low (default) and 1 for active high.

.br

.br
T is 1 if the least significant bit is transmitted on MOSI first, the
default (0) shifts the most significant bit out first.

.br

.br
R is 1 if the least significant bit is received on MISO first, the
default (0) receives the most significant bit first.

.br

.br
The other bits in flags should be set to zero.

.br

.br
Returns 0 if OK, otherwise PI_BAD_USER_GPIO, PI_BAD_SPI_BAUD, or
PI_GPIO_IN_USE.

.br

.br
If more than one device is connected to the SPI bus (defined by
SCLK, MOSI, and MISO) each must have its own CS.

.br

.br
\fBExample\fP
.br

.EX
bb_spi_open(pi,10, MISO, MOSI, SCLK, 10000, 0); // device 1
.br
bb_spi_open(pi,11, MISO, MOSI, SCLK, 20000, 3); // device 2
.br

.EE

.IP "\fBint bb_spi_close(int pi, unsigned CS)\fP"
.IP "" 4
This function stops bit banging SPI on a set of GPIO
opened with \fBbbSPIOpen\fP.

.br

.br

.EX
pi: >=0 (as returned by \fBpigpio_start\fP).
.br
CS: 0-31, the CS GPIO used in a prior call to \fBbb_spi_open\fP
.br

.EE

.br

.br
Returns 0 if OK, otherwise PI_BAD_USER_GPIO, or PI_NOT_SPI_GPIO.

.IP "\fBint bb_spi_xfer(int pi, unsigned CS, char *txBuf, char *rxBuf, unsigned count)\fP"
.IP "" 4
This function executes a bit banged SPI transfer.

.br

.br

.EX
   pi: >=0 (as returned by \fBpigpio_start\fP).
.br
   CS: 0-31 (as used in a prior call to \fBbb_spi_open\fP)
.br
txBuf: pointer to buffer to hold data to be sent
.br
rxBuf: pointer to buffer to hold returned data
.br
count: size of data transfer
.br

.EE

.br

.br
Returns >= 0 if OK (the number of bytes read), otherwise
PI_BAD_USER_GPIO, PI_NOT_SPI_GPIO or PI_BAD_POINTER.

.br

.br
\fBExample\fP
.br

.EX
// gcc -Wall -pthread -o bb_spi_x_test bb_spi_x_test.c -lpigpiod_if2
.br
// ./bb_spi_x_test
.br

.br
#include <stdio.h>
.br

.br
#include "pigpiod_if2.h"
.br

.br
#define CE0 5
.br
#define CE1 6
.br
#define MISO 13
.br
#define MOSI 19
.br
#define SCLK 12
.br

.br
int main(int argc, char *argv[])
.br
{
.br
   int i, pi, count, set_val, read_val;
.br
   unsigned char inBuf[3];
.br
   char cmd1[] = {0, 0};
.br
   char cmd2[] = {12, 0};
.br
   char cmd3[] = {1, 128, 0};
.br

.br
   if ((pi = pigpio_start(0, 0)) < 0)
.br
   {
.br
      fprintf(stderr, "pigpio initialisation failed (%d).\n", pi);
.br
      return 1;
.br
   }
.br

.br
   bb_spi_open(pi, CE0, MISO, MOSI, SCLK, 10000, 0); // MCP4251 DAC
.br
   bb_spi_open(pi, CE1, MISO, MOSI, SCLK, 20000, 3); // MCP3008 ADC
.br

.br
   for (i=0; i<256; i++)
.br
   {
.br
      cmd1[1] = i;
.br

.br
      count = bb_spi_xfer(pi, CE0, cmd1, (char *)inBuf, 2); // > DAC
.br

.br
      if (count == 2)
.br
      {
.br
         count = bb_spi_xfer(pi, CE0, cmd2, (char *)inBuf, 2); // < DAC
.br

.br
         if (count == 2)
.br
         {
.br
            set_val = inBuf[1];
.br

.br
            count = bb_spi_xfer(pi, CE1, cmd3, (char *)inBuf, 3); // < ADC
.br

.br
            if (count == 3)
.br
            {
.br
               read_val = ((inBuf[1]&3)<<8) | inBuf[2];
.br
               printf("%d %d\n", set_val, read_val);
.br
            }
.br
         }
.br
      }
.br
   }
.br

.br
   bb_spi_close(pi, CE0);
.br
   bb_spi_close(pi, CE1);
.br

.br
   pigpio_stop(pi);
.br
}
.br

.EE

.IP "\fBint spi_open(int pi, unsigned spi_channel, unsigned baud, unsigned spi_flags)\fP"
.IP "" 4
This function returns a handle for the SPI device on the channel.
Data will be transferred at baud bits per second.  The flags may
be used to modify the default behaviour of 4-wire operation, mode 0,
active low chip select.

.br

.br
The Pi has two SPI peripherals: main and auxiliary.

.br

.br
The main SPI has two chip selects (channels), the auxiliary has
three.

.br

.br
The auxiliary SPI is available on all models but the A and B.

.br

.br
The GPIO used are given in the following table.

.br

.br
           MISO   MOSI   SCLK   CE0   CE1   CE2
.br
Main SPI      9     10     11     8     7     -
.br
Aux SPI      19     20     21    18    17    16
.br

.br

.br

.EX
         pi: >=0 (as returned by \fBpigpio_start\fP).
.br
spi_channel: 0-1 (0-2 for the auxiliary SPI).
.br
       baud: 32K-125M (values above 30M are unlikely to work).
.br
  spi_flags: see below.
.br

.EE

.br

.br
Returns a handle (>=0) if OK, otherwise PI_BAD_SPI_CHANNEL,
PI_BAD_SPI_SPEED, PI_BAD_FLAGS, PI_NO_AUX_SPI, or PI_SPI_OPEN_FAILED.

.br

.br
spi_flags consists of the least significant 22 bits.

.br

.br

.EX
21 20 19 18 17 16 15 14 13 12 11 10  9  8  7  6  5  4  3  2  1  0
.br
 b  b  b  b  b  b  R  T  n  n  n  n  W  A u2 u1 u0 p2 p1 p0  m  m
.br

.EE

.br

.br
mm defines the SPI mode.

.br

.br
Warning: modes 1 and 3 do not appear to work on the auxiliary SPI.

.br

.br

.EX
Mode POL PHA
.br
 0    0   0
.br
 1    0   1
.br
 2    1   0
.br
 3    1   1
.br

.EE

.br

.br
px is 0 if CEx is active low (default) and 1 for active high.

.br

.br
ux is 0 if the CEx GPIO is reserved for SPI (default) and 1 otherwise.

.br

.br
A is 0 for the main SPI, 1 for the auxiliary SPI.

.br

.br
W is 0 if the device is not 3-wire, 1 if the device is 3-wire.  Main
SPI only.

.br

.br
nnnn defines the number of bytes (0-15) to write before switching
the MOSI line to MISO to read data.  This field is ignored
if W is not set.  Main SPI only.

.br

.br
T is 1 if the least significant bit is transmitted on MOSI first, the
default (0) shifts the most significant bit out first.  Auxiliary SPI
only.

.br

.br
R is 1 if the least significant bit is received on MISO first, the
default (0) receives the most significant bit first.  Auxiliary SPI
only.

.br

.br
bbbbbb defines the word size in bits (0-32).  The default (0)
sets 8 bits per word.  Auxiliary SPI only.

.br

.br
The \fBspi_read\fP, \fBspi_write\fP, and \fBspi_xfer\fP functions
transfer data packed into 1, 2, or 4 bytes according to
the word size in bits.

.br

.br
For bits 1-8 there will be one byte per character.
.br
For bits 9-16 there will be two bytes per character.
.br
For bits 17-32 there will be four bytes per character.

.br

.br
Multi-byte transfers are made in least significant byte first order.

.br

.br
E.g. to transfer 32 11-bit words buf should contain 64 bytes
and count should be 64.

.br

.br
E.g. to transfer the 14 bit value 0x1ABC send the bytes 0xBC followed
by 0x1A.

.br

.br
The other bits in flags should be set to zero.

.IP "\fBint spi_close(int pi, unsigned handle)\fP"
.IP "" 4
This functions closes the SPI device identified by the handle.

.br

.br

.EX
    pi: >=0 (as returned by \fBpigpio_start\fP).
.br
handle: >=0, as returned by a call to \fBspi_open\fP.
.br

.EE

.br

.br
Returns 0 if OK, otherwise PI_BAD_HANDLE.

.IP "\fBint spi_read(int pi, unsigned handle, char *buf, unsigned count)\fP"
.IP "" 4
This function reads count bytes of data from the SPI
device associated with the handle.

.br

.br

.EX
    pi: >=0 (as returned by \fBpigpio_start\fP).
.br
handle: >=0, as returned by a call to \fBspi_open\fP.
.br
   buf: an array to receive the read data bytes.
.br
 count: the number of bytes to read.
.br

.EE

.br

.br
Returns the number of bytes transferred if OK, otherwise
PI_BAD_HANDLE, PI_BAD_SPI_COUNT, or PI_SPI_XFER_FAILED.

.IP "\fBint spi_write(int pi, unsigned handle, char *buf, unsigned count)\fP"
.IP "" 4
This function writes count bytes of data from buf to the SPI
device associated with the handle.

.br

.br

.EX
    pi: >=0 (as returned by \fBpigpio_start\fP).
.br
handle: >=0, as returned by a call to \fBspi_open\fP.
.br
   buf: the data bytes to write.
.br
 count: the number of bytes to write.
.br

.EE

.br

.br
Returns the number of bytes transferred if OK, otherwise
PI_BAD_HANDLE, PI_BAD_SPI_COUNT, or PI_SPI_XFER_FAILED.

.IP "\fBint spi_xfer(int pi, unsigned handle, char *txBuf, char *rxBuf, unsigned count)\fP"
.IP "" 4
This function transfers count bytes of data from txBuf to the SPI
device associated with the handle.  Simultaneously count bytes of
data are read from the device and placed in rxBuf.

.br

.br

.EX
    pi: >=0 (as returned by \fBpigpio_start\fP).
.br
handle: >=0, as returned by a call to \fBspi_open\fP.
.br
 txBuf: the data bytes to write.
.br
 rxBuf: the received data bytes.
.br
 count: the number of bytes to transfer.
.br

.EE

.br

.br
Returns the number of bytes transferred if OK, otherwise
PI_BAD_HANDLE, PI_BAD_SPI_COUNT, or PI_SPI_XFER_FAILED.

.IP "\fBint serial_open(int pi, char *ser_tty, unsigned baud, unsigned ser_flags)\fP"
.IP "" 4
This function opens a serial device at a specified baud rate
with specified flags.  The device name must start with
/dev/tty or /dev/serial.

.br

.br

.br

.br

.EX
       pi: >=0 (as returned by \fBpigpio_start\fP).
.br
  ser_tty: the serial device to open.
.br
     baud: the baud rate in bits per second, see below.
.br
ser_flags: 0.
.br

.EE

.br

.br
Returns a handle (>=0) if OK, otherwise PI_NO_HANDLE, or
PI_SER_OPEN_FAILED.

.br

.br
The baud rate must be one of 50, 75, 110, 134, 150,
200, 300, 600, 1200, 1800, 2400, 4800, 9600, 19200,
38400, 57600, 115200, or 230400.

.br

.br
No flags are currently defined.  This parameter should be set to zero.

.IP "\fBint serial_close(int pi, unsigned handle)\fP"
.IP "" 4
This function closes the serial device associated with handle.

.br

.br

.EX
    pi: >=0 (as returned by \fBpigpio_start\fP).
.br
handle: >=0, as returned by a call to \fBserial_open\fP.
.br

.EE

.br

.br
Returns 0 if OK, otherwise PI_BAD_HANDLE.

.IP "\fBint serial_write_byte(int pi, unsigned handle, unsigned bVal)\fP"
.IP "" 4
This function writes bVal to the serial port associated with handle.

.br

.br

.EX
    pi: >=0 (as returned by \fBpigpio_start\fP).
.br
handle: >=0, as returned by a call to \fBserial_open\fP.
.br

.EE

.br

.br
Returns 0 if OK, otherwise PI_BAD_HANDLE, PI_BAD_PARAM, or
PI_SER_WRITE_FAILED.

.IP "\fBint serial_read_byte(int pi, unsigned handle)\fP"
.IP "" 4
This function reads a byte from the serial port associated with handle.

.br

.br

.EX
    pi: >=0 (as returned by \fBpigpio_start\fP).
.br
handle: >=0, as returned by a call to \fBserial_open\fP.
.br

.EE

.br

.br
Returns the read byte (>=0) if OK, otherwise PI_BAD_HANDLE,
PI_SER_READ_NO_DATA, or PI_SER_READ_FAILED.

.br

.br
If no data is ready PI_SER_READ_NO_DATA is returned.

.IP "\fBint serial_write(int pi, unsigned handle, char *buf, unsigned count)\fP"
.IP "" 4
This function writes count bytes from buf to the the serial port
associated with handle.

.br

.br

.EX
    pi: >=0 (as returned by \fBpigpio_start\fP).
.br
handle: >=0, as returned by a call to \fBserial_open\fP.
.br
   buf: the array of bytes to write.
.br
 count: the number of bytes to write.
.br

.EE

.br

.br
Returns 0 if OK, otherwise PI_BAD_HANDLE, PI_BAD_PARAM, or
PI_SER_WRITE_FAILED.

.IP "\fBint serial_read(int pi, unsigned handle, char *buf, unsigned count)\fP"
.IP "" 4
This function reads up to count bytes from the the serial port
associated with handle and writes them to buf.

.br

.br

.EX
    pi: >=0 (as returned by \fBpigpio_start\fP).
.br
handle: >=0, as returned by a call to \fBserial_open\fP.
.br
   buf: an array to receive the read data.
.br
 count: the maximum number of bytes to read.
.br

.EE

.br

.br
Returns the number of bytes read (>=0) if OK, otherwise PI_BAD_HANDLE,
PI_BAD_PARAM, PI_SER_READ_NO_DATA, or PI_SER_WRITE_FAILED.

.br

.br
If no data is ready zero is returned.

.IP "\fBint serial_data_available(int pi, unsigned handle)\fP"
.IP "" 4
Returns the number of bytes available to be read from the
device associated with handle.

.br

.br

.EX
    pi: >=0 (as returned by \fBpigpio_start\fP).
.br
handle: >=0, as returned by a call to \fBserial_open\fP.
.br

.EE

.br

.br
Returns the number of bytes of data available (>=0) if OK,
otherwise PI_BAD_HANDLE.

.IP "\fBint custom_1(int pi, unsigned arg1, unsigned arg2, char *argx, unsigned argc)\fP"
.IP "" 4
This function is available for user customisation.

.br

.br
It returns a single integer value.

.br

.br

.EX
  pi: >=0 (as returned by \fBpigpio_start\fP).
.br
arg1: >=0
.br
arg2: >=0
.br
argx: extra (byte) arguments
.br
argc: number of extra arguments
.br

.EE

.br

.br
Returns >= 0 if OK, less than 0 indicates a user defined error.

.IP "\fBint custom_2(int pi, unsigned arg1, char *argx, unsigned argc, char *retBuf, unsigned retMax)\fP"
.IP "" 4
This function is available for user customisation.

.br

.br
It differs from custom_1 in that it returns an array of bytes
rather than just an integer.

.br

.br
The return value is an integer indicating the number of returned bytes.

.EX
    pi: >=0 (as returned by \fBpigpio_start\fP).
.br
  arg1: >=0
.br
  argc: extra (byte) arguments
.br
 count: number of extra arguments
.br
retBuf: buffer for returned data
.br
retMax: maximum number of bytes to return
.br

.EE

.br

.br
Returns >= 0 if OK, less than 0 indicates a user defined error.

.br

.br
Note, the number of returned bytes will be retMax or less.

.IP "\fBint get_pad_strength(int pi, unsigned pad)\fP"
.IP "" 4
This function returns the pad drive strength in mA.

.br

.br

.EX
 pi: >=0 (as returned by \fBpigpio_start\fP).
.br
pad: 0-2, the pad to get.
.br

.EE

.br

.br
Returns the pad drive strength if OK, otherwise PI_BAD_PAD.

.br

.br
Pad   GPIO
.br
0     0-27
.br
1     28-45
.br
2     46-53
.br

.br

.br
\fBExample\fP
.br

.EX
strength = get_pad_strength(pi, 0); //  get pad 0 strength
.br

.EE

.IP "\fBint set_pad_strength(int pi, unsigned pad, unsigned padStrength)\fP"
.IP "" 4
This function sets the pad drive strength in mA.

.br

.br

.EX
         pi: >=0 (as returned by \fBpigpio_start\fP).
.br
        pad: 0-2, the pad to set.
.br
padStrength: 1-16 mA.
.br

.EE

.br

.br
Returns 0 if OK, otherwise PI_BAD_PAD, or PI_BAD_STRENGTH.

.br

.br
Pad   GPIO
.br
0     0-27
.br
1     28-45
.br
2     46-53
.br

.br

.br
\fBExample\fP
.br

.EX
set_pad_strength(pi, 0, 10); // set pad 0 strength to 10 mA
.br

.EE

.IP "\fBint shell_(int pi, char *scriptName, char *scriptString)\fP"
.IP "" 4
This function uses the system call to execute a shell script
with the given string as its parameter.

.br

.br

.EX
          pi: >=0 (as returned by \fBpigpio_start\fP).
.br
  scriptName: the name of the script, only alphanumeric characters,
.br
              '-' and '_' are allowed in the name.
.br
scriptString: the string to pass to the script.
.br

.EE

.br

.br
The exit status of the system call is returned if OK, otherwise
PI_BAD_SHELL_STATUS.

.br

.br
scriptName must exist in /opt/pigpio/cgi and must be executable.

.br

.br
The returned exit status is normally 256 times that set by the
shell script exit function.  If the script can't be found 32512 will
be returned.

.br

.br
The following table gives some example returned statuses.

.br

.br
Script exit status   Returned system call status
.br
1                    256
.br
5                    1280
.br
10                   2560
.br
200                  51200
.br
script not found     32512
.br

.br

.br
\fBExample\fP
.br

.EX
// pass two parameters, hello and world
.br
status = shell_(pi, "scr1", "hello world");
.br

.br
// pass three parameters, hello, string with spaces, and world
.br
status = shell_(pi, "scr1", "hello 'string with spaces' world");
.br

.br
// pass one parameter, hello string with spaces world
.br
status = shell_(pi, "scr1", "\"hello string with spaces world\"");
.br

.EE

.IP "\fBint file_open(int pi, char *file, unsigned mode)\fP"
.IP "" 4
This function returns a handle to a file opened in a specified mode.

.br

.br

.EX
  pi: >=0 (as returned by \fBpigpio_start\fP).
.br
file: the file to open.
.br
mode: the file open mode.
.br

.EE

.br

.br
Returns a handle (>=0) if OK, otherwise PI_NO_HANDLE, PI_NO_FILE_ACCESS,
PI_BAD_FILE_MODE, PI_FILE_OPEN_FAILED, or PI_FILE_IS_A_DIR.

.br

.br
File

.br

.br
A file may only be opened if permission is granted by an entry in
/opt/pigpio/access.  This is intended to allow remote access to files
in a more or less controlled manner.

.br

.br
Each entry in /opt/pigpio/access takes the form of a file path
which may contain wildcards followed by a single letter permission.
The permission may be R for read, W for write, U for read/write,
and N for no access.

.br

.br
Where more than one entry matches a file the most specific rule
applies.  If no entry matches a file then access is denied.

.br

.br
Suppose /opt/pigpio/access contains the following entries

.br

.br

.EX
/home/* n
.br
/home/pi/shared/dir_1/* w
.br
/home/pi/shared/dir_2/* r
.br
/home/pi/shared/dir_3/* u
.br
/home/pi/shared/dir_1/file.txt n
.br

.EE

.br

.br
Files may be written in directory dir_1 with the exception
of file.txt.

.br

.br
Files may be read in directory dir_2.

.br

.br
Files may be read and written in directory dir_3.

.br

.br
If a directory allows read, write, or read/write access then files may
be created in that directory.

.br

.br
In an attempt to prevent risky permissions the following paths are
ignored in /opt/pigpio/access.

.br

.br

.EX
a path containing ..
.br
a path containing only wildcards (*?)
.br
a path containing less than two non-wildcard parts
.br

.EE

.br

.br
Mode

.br

.br
The mode may have the following values.

.br

.br
Macro           Value   Meaning
.br
PI_FILE_READ      1     open file for reading
.br
PI_FILE_WRITE     2     open file for writing
.br
PI_FILE_RW        3     open file for reading and writing
.br

.br

.br
The following values may be or'd into the mode.

.br

.br
Macro            Value   Meaning
.br
PI_FILE_APPEND   4       Writes append data to the end of the file
.br
PI_FILE_CREATE   8       The file is created if it doesn't exist
.br
PI_FILE_TRUNC    16      The file is truncated
.br

.br

.br
Newly created files are owned by root with permissions owner read and write.

.br

.br
\fBExample\fP
.br

.EX
#include <stdio.h>
.br
#include <pigpiod_if2.h>
.br

.br
int main(int argc, char *argv[])
.br
{
.br
   int pi, handle, c;
.br
   char buf[60000];
.br

.br
   pi = pigpio_start(NULL, NULL);
.br

.br
   if (pi < 0) return 1;
.br

.br
   // assumes /opt/pigpio/access contains the following line
.br
   // /ram/*.c r
.br

.br
   handle = file_open(pi, "/ram/pigpio.c", PI_FILE_READ);
.br

.br
   if (handle >= 0)
.br
   {
.br
      while ((c=file_read(pi, handle, buf, sizeof(buf)-1)))
.br
      {
.br
         buf[c] = 0;
.br
         printf("%s", buf);
.br
      }
.br

.br
      file_close(pi, handle);
.br
   }
.br

.br
   pigpio_stop(pi);
.br
}
.br

.EE

.IP "\fBint file_close(int pi, unsigned handle)\fP"
.IP "" 4
This function closes the file associated with handle.

.br

.br

.EX
    pi: >=0 (as returned by \fBpigpio_start\fP).
.br
handle: >=0 (as returned by \fBfile_open\fP).
.br

.EE

.br

.br
Returns 0 if OK, otherwise PI_BAD_HANDLE.

.br

.br
\fBExample\fP
.br

.EX
file_close(pi, handle);
.br

.EE

.IP "\fBint file_write(int pi, unsigned handle, char *buf, unsigned count)\fP"
.IP "" 4
This function writes count bytes from buf to the the file
associated with handle.

.br

.br

.EX
    pi: >=0 (as returned by \fBpigpio_start\fP).
.br
handle: >=0 (as returned by \fBfile_open\fP).
.br
   buf: the array of bytes to write.
.br
 count: the number of bytes to write.
.br

.EE

.br

.br
Returns 0 if OK, otherwise PI_BAD_HANDLE, PI_BAD_PARAM,
PI_FILE_NOT_WOPEN, or PI_BAD_FILE_WRITE.

.br

.br
\fBExample\fP
.br

.EX
if (file_write(pi, handle, buf, 100) == 0)
.br
{
.br
   // file written okay
.br
}
.br
else
.br
{
.br
   // error
.br
}
.br

.EE

.IP "\fBint file_read(int pi, unsigned handle, char *buf, unsigned count)\fP"
.IP "" 4
This function reads up to count bytes from the the file
associated with handle and writes them to buf.

.br

.br

.EX
    pi: >=0 (as returned by \fBpigpio_start\fP).
.br
handle: >=0 (as returned by \fBfile_open\fP).
.br
   buf: an array to receive the read data.
.br
 count: the maximum number of bytes to read.
.br

.EE

.br

.br
Returns the number of bytes read (>0) if OK, otherwise PI_BAD_HANDLE, PI_BAD_PARAM, PI_FILE_NOT_ROPEN, or PI_BAD_FILE_WRITE.

.br

.br
\fBExample\fP
.br

.EX
   bytes = file_read(pi, handle, buf, sizeof(buf));
.br

.br
   if (bytes >= 0)
.br
   {
.br
      // process read data
.br
   }
.br

.EE

.IP "\fBint file_seek(int pi, unsigned handle, int32_t seekOffset, int seekFrom)\fP"
.IP "" 4
This function seeks to a position within the file associated
with handle.

.br

.br

.EX
        pi: >=0 (as returned by \fBpigpio_start\fP).
.br
    handle: >=0 (as returned by \fBfile_open\fP).
.br
seekOffset: the number of bytes to move.  Positive offsets
.br
            move forward, negative offsets backwards.
.br
  seekFrom: one of PI_FROM_START (0), PI_FROM_CURRENT (1),
.br
            or PI_FROM_END (2).
.br

.EE

.br

.br
Returns the new byte position within the file (>=0) if OK, otherwise PI_BAD_HANDLE, or PI_BAD_FILE_SEEK.

.br

.br
\fBExample\fP
.br

.EX
file_seek(pi, handle, 123, PI_FROM_START); // Start plus 123
.br

.br
size = file_seek(pi, handle, 0, PI_FROM_END); // End, return size
.br

.br
pos = file_seek(pi, handle, 0, PI_FROM_CURRENT); // Current position
.br

.EE

.IP "\fBint file_list(int pi, char *fpat, char *buf, unsigned count)\fP"
.IP "" 4
This function returns a list of files which match a pattern.

.br

.br

.EX
   pi: >=0 (as returned by \fBpigpio_start\fP).
.br
 fpat: file pattern to match.
.br
  buf: an array to receive the matching file names.
.br
count: the maximum number of bytes to read.
.br

.EE

.br

.br
Returns the number of returned bytes if OK, otherwise PI_NO_FILE_ACCESS,
or PI_NO_FILE_MATCH.

.br

.br
The pattern must match an entry in /opt/pigpio/access.  The pattern
may contain wildcards.  See \fBfile_open\fP.

.br

.br
NOTE

.br

.br
The returned value is not the number of files, it is the number
of bytes in the buffer.  The file names are separated by newline
characters.

.br

.br
\fBExample\fP
.br

.EX
#include <stdio.h>
.br
#include <pigpiod_if2.h>
.br

.br
int main(int argc, char *argv[])
.br
{
.br
   int pi, handle, c;
.br
   char buf[60000];
.br

.br
   pi = pigpio_start(NULL, NULL);
.br

.br
   if (pi < 0) return 1;
.br

.br
   // assumes /opt/pigpio/access contains the following line
.br
   // /ram/*.c r
.br

.br
   c = file_list(pi, "/ram/p*.c", buf, sizeof(buf));
.br

.br
   if (c >= 0)
.br
   {
.br
      buf[c] = 0;
.br
      printf("%s", buf);
.br
   }
.br

.br
   pigpio_stop(pi);
.br
}
.br

.EE

.IP "\fBint callback(int pi, unsigned user_gpio, unsigned edge, CBFunc_t f)\fP"
.IP "" 4
This function initialises a new callback.

.br

.br

.EX
       pi: >=0 (as returned by \fBpigpio_start\fP).
.br
user_gpio: 0-31.
.br
     edge: RISING_EDGE, FALLING_EDGE, or EITHER_EDGE.
.br
        f: the callback function.
.br

.EE

.br

.br
The function returns a callback id if OK, otherwise pigif_bad_malloc,
pigif_duplicate_callback, or pigif_bad_callback.

.br

.br
The callback is called with the GPIO, edge, and tick, whenever the
GPIO has the identified edge.

.br

.br

.EX
Parameter   Value    Meaning
.br

.br
GPIO        0-31     The GPIO which has changed state
.br

.br
edge        0-2      0 = change to low (a falling edge)
.br
                     1 = change to high (a rising edge)
.br
                     2 = no level change (a watchdog timeout)
.br

.br
tick        32 bit   The number of microseconds since boot
.br
                     WARNING: this wraps around from
.br
                     4294967295 to 0 roughly every 72 minutes
.br

.EE

.br

.br
The GPIO are sampled at a rate set when the pigpio daemon
is started (default 5 us).

.br

.br
The number of samples per second is given in the following table.

.br

.br

.EX
              samples
.br
              per sec
.br

.br
         1  1,000,000
.br
         2    500,000
.br
sample   4    250,000
.br
rate     5    200,000
.br
(us)     8    125,000
.br
        10    100,000
.br

.EE

.br

.br
GPIO level changes shorter than the sample rate may be missed.

.br

.br
The daemon software which generates the callbacks is triggered
1000 times per second.  The callbacks will be called once per
level change since the last time they were called.
i.e. The callbacks will get all level changes but there will
be a latency.

.br

.br
If you want to track the level of more than one GPIO do so by
maintaining the state in the callback.  Do not use \fBgpio_read\fP.
Remember the event that triggered the callback may have
happened several milliseconds before and the GPIO may have
changed level many times since then.

.IP "\fBint callback_ex(int pi, unsigned user_gpio, unsigned edge, CBFuncEx_t f, void *userdata)\fP"
.IP "" 4
This function initialises a new callback.

.br

.br

.EX
       pi: >=0 (as returned by \fBpigpio_start\fP).
.br
user_gpio: 0-31.
.br
     edge: RISING_EDGE, FALLING_EDGE, or EITHER_EDGE.
.br
        f: the callback function.
.br
 userdata: a pointer to arbitrary user data.
.br

.EE

.br

.br
The function returns a callback id if OK, otherwise pigif_bad_malloc,
pigif_duplicate_callback, or pigif_bad_callback.

.br

.br
The callback is called with the GPIO, edge, tick, and the userdata
pointer, whenever the GPIO has the identified edge.

.br

.br

.EX
Parameter   Value    Meaning
.br

.br
GPIO        0-31     The GPIO which has changed state
.br

.br
edge        0-2      0 = change to low (a falling edge)
.br
                     1 = change to high (a rising edge)
.br
                     2 = no level change (a watchdog timeout)
.br

.br
tick        32 bit   The number of microseconds since boot
.br
                     WARNING: this wraps around from
.br
                     4294967295 to 0 roughly every 72 minutes
.br

.br
userdata    pointer  Pointer to an arbitrary object
.br

.EE

.IP "\fBint callback_cancel(unsigned callback_id)\fP"
.IP "" 4
This function cancels a callback identified by its id.

.br

.br

.EX
callback_id: >=0, as returned by a call to \fBcallback\fP or \fBcallback_ex\fP.
.br

.EE

.br

.br
The function returns 0 if OK, otherwise pigif_callback_not_found.

.IP "\fBint wait_for_edge(int pi, unsigned user_gpio, unsigned edge, double timeout)\fP"
.IP "" 4
This function waits for an edge on the GPIO for up to timeout
seconds.

.br

.br

.EX
       pi: >=0 (as returned by \fBpigpio_start\fP).
.br
user_gpio: 0-31.
.br
     edge: RISING_EDGE, FALLING_EDGE, or EITHER_EDGE.
.br
  timeout: >=0.
.br

.EE

.br

.br
The function returns when the edge occurs or after the timeout.

.br

.br
Do not use this function for precise timing purposes,
the edge is only checked 20 times a second. Whenever
you need to know the accurate time of GPIO events use
a \fBcallback\fP function.

.br

.br
The function returns 1 if the edge occurred, otherwise 0.

.IP "\fBint bsc_xfer(int pi, bsc_xfer_t *bscxfer)\fP"
.IP "" 4
This function provides a low-level interface to the SPI/I2C Slave
peripheral on the BCM chip.

.br

.br
This peripheral allows the Pi to act as a hardware slave device
on an I2C or SPI bus.

.br

.br
This is not a bit bang version and as such is OS timing
independent. The bus timing is handled directly by the chip.

.br

.br
The output process is simple. You simply append data to the FIFO
buffer on the chip.  This works like a queue, you add data to the
queue and the master removes it.

.br

.br
The function sets the BSC mode, writes any data in
the transmit buffer to the BSC transmit FIFO, and
copies any data in the BSC receive FIFO to the
receive buffer.

.br

.br

.EX
     pi: >=0 (as returned by \fBpigpio_start\fP).
.br
bscxfer: a structure defining the transfer.
.br

.br
typedef struct
.br
{
.br
   uint32_t control;          // Write
.br
   int rxCnt;                 // Read only
.br
   char rxBuf[BSC_FIFO_SIZE]; // Read only
.br
   int txCnt;                 // Write
.br
   char txBuf[BSC_FIFO_SIZE]; // Write
.br
} bsc_xfer_t;
.br

.EE

.br

.br
To start a transfer set control (see below), copy the bytes to
be added to the transmit FIFO (if any) to txBuf and set txCnt to
the number of copied bytes.

.br

.br
Upon return rxCnt will be set to the number of received bytes placed
in rxBuf.

.br

.br
The returned function value is the status of the transfer (see below).

.br

.br
If there was an error the status will be less than zero
(and will contain the error code).

.br

.br
The most significant word of the returned status contains the number
of bytes actually copied from txBuf to the BSC transmit FIFO (may be
less than requested if the FIFO already contained untransmitted data).

.br

.br
Note that the control word sets the BSC mode.  The BSC will stay in
that mode until a different control word is sent.

.br

.br
GPIO used for models other than those based on the BCM2711.

.br

.br
      SDA   SCL   MOSI   SCLK   MISO   CE
.br
I2C   18    19    -      -      -      -
.br
SPI   -     -     20     19     18     21
.br

.br

.br
GPIO used for models based on the BCM2711 (e.g. the Pi4B).

.br

.br
      SDA   SCL   MOSI   SCLK   MISO   CE
.br
I2C   10    11    -      -      -      -
.br
SPI   -     -     9      11     10     8
.br

.br

.br
When a zero control word is received the used GPIO will be reset
to INPUT mode.

.br

.br
control consists of the following bits.

.br

.br

.EX
22 21 20 19 18 17 16 15 14 13 12 11 10  9  8  7  6  5  4  3  2  1  0
.br
 a  a  a  a  a  a  a  -  - IT HC TF IR RE TE BK EC ES PL PH I2 SP EN
.br

.EE

.br

.br
Bits 0-13 are copied unchanged to the BSC CR register.  See
pages 163-165 of the Broadcom peripherals document for full
details.

.br

.br
aaaaaaa   defines the I2C slave address (only relevant in I2C mode)
.br
IT        invert transmit status flags
.br
HC        enable host control
.br
TF        enable test FIFO
.br
IR        invert receive status flags
.br
RE        enable receive
.br
TE        enable transmit
.br
BK        abort operation and clear FIFOs
.br
EC        send control register as first I2C byte
.br
ES        send status register as first I2C byte
.br
PL        set SPI polarity high
.br
PH        set SPI phase high
.br
I2        enable I2C mode
.br
SP        enable SPI mode
.br
EN        enable BSC peripheral
.br

.br

.br
The returned status has the following format

.br

.br

.EX
20 19 18 17 16 15 14 13 12 11 10  9  8  7  6  5  4  3  2  1  0
.br
 S  S  S  S  S  R  R  R  R  R  T  T  T  T  T RB TE RF TF RE TB
.br

.EE

.br

.br
Bits 0-15 are copied unchanged from the BSC FR register.  See
pages 165-166 of the Broadcom peripherals document for full
details.

.br

.br
SSSSS   number of bytes successfully copied to transmit FIFO
.br
RRRRR   number of bytes in receive FIFO
.br
TTTTT   number of bytes in transmit FIFO
.br
RB      receive busy
.br
TE      transmit FIFO empty
.br
RF      receive FIFO full
.br
TF      transmit FIFO full
.br
RE      receive FIFO empty
.br
TB      transmit busy
.br

.br

.br
The following example shows how to configure the BSC peripheral as
an I2C slave with address 0x13 and send four bytes.

.br

.br
\fBExample\fP
.br

.EX
bsc_xfer_t xfer;
.br

.br
xfer.control = (0x13<<16) | 0x305;
.br

.br
memcpy(xfer.txBuf, "ABCD", 4);
.br
xfer.txCnt = 4;
.br

.br
status = bsc_xfer(pi, &xfer);
.br

.br
if (status >= 0)
.br
{
.br
   // process transfer
.br
}
.br

.EE

.br

.br
The BSC slave in SPI mode deserializes data from the MOSI pin into its
receiver/FIFO when the LSB of the first byte is a 0.  No data is output on
the MISO pin.  When the LSB of the first byte on MOSI is a 1, the
transmitter/FIFO data is serialized onto the MISO pin while all other data
on the MOSI pin is ignored.

.br

.br
The BK bit of the BSC control register is non-functional when in the SPI
mode.  The transmitter along with its FIFO can be dequeued by successively
disabling and re-enabling the TE bit on the BSC control register while in
SPI mode.

.IP "\fBint bsc_i2c(int pi, int i2c_addr, bsc_xfer_t *bscxfer)\fP"
.IP "" 4
This function allows the Pi to act as a slave I2C device.

.br

.br
This function is not available on the BCM2711 (e.g.as
used in the Pi4B).

.br

.br
The data bytes (if any) are written to the BSC transmit
FIFO and the bytes in the BSC receive FIFO are returned.

.br

.br

.EX
      pi: >=0 (as returned by \fBpigpio_start\fP).
.br
i2c_addr: 0-0x7F.
.br
 bscxfer: a structure defining the transfer.
.br

.br
typedef struct
.br
{
.br
   uint32_t control;          // N/A
.br
   int rxCnt;                 // Read only
.br
   char rxBuf[BSC_FIFO_SIZE]; // Read only
.br
   int txCnt;                 // Write
.br
   char txBuf[BSC_FIFO_SIZE]; // Write
.br
} bsc_xfer_t;
.br

.EE

.br

.br
txCnt is set to the number of bytes to be transmitted, possibly
zero. The data itself should be copied to txBuf.

.br

.br
Any received data will be written to rxBuf with rxCnt set.

.br

.br
See \fBbsc_xfer\fP for details of the returned status value.

.br

.br
If there was an error the status will be less than zero
(and will contain the error code).

.br

.br
Note that an i2c_address of 0 may be used to close
the BSC device and reassign the used GPIO as inputs.

.IP "\fBint event_callback(int pi, unsigned event, evtCBFunc_t f)\fP"
.IP "" 4
This function initialises an event callback.

.br

.br

.EX
   pi: >=0 (as returned by \fBpigpio_start\fP).
.br
event: 0-31.
.br
    f: the callback function.
.br

.EE

.br

.br
The function returns a callback id if OK, otherwise pigif_bad_malloc,
pigif_duplicate_callback, or pigif_bad_callback.

.br

.br
The callback is called with the event id, and tick, whenever the
event occurs.

.IP "\fBint event_callback_ex(int pi, unsigned event, evtCBFuncEx_t f, void *userdata)\fP"
.IP "" 4
This function initialises an event callback.

.br

.br

.EX
      pi: >=0 (as returned by \fBpigpio_start\fP).
.br
   event: 0-31.
.br
       f: the callback function.
.br
userdata: a pointer to arbitrary user data.
.br

.EE

.br

.br
The function returns a callback id if OK, otherwise pigif_bad_malloc,
pigif_duplicate_callback, or pigif_bad_callback.

.br

.br
The callback is called with the event id, the tick, and the userdata
pointer whenever the event occurs.

.IP "\fBint event_callback_cancel(unsigned callback_id)\fP"
.IP "" 4
This function cancels an event callback identified by its id.

.br

.br

.EX
callback_id: >=0, as returned by a call to \fBevent_callback\fP or
.br
\fBevent_callback_ex\fP.
.br

.EE

.br

.br
The function returns 0 if OK, otherwise pigif_callback_not_found.

.IP "\fBint wait_for_event(int pi, unsigned event, double timeout)\fP"
.IP "" 4
This function waits for an event for up to timeout seconds.

.br

.br

.EX
     pi: >=0 (as returned by \fBpigpio_start\fP).
.br
  event: 0-31.
.br
timeout: >=0.
.br

.EE

.br

.br
The function returns when the event occurs or after the timeout.

.br

.br
The function returns 1 if the event occurred, otherwise 0.

.IP "\fBint event_trigger(int pi, unsigned event)\fP"
.IP "" 4
This function signals the occurrence of an event.

.br

.br

.EX
   pi: >=0 (as returned by \fBpigpio_start\fP).
.br
event: 0-31.
.br

.EE

.br

.br
Returns 0 if OK, otherwise PI_BAD_EVENT_ID.

.br

.br
An event is a signal used to inform one or more consumers
to start an action.  Each consumer which has registered an interest
in the event (e.g. by calling \fBevent_callback\fP) will be informed by
a callback.

.br

.br
One event, PI_EVENT_BSC (31) is predefined.  This event is
auto generated on BSC slave activity.

.br

.br
The meaning of other events is arbitrary.

.br

.br
Note that other than its id and its tick there is no data associated
with an event.
.SH PARAMETERS

.br

.br

.IP "\fBactive\fP: 0-1000000" 0

.br

.br
The number of microseconds level changes are reported for once
a noise filter has been triggered (by \fBsteady\fP microseconds of
a stable level).

.br

.br

.IP "\fB*addrStr\fP" 0
A string specifying the host or IP address of the Pi running
the pigpio daemon.  It may be NULL in which case localhost
is used unless overridden by the PIGPIO_ADDR environment
variable.

.br

.br

.IP "\fBarg1\fP" 0
An unsigned argument passed to a user customised function.  Its
meaning is defined by the customiser.

.br

.br

.IP "\fBarg2\fP" 0
An unsigned argument passed to a user customised function.  Its
meaning is defined by the customiser.

.br

.br

.IP "\fBargc\fP" 0
The count of bytes passed to a user customised function.

.br

.br

.IP "\fB*argx\fP" 0
A pointer to an array of bytes passed to a user customised function.
Its meaning and content is defined by the customiser.

.br

.br

.IP "\fBbaud\fP" 0
The speed of serial communication (I2C, SPI, serial link, waves) in
bits per second.

.br

.br

.IP "\fBbit\fP" 0
A value of 0 or 1.

.br

.br

.IP "\fBbits\fP" 0
A value used to select GPIO.  If bit n of bits is set then GPIO n is
selected.

.br

.br
A convenient way to set bit n is to or in (1<<n).

.br

.br
e.g. to select bits 5, 9, 23 you could use (1<<5) | (1<<9) | (1<<23).

.br

.br

.IP "\fBbsc_xfer_t\fP" 0

.br

.br

.EX
typedef struct
.br
{
.br
   uint32_t control;          // Write
.br
   int rxCnt;                 // Read only
.br
   char rxBuf[BSC_FIFO_SIZE]; // Read only
.br
   int txCnt;                 // Write
.br
   char txBuf[BSC_FIFO_SIZE]; // Write
.br
} bsc_xfer_t;
.br

.EE

.br

.br

.IP "\fB*bscxfer\fP" 0
A pointer to a \fBbsc_xfer_t\fP object used to control a BSC transfer.

.br

.br

.IP "\fB*buf\fP" 0
A buffer to hold data being sent or being received.

.br

.br

.IP "\fBbufSize\fP" 0
The size in bytes of a buffer.

.br

.br

.br

.br

.IP "\fBbVal\fP: 0-255 (Hex 0x0-0xFF, Octal 0-0377)" 0
An 8-bit byte value.

.br

.br

.IP "\fBcallback_id\fP" 0
A value >=0, as returned by a call to a callback function, one of

.br

.br
\fBcallback\fP
.br
\fBcallback_ex\fP
.br
\fBevent_callback\fP
.br
\fBevent_callback_ex\fP

.br

.br
The id is passed to \fBcallback_cancel\fP or \fBevent_callback_cancel\fP
to cancel the callback.

.br

.br

.IP "\fBCBFunc_t\fP" 0

.EX
typedef void (*CBFunc_t)
.br
   (int pi, unsigned user_gpio, unsigned level, uint32_t tick);
.br

.EE

.br

.br

.IP "\fBCBFuncEx_t\fP" 0

.EX
typedef void (*CBFuncEx_t)
.br
   (int pi, unsigned user_gpio, unsigned level, uint32_t tick, void * userdata);
.br

.EE

.br

.br

.IP "\fBchar\fP" 0
A single character, an 8 bit quantity able to store 0-255.

.br

.br

.IP "\fBclkfreq\fP: 4689-250M (13184-375M for the BCM2711)" 0
The hardware clock frequency.

.br

.br

.IP "\fBcount\fP" 0
The number of bytes to be transferred in a file, I2C, SPI, or serial
command.

.br

.br

.IP "\fBCS\fP" 0
The GPIO used for the slave select signal when bit banging SPI.

.br

.br

.IP "\fBdata_bits\fP: 1-32" 0
The number of data bits in each character of serial data.

.br

.br

.EX
#define PI_MIN_WAVE_DATABITS 1
.br
#define PI_MAX_WAVE_DATABITS 32
.br

.EE

.br

.br

.IP "\fBdouble\fP" 0
A floating point number.

.br

.br

.IP "\fBdutycycle\fP: 0-range" 0
A number representing the ratio of on time to off time for PWM.

.br

.br
The number may vary between 0 and range (default 255) where
0 is off and range is fully on.

.br

.br

.IP "\fBedge\fP" 0
Used to identify a GPIO level transition of interest.  A rising edge is
a level change from 0 to 1.  A falling edge is a level change from 1 to 0.

.br

.br

.EX
RISING_EDGE  0
.br
FALLING_EDGE 1
.br
EITHER_EDGE. 2
.br

.EE

.br

.br

.IP "\fBerrnum\fP" 0
A negative number indicating a function call failed and the nature
of the error.

.br

.br

.IP "\fBevent\fP: 0-31" 0
An event is a signal used to inform one or more consumers
to start an action.

.br

.br

.IP "\fBevtCBFunc_t\fP" 0

.br

.br

.EX
typedef void (*evtCBFunc_t)
.br
   (int pi, unsigned event, uint32_t tick);
.br

.EE

.br

.br

.IP "\fBevtCBFuncEx_t\fP" 0

.br

.br

.EX
typedef void (*evtCBFuncEx_t)
.br
   (int pi, unsigned event, uint32_t tick, void *userdata);
.br

.EE

.br

.br

.IP "\fBf\fP" 0
A function.

.br

.br

.IP "\fB*file\fP" 0
A full file path.  To be accessible the path must match an entry in
/opt/pigpio/access.

.br

.br

.IP "\fB*fpat\fP" 0
A file path which may contain wildcards.  To be accessible the path
must match an entry in /opt/pigpio/access.

.br

.br

.IP "\fBfrequency\fP: >=0" 0
The number of times a GPIO is swiched on and off per second.  This
can be set per GPIO and may be as little as 5Hz or as much as
40KHz.  The GPIO will be on for a proportion of the time as defined
by its dutycycle.

.br

.br

.IP "\fBgpio\fP" 0
A Broadcom numbered GPIO, in the range 0-53.

.br

.br
There  are 54 General Purpose Input Outputs (GPIO) named GPIO0 through
GPIO53.

.br

.br
They are split into two  banks.   Bank  1  consists  of  GPIO0  through
GPIO31.  Bank 2 consists of GPIO32 through GPIO53.

.br

.br
All the GPIO which are safe for the user to read and write are in
bank 1.  Not all GPIO in bank 1 are safe though.  Type 1 boards
have 17  safe GPIO.  Type 2 boards have 21.  Type 3 boards have 26.

.br

.br
See \fBget_hardware_revision\fP.

.br

.br
The user GPIO are marked with an X in the following table.

.br

.br

.EX
          0  1  2  3  4  5  6  7  8  9 10 11 12 13 14 15
.br
Type 1    X  X  -  -  X  -  -  X  X  X  X  X  -  -  X  X
.br
Type 2    -  -  X  X  X  -  -  X  X  X  X  X  -  -  X  X
.br
Type 3          X  X  X  X  X  X  X  X  X  X  X  X  X  X
.br

.br
         16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
.br
Type 1    -  X  X  -  -  X  X  X  X  X  -  -  -  -  -  -
.br
Type 2    -  X  X  -  -  -  X  X  X  X  -  X  X  X  X  X
.br
Type 3    X  X  X  X  X  X  X  X  X  X  X  X  -  -  -  -
.br

.EE

.br

.br

.IP "\fBgpioPulse_t\fP" 0

.EX
typedef struct
.br
{
.br
   uint32_t gpioOn;
.br
   uint32_t gpioOff;
.br
   uint32_t usDelay;
.br
} gpioPulse_t;
.br

.EE

.br

.br

.IP "\fBgpioThreadFunc_t\fP" 0

.EX
typedef void *(gpioThreadFunc_t) (void *);
.br

.EE

.br

.br

.IP "\fBhandle\fP: >=0" 0
A number referencing an object opened by one of

.br

.br
\fBfile_open\fP
.br
\fBi2c_open\fP
.br
\fBnotify_open\fP
.br
\fBserial_open\fP
.br
\fBspi_open\fP

.br

.br

.IP "\fBi2c_addr\fP: 0-0x7F" 0
The address of a device on the I2C bus.

.br

.br

.IP "\fBi2c_bus\fP: >=0" 0
An I2C bus number.

.br

.br

.IP "\fBi2c_flags\fP: 0" 0
Flags which modify an I2C open command.  None are currently defined.

.br

.br

.IP "\fBi2c_reg\fP: 0-255" 0
A register of an I2C device.

.br

.br

.IP "\fB*inBuf\fP" 0
A buffer used to pass data to a function.

.br

.br

.IP "\fBinLen\fP" 0
The number of bytes of data in a buffer.

.br

.br

.IP "\fBint\fP" 0
A whole number, negative or positive.

.br

.br

.IP "\fBint32_t\fP" 0
A 32-bit signed value.

.br

.br

.IP "\fBinvert\fP" 0
A flag used to set normal or inverted bit bang serial data level logic.

.br

.br

.IP "\fBlevel\fP" 0
The level of a GPIO.  Low or High.

.br

.br

.EX
PI_OFF 0
.br
PI_ON 1
.br

.br
PI_CLEAR 0
.br
PI_SET 1
.br

.br
PI_LOW 0
.br
PI_HIGH 1
.br

.EE

.br

.br
There is one exception.  If a watchdog expires on a GPIO the level will be
reported as PI_TIMEOUT.  See \fBset_watchdog\fP.

.br

.br

.EX
PI_TIMEOUT 2
.br

.EE

.br

.br

.IP "\fBMISO\fP" 0
The GPIO used for the MISO signal when bit banging SPI.

.br

.br

.IP "\fBmode\fP" 0
1. The operational mode of a GPIO, normally INPUT or OUTPUT.

.br

.br

.EX
PI_INPUT 0
.br
PI_OUTPUT 1
.br
PI_ALT0 4
.br
PI_ALT1 5
.br
PI_ALT2 6
.br
PI_ALT3 7
.br
PI_ALT4 3
.br
PI_ALT5 2
.br

.EE

.br

.br
2. The mode of waveform transmission.

.br

.br

.EX
PI_WAVE_MODE_ONE_SHOT      0
.br
PI_WAVE_MODE_REPEAT        1
.br
PI_WAVE_MODE_ONE_SHOT_SYNC 2
.br
PI_WAVE_MODE_REPEAT_SYNC   3
.br

.EE

.br

.br
3. A file open mode.

.br

.br

.EX
PI_FILE_READ  1
.br
PI_FILE_WRITE 2
.br
PI_FILE_RW    3
.br

.EE

.br

.br
The following values can be or'd into the mode.

.br

.br

.EX
PI_FILE_APPEND 4
.br
PI_FILE_CREATE 8
.br
PI_FILE_TRUNC  16
.br

.EE

.br

.br

.IP "\fBMOSI\fP" 0
The GPIO used for the MOSI signal when bit banging SPI.

.br

.br

.IP "\fBnumBytes\fP" 0
The number of bytes used to store characters in a string.  Depending
on the number of bits per character there may be 1, 2, or 4 bytes
per character.

.br

.br

.IP "\fBnumPar\fP: 0-10" 0
The number of parameters passed to a script.

.br

.br

.IP "\fBnumPulses\fP" 0
The number of pulses to be added to a waveform.

.br

.br

.IP "\fBoffset\fP" 0
The associated data starts this number of microseconds from the start of
the waveform.

.br

.br

.IP "\fB*outBuf\fP" 0
A buffer used to return data from a function.

.br

.br

.IP "\fBoutLen\fP" 0
The size in bytes of an output buffer.

.br

.br

.IP "\fBpad\fP: 0-2" 0
A set of GPIO which share common drivers.

.br

.br
Pad   GPIO
.br
0     0-27
.br
1     28-45
.br
2     46-53
.br

.br

.br

.IP "\fBpadStrength\fP: 1-16" 0
The mA which may be drawn from each GPIO whilst still guaranteeing the
high and low levels.

.br

.br

.IP "\fB*param\fP" 0
An array of script parameters.

.br

.br

.IP "\fBpercent\fP: 0-100" 0
The size of waveform as percentage of maximum available.

.br

.br

.IP "\fBpi\fP" 0
An integer defining a connected Pi.  The value is returned by
\fBpigpio_start\fP upon success.

.br

.br

.IP "\fB*portStr\fP" 0
A string specifying the port address used by the Pi running
the pigpio daemon.  It may be NULL in which case "8888"
is used unless overridden by the PIGPIO_PORT environment
variable.

.br

.br

.IP "\fB*pth\fP" 0
A thread identifier, returned by \fBstart_thread\fP.

.br

.br

.br

.br

.IP "\fBpthread_t\fP" 0
A thread identifier.

.br

.br

.IP "\fBpud\fP: 0-2" 0
The setting of the pull up/down resistor for a GPIO, which may be off,
pull-up, or pull-down.

.EX
PI_PUD_OFF 0
.br
PI_PUD_DOWN 1
.br
PI_PUD_UP 2
.br

.EE

.br

.br

.IP "\fBpulseLen\fP" 0
1-100, the length of a trigger pulse in microseconds.

.br

.br

.IP "\fB*pulses\fP" 0
An array of pulses to be added to a waveform.

.br

.br

.IP "\fBpulsewidth\fP: 0, 500-2500" 0

.EX
PI_SERVO_OFF 0
.br
PI_MIN_SERVO_PULSEWIDTH 500
.br
PI_MAX_SERVO_PULSEWIDTH 2500
.br

.EE

.br

.br

.IP "\fBPWMduty\fP: 0-1000000 (1M)" 0
The hardware PWM dutycycle.

.br

.br

.EX
#define PI_HW_PWM_RANGE 1000000
.br

.EE

.br

.br

.IP "\fBPWMfreq\fP: 1-125M (1-187.5M for the BCM2711)" 0
The hardware PWM frequency.

.br

.br

.EX
#define PI_HW_PWM_MIN_FREQ 1
.br
#define PI_HW_PWM_MAX_FREQ 125000000
.br
#define PI_HW_PWM_MAX_FREQ_2711 187500000
.br

.EE

.br

.br

.IP "\fBrange\fP: 25-40000" 0
The permissible dutycycle values are 0-range.

.br

.br

.EX
PI_MIN_DUTYCYCLE_RANGE 25
.br
PI_MAX_DUTYCYCLE_RANGE 40000
.br

.EE

.br

.br

.IP "\fB*retBuf\fP" 0
A buffer to hold a number of bytes returned to a used customised function,

.br

.br

.IP "\fBretMax\fP" 0
The maximum number of bytes a user customised function should return.

.br

.br

.br

.br

.IP "\fB*rxBuf\fP" 0
A pointer to a buffer to receive data.

.br

.br

.IP "\fBSCL\fP" 0
The user GPIO to use for the clock when bit banging I2C.

.br

.br

.IP "\fBSCLK\fP" 0
The GPIO used for the SCLK signal when bit banging SPI.

.br

.br

.IP "\fB*script\fP" 0
A pointer to the text of a script.

.br

.br

.IP "\fBscript_id\fP" 0
An id of a stored script as returned by \fBstore_script\fP.

.br

.br

.IP "\fB*scriptName\fP" 0
The name of a \fBshell_\fP script to be executed.  The script must be present in
/opt/pigpio/cgi and must have execute permission.

.br

.br

.IP "\fB*scriptString\fP" 0
The string to be passed to a \fBshell_\fP script to be executed.

.br

.br

.IP "\fBSDA\fP" 0
The user GPIO to use for data when bit banging I2C.

.br

.br

.IP "\fBseconds\fP" 0
The number of seconds.

.br

.br

.IP "\fBseekFrom\fP" 0

.br

.br

.EX
PI_FROM_START   0
.br
PI_FROM_CURRENT 1
.br
PI_FROM_END     2
.br

.EE

.br

.br

.IP "\fBseekOffset\fP" 0
The number of bytes to move forward (positive) or backwards (negative)
from the seek position (start, current, or end of file).

.br

.br

.IP "\fBser_flags\fP" 0
Flags which modify a serial open command.  None are currently defined.

.br

.br

.IP "\fB*ser_tty\fP" 0
The name of a serial tty device, e.g. /dev/ttyAMA0, /dev/ttyUSB0, /dev/tty1.

.br

.br

.IP "\fBsize_t\fP" 0
A standard type used to indicate the size of an object in bytes.

.br

.br

.IP "\fBspi_channel\fP" 0
A SPI channel, 0-2.

.br

.br

.IP "\fBspi_flags\fP" 0
See \fBspi_open\fP and \fBbb_spi_open\fP.

.br

.br

.IP "\fBsteady\fP: 0-300000" 0

.br

.br
The number of microseconds level changes must be stable for
before reporting the level changed (\fBset_glitch_filter\fP) or triggering
the active part of a noise filter (\fBset_noise_filter\fP).

.br

.br

.IP "\fBstop_bits\fP: 2-8" 0
The number of (half) stop bits to be used when adding serial data
to a waveform.

.br

.br

.EX
#define PI_MIN_WAVE_HALFSTOPBITS 2
.br
#define PI_MAX_WAVE_HALFSTOPBITS 8
.br

.EE

.br

.br

.IP "\fB*str\fP" 0
 An array of characters.

.br

.br

.IP "\fBthread_func\fP" 0
A function of type gpioThreadFunc_t used as the main function of a
thread.

.br

.br

.IP "\fBtimeout\fP" 0
A GPIO watchdog timeout in milliseconds.

.br

.br

.EX
PI_MIN_WDOG_TIMEOUT 0
.br
PI_MAX_WDOG_TIMEOUT 60000
.br

.EE

.br

.br

.IP "\fB*txBuf\fP" 0
An array of bytes to transmit.

.br

.br

.IP "\fBuint32_t\fP: 0-0-4,294,967,295 (Hex 0x0-0xFFFFFFFF)" 0
A 32-bit unsigned value.

.br

.br

.IP "\fBunsigned\fP" 0
A whole number >= 0.

.br

.br

.IP "\fBuser_gpio\fP" 0
0-31, a Broadcom numbered GPIO.

.br

.br
See \fBgpio\fP.

.br

.br

.IP "\fB*userdata\fP" 0

.br

.br
A pointer to arbitrary user data.  This may be used to identify the instance.

.br

.br
You must ensure that the pointer is in scope at the time it is processed.  If
it is a pointer to a global this is automatic.  Do not pass the address of a
local variable.  If you want to pass a transient object then use the
following technique.

.br

.br
In the calling function:

.br

.br

.EX
user_type *userdata;
.br
.br
.br
user_type my_userdata;
.br

.br
userdata = malloc(sizeof(user_type));
.br
.br
.br
*userdata = my_userdata;
.br

.EE

.br

.br
In the receiving function:

.br

.br

.EX
user_type my_userdata = *(user_type*)userdata;
.br

.br
free(userdata);
.br

.EE

.br

.br

.IP "\fBvoid\fP" 0
Denoting no parameter is required

.br

.br

.IP "\fBwave_add_*\fP" 0
One of

.br

.br
\fBwave_add_new\fP
.br
\fBwave_add_generic\fP
.br
\fBwave_add_serial\fP

.br

.br

.IP "\fBwave_id\fP" 0
A number representing a waveform created by \fBwave_create\fP.

.br

.br

.IP "\fBwave_send_*\fP" 0
One of

.br

.br
\fBwave_send_once\fP
.br
\fBwave_send_repeat\fP

.br

.br

.IP "\fBwVal\fP: 0-65535 (Hex 0x0-0xFFFF, Octal 0-0177777)" 0
A 16-bit word value.

.br

.br
.SH pigpiod_if2 Error Codes

.EX

.br
typedef enum
.br
{
.br
   pigif_bad_send           = -2000,
.br
   pigif_bad_recv           = -2001,
.br
   pigif_bad_getaddrinfo    = -2002,
.br
   pigif_bad_connect        = -2003,
.br
   pigif_bad_socket         = -2004,
.br
   pigif_bad_noib           = -2005,
.br
   pigif_duplicate_callback = -2006,
.br
   pigif_bad_malloc         = -2007,
.br
   pigif_bad_callback       = -2008,
.br
   pigif_notify_failed      = -2009,
.br
   pigif_callback_not_found = -2010,
.br
   pigif_unconnected_pi     = -2011,
.br
   pigif_too_many_pis       = -2012,
.br
} pigifError_t;
.br

.br

.EE

.SH SEE ALSO

pigpiod(1), pig2vcd(1), pigs(1), pigpio(3), pigpiod_if(3)
.SH AUTHOR

joan@abyz.me.uk