mirror of
https://github.com/mysensors/MySensors.git
synced 2026-03-14 12:06:59 +01:00
2e0f6b6229
RPi and Linux refactor. Add GPIO Sysfs for GPIO operations. Update configure script. Fix some cppcheck warnings. Add serial emulation that prints to stdout. Fix some file headers.
115 lines
2.9 KiB
C++
115 lines
2.9 KiB
C++
/*
|
|
* The MySensors Arduino library handles the wireless radio link and protocol
|
|
* between your home built sensors/actuators and HA controller of choice.
|
|
* The sensors forms a self healing radio network with optional repeaters. Each
|
|
* repeater and gateway builds a routing tables in EEPROM which keeps track of the
|
|
* network topology allowing messages to be routed to nodes.
|
|
*
|
|
* Created by Henrik Ekblad <henrik.ekblad@mysensors.org>
|
|
* Copyright (C) 2013-2017 Sensnology AB
|
|
* Full contributor list: https://github.com/mysensors/Arduino/graphs/contributors
|
|
*
|
|
* Documentation: http://www.mysensors.org
|
|
* Support Forum: http://forum.mysensors.org
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* version 2 as published by the Free Software Foundation.
|
|
*/
|
|
|
|
#ifndef SerialPort_h
|
|
#define SerialPort_h
|
|
|
|
#include <string>
|
|
#include <stdbool.h>
|
|
#include "Stream.h"
|
|
|
|
/**
|
|
* SerialPort Class
|
|
* Class that provides the functionality of arduino Serial library
|
|
*/
|
|
class SerialPort : public Stream
|
|
{
|
|
|
|
private:
|
|
int sd; //!< @brief file descriptor number.
|
|
std::string serialPort; //!< @brief tty name.
|
|
bool isPty; //!< @brief true if serial is pseudo terminal.
|
|
|
|
public:
|
|
/**
|
|
* @brief SerialPort constructor.
|
|
*/
|
|
SerialPort(const char *port, bool isPty = false);
|
|
/**
|
|
* @brief Open the serial port and set the data rate in bits per second (baud).
|
|
*
|
|
* This function will terminate the program on an error.
|
|
*
|
|
* @param bauds bits per second.
|
|
*/
|
|
void begin(int bauds);
|
|
/**
|
|
* @brief Open the serial port and set the data rate in bits per second (baud).
|
|
*
|
|
* @param bauds bits per second.
|
|
* @return @c true if no errors, else @c false.
|
|
*/
|
|
bool open(int bauds = 115200);
|
|
/**
|
|
* @brief Grant access to the specified system group for the serial device.
|
|
*
|
|
* @param groupName system group name.
|
|
*/
|
|
bool setGroupPerm(const char *groupName);
|
|
/**
|
|
* @brief Get the number of bytes available.
|
|
*
|
|
* Get the numberof bytes (characters) available for reading from
|
|
* the serial port.
|
|
*
|
|
* @return number of bytes avalable to read.
|
|
*/
|
|
int available();
|
|
/**
|
|
* @brief Reads 1 byte of incoming serial data.
|
|
*
|
|
* @return first byte of incoming serial data available.
|
|
*/
|
|
int read();
|
|
/**
|
|
* @brief Writes a single byte to the serial port.
|
|
*
|
|
* @param b byte to write.
|
|
* @return number of bytes written.
|
|
*/
|
|
size_t write(uint8_t b);
|
|
/**
|
|
* @brief Writes binary data to the serial port.
|
|
*
|
|
* @param buffer to write.
|
|
* @param size of the buffer.
|
|
* @return number of bytes written.
|
|
*/
|
|
size_t write(const uint8_t *buffer, size_t size);
|
|
/**
|
|
* @brief
|
|
*
|
|
* Returns the next byte (character) of incoming serial data without removing it from
|
|
* the internal serial buffer.
|
|
*
|
|
* @return -1 if no data else character in the buffer.
|
|
*/
|
|
int peek();
|
|
/**
|
|
* @brief Remove any data remaining on the serial buffer.
|
|
*/
|
|
void flush();
|
|
/**
|
|
* @brief Disables serial communication.
|
|
*/
|
|
void end();
|
|
};
|
|
|
|
#endif
|