M5Unit-RFID 0.2.0 git rev:79c1939
Loading...
Searching...
No Matches
unit_UHFRFID.hpp File Reference

Base class for UHF-RFID reader units. More...

#include <memory>
#include <vector>
#include <M5UnitComponent.hpp>
#include <m5_utility/container/circular_buffer.hpp>
#include <m5_utility/stl/expected.hpp>
#include "uhf/uhf.hpp"

Go to the source code of this file.

Classes

class  m5::unit::UHFRFIDComponent
 Non-instantiable base class for UHF-RFID reader units. More...
 
struct  m5::unit::UHFRFIDComponent::config_t
 Settings for begin. More...
 

Namespaces

namespace  m5
 Top level namespace of M5Stack.
 

Typedefs

using m5::unit::TagResult = m5::stl::expected<void, uint8_t>
 What became of an operation on a tag.
 

Variables

Codes this library puts in place of one the reader did not give

A reader reports a code only when something came back over the air. Where a request never went out, or the answer could not be read, there is no code to report and one of these stands in its place. EPC Gen2 leaves 0xF0 to 0xFF outside the tag error codes and the M100 uses none of them, so they are free to say what no reader would

constexpr uint8_t m5::unit::READER_SILENT {0xFF}
 Nothing came back at all.
 
constexpr uint8_t m5::unit::READER_BALKED {0xFE}
 The reader answered, and said it had not done it.
 
constexpr uint8_t m5::unit::READER_GARBLED {0xFD}
 The answer came back and could not be read.
 
constexpr uint8_t m5::unit::NOT_SELECTED {0xFC}
 No tag had been selected, so nothing was sent.
 
constexpr uint8_t m5::unit::BAD_ARGUMENT {0xFB}
 The request could not succeed, so nothing was sent.
 
constexpr uint8_t m5::unit::READER_BUSY {0xFA}
 Polling held the reader, so nothing was sent.
 

Detailed Description

Base class for UHF-RFID reader units.

Typedef Documentation

◆ TagResult

using m5::unit::TagResult = m5::stl::expected<void, uint8_t>

What became of an operation on a tag.

Nothing on success. On failure the error code the reader reported, whose meaning is the reader's own; classify() is what turns it into something a caller can act on