serial_port.h

/*************************************************************************/
/*  serial_port.h                                                        */
/*************************************************************************/
/*                       This file is part of:                           */
/*                           GODOT ENGINE                                */
/*                      https://godotengine.org                          */
/*************************************************************************/
/* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur.                 */
/* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md).   */
/*                                                                       */
/* Permission is hereby granted, free of charge, to any person obtaining */
/* a copy of this software and associated documentation files (the       */
/* "Software"), to deal in the Software without restriction, including   */
/* without limitation the rights to use, copy, modify, merge, publish,   */
/* distribute, sublicense, and/or sell copies of the Software, and to    */
/* permit persons to whom the Software is furnished to do so, subject to */
/* the following conditions:                                             */
/*                                                                       */
/* The above copyright notice and this permission notice shall be        */
/* included in all copies or substantial portions of the Software.       */
/*                                                                       */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,       */
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF    */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY  */
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,  */
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE     */
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.                */
/*************************************************************************/

#ifndef SERIAL_PORT_H
#define SERIAL_PORT_H

#include "core/object/ref_counted.h"
#include "core/os/thread.h"
#include "core/string/ustring.h"
#include "core/templates/rb_map.h"
#include "core/templates/vector.h"
#include "core/variant/array.h"
#include "core/variant/dictionary.h"

#include "serial/serial.h"

using namespace serial;

class SerialPort : public Object {
	GDCLASS(SerialPort, Object);

	Serial *serial;
	Thread thread;
	bool fine_working = false;
	int monitoring_interval = 10000;
	bool monitoring_should_exit = false;
	String error_message = "";

	void _data_received(const PackedByteArray &buf);

	static void _thread_func(void *p_user_data);

public:
	enum ByteSize {
		BYTESIZE_5 = fivebits,
		BYTESIZE_6 = sixbits,
		BYTESIZE_7 = sevenbits,
		BYTESIZE_8 = eightbits,
	};
	enum Parity {
		PARITY_NONE = parity_none,
		PARITY_ODD = parity_odd,
		PARITY_EVEN = parity_even,
		PARITY_MARK = parity_mark,
		PARITY_SPACE = parity_space,
	};
	enum StopBits {
		STOPBITS_1 = stopbits_one,
		STOPBITS_2 = stopbits_two,
		STOPBITS_1P5 = stopbits_one_point_five,
	};
	enum FlowControl {
		FLOWCONTROL_NONE = flowcontrol_none,
		FLOWCONTROL_SOFTWARE = flowcontrol_software,
		FLOWCONTROL_HARDWARE = flowcontrol_hardware,
	};

	SerialPort(const String &port = "",
			uint32_t baudrate = 9600,
			uint32_t timeout = 0,
			ByteSize bytesize = BYTESIZE_8,
			Parity parity = PARITY_NONE,
			StopBits stopbits = STOPBITS_1,
			FlowControl flowcontrol = FLOWCONTROL_NONE);

	~SerialPort();

	static Dictionary list_ports();

	bool is_in_error() { return is_open() && !fine_working; }
	inline String get_last_error() { return error_message; }
	void _on_error(const String &where, const String &what);

	Error start_monitoring(uint64_t interval_in_usec = 10000);
	void stop_monitoring();

	Error open(String port = "");

	bool is_open() const;

	void close();

	size_t available();

	bool wait_readable();

	void wait_byte_times(size_t count);

	PackedByteArray read_raw(size_t size = 1);

	String read_str(size_t size = 1, bool utf8_encoding = false);

	size_t write_raw(const PackedByteArray &data);

	size_t write_str(const String &data, bool utf8_encoding = false);

	String read_line(size_t size = 65535, String eol = "\n", bool utf8_encoding = false);
	PackedStringArray read_lines(size_t size = 65535, String eol = "\n", bool utf8_encoding = false);

	Error set_port(const String &port);

	String get_port() const;

	Error set_timeout(uint32_t timeout);

	uint32_t get_timeout() const;

	Error set_baudrate(uint32_t baudrate);

	uint32_t get_baudrate() const;

	Error set_bytesize(ByteSize bytesize);

	ByteSize get_bytesize() const;

	Error set_parity(Parity parity);

	Parity get_parity() const;

	Error set_stopbits(StopBits stopbits);

	StopBits get_stopbits() const;

	Error set_flowcontrol(FlowControl flowcontrol);

	FlowControl get_flowcontrol() const;

	Error flush();

	Error flush_input();

	Error flush_output();

	Error send_break(int duration);

	Error set_break(bool level = true);

	Error set_rts(bool level = true);

	Error set_dtr(bool level = true);

	bool wait_for_change();

	bool get_cts();

	bool get_dsr();

	bool get_ri();

	bool get_cd();

protected:
	String _to_string() const;

	static void _bind_methods();
};

VARIANT_ENUM_CAST(SerialPort::ByteSize);
VARIANT_ENUM_CAST(SerialPort::Parity);
VARIANT_ENUM_CAST(SerialPort::StopBits);
VARIANT_ENUM_CAST(SerialPort::FlowControl);

#endif // SERIAL_PORT_H