File List

Here is a list of all documented files with brief descriptions:

shstk
pip
libs
fftw
pifft_p.h	Class for FFT, IFFT and Hilbert transformations
main
application
piapplicationmodule.h	Application-level classes
picli.h	Command-line argument parser
pilog.h	High-level log
pisingleapplication.h	Single-instance application control
pisystemmonitor.h	System resources monitoring
pitranslator.h	Translation support
client_server
piclientserver_client.h	Client-side and server-side client connection classes
piclientserver_client_base.h	Base class for client-server communication Provides base functionality for client-server communication with diagnostics support
piclientserver_server.h	TCP Server
piclientservermodule.h	Umbrella header and module group for TCP client-server helpers
cloud
picloudbase.h	Base class for PICloudClient and PICloudServer
picloudclient.h	Client-side PICloud device for one named server
picloudmodule.h	Umbrella header for the PICloud module
picloudserver.h	Server-side PICloud device for one named endpoint
picloudtcp.h	Low-level TCP framing helpers for PICloud
code
picodeinfo.h	C++ code info structs. See Code generation
picodemodule.h	Umbrella header for the code parsing module
picodeparser.h	C++ code parser
compress
picompress.h	Compress class zlib
console
piconsolemodule.h	Console module headers
pikbdlistener.h	Console keyboard and mouse input listener
piscreen.h	Console screen manager and tile host
piscreendrawer.h	Drawing helpers for PIScreen cell buffers
piscreentile.h	Basic PIScreen tile
piscreentiles.h	Various tiles for PIScreen Provides ready-to-use tile implementations for common UI elements
piscreentypes.h	Types for PIScreen Provides common types used by screen tiles and drawer
piterminal.h	Virtual terminal
containers
picontainers.h	Base macros for generic containers
picontainersmodule.h	Umbrella header for the Containers module
pideque.h	Declares PIDeque
pimap.h	Declares PIMap
pipair.h	Declares PIPair
piqueue.h	Declares PIQueue
piset.h	Declares PISet
pistack.h	Declares PIStack
pivector.h	Declares PIVector
pivector2d.h	Declares PIVector2D
core
pibase.h	Base types and functionsThis file implements first layer above the system and declares some basic useful functions
pibase_macros.h	Base macrosThis file declares basic useful macros for the PIP library including platform detection, compiler-specific configurations, and utility macros for private data handling
picollection.h	Unique classes collection Helper module to collect and retrieve classes into groups using macros for automatic registration
picoremodule.h	Umbrella header for the Core module
picout.h	Universal output to console class
piincludes.h	Core includes and low-level helper functions
piinit.h	Library initialization This file provides initialization and build information for the PIP library
pimemoryblock.h	Memory block helper struct for data storage and binary stream operations The PIMemoryBlock struct provides a lightweight wrapper to store and restore custom blocks of data to/from PIBinaryStream. It holds a pointer to data and its size in bytes
piobject.h	Base object class providing event -> handler mechanism
piobject_macros.h	PIObject macros for event system and object introspection
crypt
piauth.h	Authentication API
picrypt.h	Cryptographic using libsodium
picryptmodule.h	Umbrella header for the Crypt module
digest
pidigest.h	Digest calculation helpers
geo
piellipsoidmodel.h	Geographical ellipsoid Earth models
pigeomodule.h	Entry header for the Geo module
pigeoposition.h	Class for geo position storage and conversions
http_client
pihttpclient.h	Public HTTP client request API
pihttpclientmodule.h	HTTP client module includes for PIP libraryThis file includes all HTTP client module headers providing async HTTP client functionality using libcurl for performing HTTP requests with callbacks
http_common
pihttpconstants.h	HTTP constants and enumerations Definitions for HTTP methods, status codes and header names Provides enum classes for HTTP methods and status codes, and a namespace with HTTP header name constants
pihttptypes.h	Shared HTTP message container types
piserverendpoint_p.h	Shared HTTP message container types
http_server
microhttpd_server.h	Base HTTP server API built on top of libmicrohttpd
pihttpserver.h	High-level HTTP server implementation High-level HTTP server with path-based routing and handler registration
pihttpservermodule.h	Module include for the public HTTP server API
introspection
piintrospection_base.h	Base declarations for the introspection subsystem
piintrospection_containers.h	Container introspection helpers
piintrospection_server.h	Introspection server
piintrospection_threads.h	Thread introspection helpers
io_devices
pibinarylog.h	Binary log
pican.h	CAN bus device wrapper
piconfig.h	Configuration files parser and writer
pidir.h	Local directory
piethernet.h	Ethernet-backed UDP and TCP device
pifile.h	Local file
pigpio.h	GPIO support
piiobytearray.h	PIIODevice wrapper around PIByteArray
piiodevice.h	Core abstraction for configurable input/output devices
piiodevicesmodule.h	Umbrella include for common IO device headers
piiostream.h	Text and binary stream adapters for PIIODevice
piiostring.h	PIIODevice wrapper around PIString
pipeer.h	Peer-to-peer network node
piserial.h	Serial device
pisharedmemory.h	Shared memory
pispi.h	SPI device wrapper
pitransparentdevice.h	PIIODevice that pass write to read
piusb.h	USB input/output device declarations
io_utils
pibasetransfer.h	Base class for reliable packet sessions with acknowledgements, pause and resume
pibroadcast.h	Multi-interface UDP broadcast, multicast and loopback helper
piconnection.h	Connection routing helper built on shared devices and packet filters
pidatatransfer.h	Class for send and receive PIByteArray via PIBaseTransfer
pidiagnostics.h	Connection quality diagnostics
piethutilbase.h	Base helper for optional crypt layer in IO-Utils transports
pifiletransfer.h	Class for sending and receiving files and directories via PIBaseTransfer
piioutilsmodule.h	Public include header for the IO-Utils module
pipackedtcp.h	Packet-oriented TCP device built on top of PIStreamPacker
pipacketextractor.h	Packet extraction helper for byte-stream devices
piparsehelper.h	Key-dispatch helper for deserializing packets into callbacks
pistreampacker.h	Packet framing helper for byte-stream devices
literals
piliterals.h	C++11 user-defined literals C++11 user-defined literals for PIP library typesIncludes all literals_*.h files providing user-defined literals (UDL) for:
piliterals_bytearray.h	PIByteArray literal operators
piliterals_bytes.h	Byte-size literal operators
piliterals_regularexpression.h	PIRegularExpression literal operators
piliterals_string.h	PIString literal operators
piliterals_time.h	PISystemTime and frequency literal operators
lua
piluaprogram.h	Lua Program
pip_lua.h	Conversions between PIP types and LuaBridge
math
picrc.h	CRC checksum calculation
pievaluator.h	Mathematical expression evaluator
pifft.h	FFT, IFFT and Hilbert transformations
pigeometry.h	Convenience header for basic geometry types
piline.h	Two-dimensional line segment type
pimathbase.h	Basic mathematical constants and helper algorithms
pimathcomplex.h	Complex numbers
pimathmatrix.h	Math matrix
pimathmodule.h	Math module umbrella header
pimathsolver.h	Transfer-function-based differential solver
pimathvector.h	Math vector
pipoint.h	The PIPoint class provides a two-dimensional point on the plane
piquaternion.h	Quaternion
pirect.h	Rect class for 2D geometry
pistatistic.h	Calculating math statistic of values array
mqtt_client
pimqttclient.h
mqtt_common
pimqtttypes.h
opencl
piopencl.h	OpenCL wrapper classes
resources
piresources.h	Resources subsystem
piresourcesstorage.h	Storage for compiled resources
serialization
pibinarystream.h	Binary serialization interface
pichunkstream.h	Binary markup de/serializator stream
pijson.h	JSON tree node type
pijsonserialization.h	Generic JSON serialization helpersThis file provides template functions for serializing and deserializing various types to and from PIJSON format
piserializationmodule.h	Serialization module include header
pivaluetree_conversions.h	PIValueTree conversion helpers
state_machine
pistatemachine.h	State machine. Main state machine class that manages states and transitions. Thread-safe implementation with nested post handling
pistatemachine_base.h	Declares helper types shared by the state machine API
pistatemachine_state.h	Declares states used by PIStateMachine
pistatemachine_transition.h	Declares transitions used by PIStateMachine
pistatemachinemodule.h	Declares module entry includes for the state machine API
system
pihidevice.h	HID device
pilibrary.h	Run-time library
piplugin.h	Plugin control
piprocess.h	External process
pisignals.h	System signals
pisysteminfo.h	System information
pisystemmodule.h	Umbrella header for the system module
pisystemtests.h	System timing calibration values
text
pichar.h	UTF-16 character type
piconstchars.h	C-String class
piregularexpression.h	Regular expression
pistring.h	String class
pistring_std.h	Standard library conversions for PIString
pistringlist.h	Based on PIDeque<PIString> strings list
pitextmodule.h	Umbrella header for the text module
pitextstream.h	Text serialization functionality over PIBinaryStream
thread
piblockingqueue.h	Blocking queue template
piconditionvar.h	Condition variable for waiting and notification between threads
pigrabberbase.h	Grabber thread base class
pimutex.h	Basic interthread lock
pipipelinethread.h	Thread-based pipeline for multi-stage data processing
piprotectedvariable.h	Thread-safe variable
pireadwritelock.h	Read-write lock with multiple readers or one writer
pisemaphore.h	Counting semaphore for shared resources
pispinlock.h	Spinlock with busy waiting
pithread.h	Runtime thread object with optional loop execution
pithreadmodule.h	Umbrella header for the thread module
pithreadnotifier.h	Counting notification helper for coordination between threads
pithreadpoolloop.h	Parallel loop helper
pithreadpoolworker.h	Thread pool worker
pitimer.h	Timer object backed by an internal thread
types
pibitarray.h	Packed bit array
pibytearray.h	Byte array
pidatetime.h	Time and date structs
piflags.h	General flags class
pinetworkaddress.h	Network address
pipropertystorage.h	Properties array
pisystemtime.h	System time structs and methods
pitime.h	System time, time and date
pitime_win.h	PITime conversions for Windows This file provides conversion functions between Windows time structures (FILETIME, SYSTEMTIME) and PIP time structures (PISystemTime, PIDateTime)
pitypesmodule.h	Convenience includes for the Types module
pivaluetree.h	Attributed values tree
pivariant.h	Variant type
pivariantsimple.h	Simple variant type
pivarianttypes.h	Types for PIVariant
units
piunits.h	Umbrella header for the public unit conversion API
piunits_base.h	Shared unit conversion infrastructure
piunits_class_angle.h	Angle unit family descriptor
piunits_class_distance.h	Distance unit family descriptor
piunits_class_information.h	Information unit family descriptor
piunits_class_mass.h	Mass unit family descriptor
piunits_class_pressure.h	Pressure unit family descriptor
piunits_class_temperature.h	Temperature unit family descriptor
piunits_class_time.h	Time and frequency unit family descriptor
piunits_prefix.h	Unit prefixes
piunits_value.h	Typed unit value
pip.h	Umbrella include for the public PIP API
piplatform.h	Public platform and compiler detection macros