Embedded Systems C Bridge API - Versionsgeschichte

Cg: /* Introduction */

2026-04-16T13:31:36Z

Introduction

← Nächstältere Version		Version vom 16. April 2026, 13:31 Uhr
Zeile 2:		Zeile 2:

	This document is for developers who need to port the cBridge code and embed it into systems for which no ready to use executable or library is provided by exept. It is not needed when using the cBridge with linux or windows systems.		This document is for developers who need to port the cBridge code and embed it into systems for which no ready to use executable or library is provided by exept. It is not needed when using the cBridge with linux or windows systems.


			See the [[Expecco_API/en#Bridged_C_Elementary_Blocks \| elementary C-action block documentation]] for the API provided to bridged C code.

	== Embedded Systems C Bridge API ==		== Embedded Systems C Bridge API ==

Cg: /* Embedded Systems C Bridge API */

2026-04-16T13:24:47Z

Embedded Systems C Bridge API

← Nächstältere Version		Version vom 16. April 2026, 13:24 Uhr
Zeile 1:		Zeile 1:
			== Introduction ==

			This document is for developers who need to port the cBridge code and embed it into systems for which no ready to use executable or library is provided by exept. It is not needed when using the cBridge with linux or windows systems.

	== Embedded Systems C Bridge API ==		== Embedded Systems C Bridge API ==

Cg: /* Architecture */

2026-04-16T12:28:21Z

Architecture

← Nächstältere Version		Version vom 16. April 2026, 12:28 Uhr
Zeile 13:		Zeile 13:
	== Architecture ==		== Architecture ==

	The CBridge opens a socket and listens for an incoming connection. Only one such connection may be active at any time (per bridge). If multiple bridges are to be used on the same host machine, each must use a different port number, which will typically be passed via a command line argument or via a configuration setting inside the target.		The CBridge opens a socket and listens for an incoming connection (or is configured to communicate via a serial com port). Only one such connection may be active at any time (per bridge). If multiple bridges are to be used on the same host machine, each must use a different port number, which will typically be passed via a command line argument or via a configuration setting inside the target.

	Expecco will connect to a bridge, given hostname and port. For the implicit default bridge, expecco uses "localhost:8855". Once connected, expecco will send requests and receive responses, which are exchanged in human readable JSON format, which is similar to the ChromeV8 debug or VSCode debug interface message format.		Expecco will connect to a bridge, given hostname and port. For the implicit default bridge, expecco uses "localhost:8855". Once connected, expecco will send requests and receive responses, which are exchanged in human readable JSON format, which is similar to the ChromeV8 debug or VSCode debug interface message format.
Zeile 20:		Zeile 20:

	The bridge code as provided by exept includes handlers for various common tasks, which can be registered as option.		The bridge code as provided by exept includes handlers for various common tasks, which can be registered as option.
	~~Except~~ also provides a ready-to-run cBridge executable, which is configured to register handlers for remote code execution (i.e. for ''Bridged C Actions'').		Exept also provides a ready-to-run cBridge executable, which is configured to register handlers for remote code execution (i.e. for ''Bridged C Actions'').

	As an alternative to using the exept library, customers can also implement the wire protocol, which is described below.		As an alternative to using the exept library, customers can also implement the wire protocol, which is described below.

Cg: /* Embedded Systems C Bridge API */

2026-04-16T12:25:57Z

Embedded Systems C Bridge API

← Nächstältere Version		Version vom 16. April 2026, 12:25 Uhr
Zeile 8:		Zeile 8:

	The protocol as described here is also used for Python, Node, Ruby and Smalltalk bridges and also the newer versions of the Qt bridge.		The protocol as described here is also used for Python, Node, Ruby and Smalltalk bridges and also the newer versions of the Qt bridge.

	The ~~bridge~~ can communicate either via a Socket or a serial connection.		The CBridge can communicate either via a Socket or a serial connection.

	== Architecture ==		== Architecture ==

Cg: /* Embedded Systems C Bridge API */

2026-04-16T12:25:22Z

Embedded Systems C Bridge API

← Nächstältere Version		Version vom 16. April 2026, 12:25 Uhr
Zeile 1:		Zeile 1:
	== Embedded Systems C Bridge API ==		== Embedded Systems C Bridge API ==

	We provide the CBridge code both as a DLL (shared object) and as a static link library ~~upon request~~.		Upon request, we provide the CBridge code both as a DLL (shared object) and as a static link library.
	If linked against the application, or dynamically loaded into the application,		If linked against the application, or dynamically loaded into the application,
	expecco can interact with it - even if the target is an embedded system.		expecco can interact with it - even if the target is an embedded system.
Zeile 8:		Zeile 8:

	The protocol as described here is also used for Python, Node, Ruby and Smalltalk bridges and also the newer versions of the Qt bridge.		The protocol as described here is also used for Python, Node, Ruby and Smalltalk bridges and also the newer versions of the Qt bridge.
			The bridge can communicate either via a Socket or a serial connection.

	== Architecture ==		== Architecture ==

Cg: /* Embedded Systems C Bridge API */

2026-04-16T12:23:36Z

Embedded Systems C Bridge API

← Nächstältere Version		Version vom 16. April 2026, 12:23 Uhr
Zeile 7:		Zeile 7:
	In addition, a fully linked executable called "cBridge" ("cBridge.exe" for Windows) is provided to be used as a default bridge for elementary C actions. This executable is found in the expecco installation folder.		In addition, a fully linked executable called "cBridge" ("cBridge.exe" for Windows) is provided to be used as a default bridge for elementary C actions. This executable is found in the expecco installation folder.

	The protocol as described here is also used for Smalltalk bridges and the ~~newest~~ ~~version~~ of the Qt bridge.		The protocol as described here is also used for Python, Node, Ruby and Smalltalk bridges and also the newer versions of the Qt bridge.

	== Architecture ==		== Architecture ==

Cg: /* Queries */

2022-07-17T15:08:44Z

Queries

← Nächstältere Version		Version vom 17. Juli 2022, 15:08 Uhr
Zeile 275:		Zeile 275:

	=== Queries ===		=== Queries ===
	*''bool'' '''json_isArray'''(''jsonObject'' obj)<br>returns a C-true (1) if the argument is a json-array object, C-false (0) otherwise. Useful to check for or case-switch on the the type of a jsonObject fetched from an input pin via "jsonValue(<inPin>)".		*''bool'' '''json_isArray'''(''jsonObject'' obj)<br>returns a C-true (1) if the argument is a json-array object, C-false (0) otherwise.<br>Useful to check for or case-switch on the the type of a jsonObject fetched from an input pin via "jsonValue(<inPin>)".

	*''bool'' '''json_isTrue'''(''jsonObject'' obj)		*''bool'' '''json_isTrue'''(''jsonObject'' obj)

Cg: /* Value Extraction */

2022-07-17T15:08:04Z

Value Extraction

← Nächstältere Version		Version vom 17. Juli 2022, 15:08 Uhr
Zeile 310:		Zeile 310:
	*''long long'' '''json_longLongValue'''(''jsonObject'' obj)		*''long long'' '''json_longLongValue'''(''jsonObject'' obj)
	*''unsigned long long'' '''json_uLongLongValue'''(''jsonObject'' obj)		*''unsigned long long'' '''json_uLongLongValue'''(''jsonObject'' obj)
	''char'' '''json_stringValue'''(''jsonObject'' obj)		''char'' '''json_stringValue'''(''jsonObject'' obj)<br>the returned char* will be invalid after the action's execution
	:the retrieved char* will be invalid after the action's execution
	''unsigned char'' '''json_bytesValue'''(''jsonObject'' obj)		''unsigned char'' '''json_bytesValue'''(''jsonObject'' obj)
	*''unsigned int'''''json_bytesLength'''(''jsonObject'' obj)		:''unsigned int'''''json_bytesLength'''(''jsonObject'' obj)<br>the retrieved byte* will be invalid after the action's execution
	:the retrieved byte* will be invalid after the action's execution

	*''jsonObject'' '''json_getArrayElement'''(''jsonObject'' obj, ''int'' index)<br>returns the value of the array element at index (0-based).		*''jsonObject'' '''json_getArrayElement'''(''jsonObject'' obj, ''int'' index)<br>returns the value of the array element at index (0-based).

Cg: /* Value Extraction */

2022-07-17T15:07:32Z

Value Extraction

← Nächstältere Version		Version vom 17. Juli 2022, 15:07 Uhr
Zeile 311:		Zeile 311:
	*''unsigned long long'' '''json_uLongLongValue'''(''jsonObject'' obj)		*''unsigned long long'' '''json_uLongLongValue'''(''jsonObject'' obj)
	''char'' '''json_stringValue'''(''jsonObject'' obj)		''char'' '''json_stringValue'''(''jsonObject'' obj)
			:the retrieved char* will be invalid after the action's execution
			''unsigned char'' '''json_bytesValue'''(''jsonObject'' obj)
			*''unsigned int'''''json_bytesLength'''(''jsonObject'' obj)
			:the retrieved byte* will be invalid after the action's execution

	*''jsonObject'' '''json_getArrayElement'''(''jsonObject'' obj, ''int'' index)<br>returns the value of the array element at index (0-based).		*''jsonObject'' '''json_getArrayElement'''(''jsonObject'' obj, ''int'' index)<br>returns the value of the array element at index (0-based).

Cg: /* Value Extraction */

2022-07-17T15:04:02Z

Value Extraction

← Nächstältere Version		Version vom 17. Juli 2022, 15:04 Uhr
Zeile 308:		Zeile 308:
	*''double'' '''json_doubleValue'''(''jsonObject'' obj)		*''double'' '''json_doubleValue'''(''jsonObject'' obj)
	*''int'' '''json_booleanValue'''(''jsonObject'' obj)		*''int'' '''json_booleanValue'''(''jsonObject'' obj)
	*'long long'' '''json_longLongValue'''(''jsonObject'' obj)		*''long long'' '''json_longLongValue'''(''jsonObject'' obj)
	*'unsigned long long'' '''json_uLongLongValue'''(''jsonObject'' obj)		*''unsigned long long'' '''json_uLongLongValue'''(''jsonObject'' obj)
	''char'' '''json_stringValue'''(''jsonObject'' obj)		''char'' '''json_stringValue'''(''jsonObject'' obj)