2#ifndef JAIABOT_LORA_SERIAL_H
3#define JAIABOT_LORA_SERIAL_H
5#include <boost/asio.hpp>
8#include <goby/middleware/io/detail/io_interface.h>
9#include <goby/middleware/io/detail/serial_interface.h>
10#include <goby/version.h>
49template <
const goby::middleware::Group& line_in_group,
50 const goby::middleware::Group& line_out_group,
51 goby::middleware::io::PubSubLayer publish_layer =
52 goby::middleware::io::PubSubLayer::INTERPROCESS,
53 goby::middleware::io::PubSubLayer subscribe_layer =
54 goby::middleware::io::PubSubLayer::INTERTHREAD,
55 template <
class>
class ThreadType = goby::zeromq::SimpleThread,
56 bool use_indexed_groups =
false>
58 :
public goby::middleware::io::detail::SerialThread<line_in_group, line_out_group,
59 publish_layer, subscribe_layer, ThreadType,
63 goby::middleware::io::detail::SerialThread<line_in_group, line_out_group, publish_layer,
64 subscribe_layer, ThreadType, use_indexed_groups>;
75 void async_read()
override;
77 void read_first_byte();
83 std::array<char, SERIAL_MAX_SIZE> buffer_;
84 char* buffer_write_ptr_{buffer_.data()};
85 std::uint16_t message_size_{0};
88template <
typename ProtobufMessage>
89ProtobufMessage
parse(
const goby::middleware::protobuf::IOData& io)
91 auto& data = io.data();
92 ProtobufMessage pb_msg;
103 pb_msg.ParseFromArray(&data[0] + prefix_size, data.size() - prefix_size);
107template <
typename ProtobufMessage>
108std::shared_ptr<goby::middleware::protobuf::IOData>
serialize(
const ProtobufMessage& pb_msg)
110 auto io = std::make_shared<goby::middleware::protobuf::IOData>();
112 std::string pb_encoded = pb_msg.SerializeAsString();
114 std::uint16_t size = pb_encoded.size();
116 static_cast<char>(size & 0xFF)};
122 std::string crc_data = std::string((
const char*)&
crc,
sizeof(
crc));
127 io->set_data(header_and_data + crc_data);
135template <
const goby::middleware::Group& line_in_group,
136 const goby::middleware::Group& line_out_group,
137 goby::middleware::io::PubSubLayer publish_layer,
138 goby::middleware::io::PubSubLayer subscribe_layer,
template <
class>
class ThreadType,
139 bool use_indexed_groups>
141 subscribe_layer, ThreadType,
142 use_indexed_groups>::async_read()
144 buffer_write_ptr_ = buffer_.data();
148template <
const goby::middleware::Group& line_in_group,
149 const goby::middleware::Group& line_out_group,
150 goby::middleware::io::PubSubLayer publish_layer,
151 goby::middleware::io::PubSubLayer subscribe_layer,
template <
class>
class ThreadType,
152 bool use_indexed_groups>
154 subscribe_layer, ThreadType,
155 use_indexed_groups>::read_first_byte()
157 boost::asio::async_read(
158 this->mutable_serial_port(),
159 boost::asio::buffer(buffer_write_ptr_,
160 buffer_.size() - (buffer_write_ptr_ - buffer_.data())),
161 boost::asio::transfer_exactly(1),
162 [
this](
const boost::system::error_code& ec, std::size_t bytes_transferred) {
163 if (!ec && bytes_transferred > 0)
165 if (buffer_[0] != SERIAL_MAGIC[0])
167 goby::glog.is_warn() &&
168 goby::glog <<
"Invalid first byte, expected: " << SERIAL_MAGIC[0]
169 <<
", received: " << buffer_[0] << std::endl;
174 buffer_write_ptr_ += bytes_transferred;
180 this->handle_read_error(ec);
185template <
const goby::middleware::Group& line_in_group,
186 const goby::middleware::Group& line_out_group,
187 goby::middleware::io::PubSubLayer publish_layer,
188 goby::middleware::io::PubSubLayer subscribe_layer,
template <
class>
class ThreadType,
189 bool use_indexed_groups>
191 subscribe_layer, ThreadType,
192 use_indexed_groups>::read_magic()
194 boost::asio::async_read(
195 this->mutable_serial_port(),
196 boost::asio::buffer(buffer_write_ptr_,
197 buffer_.size() - (buffer_write_ptr_ - buffer_.data())),
198 boost::asio::transfer_exactly(SERIAL_MAGIC_BYTES - 1),
199 [
this](
const boost::system::error_code& ec, std::size_t bytes_transferred) {
200 if (!ec && bytes_transferred > 0)
202 if (memcmp(buffer_.data(), SERIAL_MAGIC, SERIAL_MAGIC_BYTES) != 0)
204 goby::glog.is_warn() &&
206 <<
"Invalid magic word, expected: " << SERIAL_MAGIC <<
", received: "
207 << std::string(buffer_.data(), buffer_.data() + SERIAL_MAGIC_BYTES)
213 buffer_write_ptr_ += bytes_transferred;
219 this->handle_read_error(ec);
224template <
const goby::middleware::Group& line_in_group,
225 const goby::middleware::Group& line_out_group,
226 goby::middleware::io::PubSubLayer publish_layer,
227 goby::middleware::io::PubSubLayer subscribe_layer,
template <
class>
class ThreadType,
228 bool use_indexed_groups>
230 subscribe_layer, ThreadType,
231 use_indexed_groups>::read_size()
233 boost::asio::async_read(
234 this->mutable_serial_port(),
235 boost::asio::buffer(buffer_write_ptr_,
236 buffer_.size() - (buffer_write_ptr_ - buffer_.data())),
237 boost::asio::transfer_exactly(SIZE_BYTES),
238 [
this](
const boost::system::error_code& ec, std::size_t bytes_transferred) {
239 if (!ec && bytes_transferred > 0)
242 message_size_ |= buffer_[SERIAL_MAGIC_BYTES];
243 message_size_ <<= BITS_IN_BYTE;
244 message_size_ |= buffer_[SERIAL_MAGIC_BYTES + 1];
245 if (message_size_ > jaiabot_protobuf_LoRaMessage_size)
247 goby::glog.is_warn() && goby::glog
248 <<
"Reported message size is larger than Protobuf "
249 "LoraMessage maximum size. Reported:"
250 << message_size_ <<
", expected max: "
251 << jaiabot_protobuf_LoRaMessage_size << std::endl;
257 buffer_write_ptr_ += bytes_transferred;
263 this->handle_read_error(ec);
268template <
const goby::middleware::Group& line_in_group,
269 const goby::middleware::Group& line_out_group,
270 goby::middleware::io::PubSubLayer publish_layer,
271 goby::middleware::io::PubSubLayer subscribe_layer,
template <
class>
class ThreadType,
272 bool use_indexed_groups>
274 subscribe_layer, ThreadType,
275 use_indexed_groups>::read_body()
277 boost::asio::async_read(
278 this->mutable_serial_port(),
279 boost::asio::buffer(buffer_write_ptr_,
280 buffer_.size() - (buffer_write_ptr_ - buffer_.data())),
281 boost::asio::transfer_exactly(message_size_),
282 [
this](
const boost::system::error_code& ec, std::size_t bytes_transferred) {
283 if (!ec && bytes_transferred > 0)
287 buffer_write_ptr_ += bytes_transferred;
288 auto io_msg = std::make_shared<goby::middleware::protobuf::IOData>();
289 io_msg->set_data(std::string(buffer_.data(), buffer_write_ptr_));
290 this->handle_read_success(buffer_write_ptr_ - buffer_.data(), io_msg);
295 this->handle_read_error(ec);
Reads/Writes LoRa Adafruit feather message packages from/to serial port.
SerialThreadFletcher16(const goby::middleware::protobuf::SerialConfig &config, int index=-1)
~SerialThreadFletcher16()
uint16_t fletcher16(const void *input_str, size_t num_bytes)
Calculate the Fletcher-16 checksum of a block of data.
ProtobufMessage parse(const goby::middleware::protobuf::IOData &io)
constexpr int SERIAL_MAGIC_BYTES
constexpr const char * SERIAL_MAGIC
std::shared_ptr< goby::middleware::protobuf::IOData > serialize(const ProtobufMessage &pb_msg)
constexpr int BITS_IN_BYTE
constexpr auto SERIAL_MAX_SIZE