Modbus C API

The public C API of Modbus.

All kindsEnumEnumeratorFunctionTypedef22 symbols

• PDCOMM_MODBUS_ASCII Enumerator — Modbus ASCII over a serial line (Modbus over Serial Line specification).
• PDCOMM_MODBUS_BUFFER_TOO_SMALL Enumerator — The output capacity is smaller than the data. The required size is reported and the output is unchanged.
• PDCOMM_MODBUS_INTERNAL_ERROR Enumerator — An internal failure, such as a contained panic or a poisoned endpoint lock. Release the endpoint and create a new one.
• PDCOMM_MODBUS_INVALID_HANDLE Enumerator — The handle is zero, released, unknown or of the wrong kind.
• PDCOMM_MODBUS_INVALID_INPUT Enumerator — A pointer, size or JSON document is invalid; nothing was changed.
• PDCOMM_MODBUS_OK Enumerator — The call succeeded.
• PDCOMM_MODBUS_RTU Enumerator — Modbus RTU over a serial line (Modbus over Serial Line specification).
• PDCOMM_MODBUS_SECURITY Enumerator — Modbus/TCP Security: TLS with X.509 certificates and role-based authorization.
• PDCOMM_MODBUS_SERVICE_ERROR Enumerator — The command ran and failed, for example with a timeout, a refused connection or an invalid configuration. An owned error buffer is returned.
• PDCOMM_MODBUS_TCP Enumerator — Modbus TCP (MBAP header over TCP), client, server and gateway listener.
• pdcomm_modbus_abi_version Function — Returns the ABI version of the loaded library.
• pdcomm_modbus_buffer_copy Function — Copies a JSON reply buffer as UTF-8 without a terminator.
• pdcomm_modbus_call Function — Runs one JSON command on an endpoint and returns the JSON reply.
• pdcomm_modbus_capabilities Function — Returns the features compiled into the loaded library.
• pdcomm_modbus_capability Enum — Feature bits reported by pdcomm_modbus_capabilities().
• pdcomm_modbus_endpoint_create Function — Creates a disconnected endpoint with the default configuration.
• pdcomm_modbus_handle Typedef — Opaque, library-local handle of an endpoint or a JSON buffer.
• pdcomm_modbus_logging_configure Function — Configures the optional diagnostic log of this library.
• pdcomm_modbus_logging_flush Function — Waits until queued log records are written to the sink.
• pdcomm_modbus_logging_status Function — Copies the diagnostic log status as UTF-8 JSON without a terminator.
• pdcomm_modbus_release Function — Releases an endpoint or a JSON buffer.
• pdcomm_modbus_status Enum — Status code returned by every int32_t Modbus C ABI function.