GDOfSerial (Godot 3.5)

openFramwork serial standalone for Godot, is a part of GDWired (https://github.com/GDWired) for macOS, Windows and Linux.

Dependencies:

• Godot build dependencies (https://docs.godotengine.org/en/stable/development/compiling/index.html)

To compile it:

• Run git clone --recurse-submodules https://github.com/GDWired/GDOfSerial.git
• Run scons target=release on the root folder.

Demo

In the "demo" folder there is a sample project, after compiling the project you can open it with Godot 3.5.1. (You can also download a precompiled version of the plugin from the asset store or in the release section of github WIP)

On the picture above, this is the demo project, if you press the "Send" button, the data on top will be sent to the first device found. The received data will be automatically written to the terminal. It is possible to get the data in hexa or string. The device used in this demo is an Arduino Leonardo with the example code here https://github.com/jferdelyi/ofSerial/blob/f2fe94bd775728b4236f0e2e0f757d448947c6b3/example/esp32_main.cpp.

API

# Get device list
# @return the device list
get_device_list() -> Array

# Start communication with the specific device
# @param port_name the device port
# @param baudrate baudrate
# @return true if connected 
begin(port_name: String, baudrate: int) -> bool

# Start communication with the specific device (using specific configuration)
# Default configuration is SERIAL_8N1 (8 bits data, no parity, 1 stop bit)
# Available values:
#		SERIAL_5N1
#		SERIAL_6N1
#		SERIAL_7N1
#		SERIAL_8N1	// the default
#		SERIAL_5N2
#		SERIAL_6N2
#		SERIAL_7N2
#		SERIAL_8N2
#		SERIAL_5E1	// even parity
#		SERIAL_6E1
#		SERIAL_7E1
#		SERIAL_8E1
#		SERIAL_5E2
#		SERIAL_6E2
#		SERIAL_7E2
#		SERIAL_8E2
#		SERIAL_5O1	// odd parity
#		SERIAL_6O1
#		SERIAL_7O1
#		SERIAL_8O1
#		SERIAL_5O2
#		SERIAL_6O2
#		SERIAL_7O2
#		SERIAL_8O2
# @param port_name the device port
# @param baudrate baudrate
# @param config value from the enum (default: SERIAL_8N1)
# @return true if connected 
begin_with_config(port_name: String, baudrate: int, config: int) -> bool

# Return true if initialized
# @return true if initialized
is_initialized() -> bool

# Close connection
end() -> void

# Return the number of bytes available to read
# @return the number of bytes available to read
available() -> int

# Read one byte
# @return first byte
read() -> int

# Read data as string
# @param length number of byte to read
# @return data as a string
read_string(length: int) -> String

# Read raw data
# @param length number of byte to read
# @return raw data like [0x49, 0x4E, 0x49, 0x54]
read_bytes(length: int) -> PoolByteArray

# Write string
# @param buffer the string to write
# @return the number of bytes written
print(buffer: String) -> int

# Write string (with \n at the end)
# @param buffer the string to write
# @return the number of bytes written
println(buffer: String) -> int

# Write raw data (hexa like: [0x49, 0x4E, 0x49, 0x54])
# @param buffer the raw data buffer
# @return the number of bytes written
write(buffer: PoolByteArray) -> int

# Flush IN buffer
flush_in() -> void

# Flush OUT buffer
flush_out() -> void

# Flush IN/OUT buffers
flush() -> void