Trigger when a UART sees a certain data pattern. More...

#include <UartTrigger.h>

Inheritance diagram for UartTrigger:

[legend]

Collaboration diagram for UartTrigger:

[legend]

Public Types
enum	ParityType { PARITY_NONE , PARITY_ODD , PARITY_EVEN , PARITY_MARK , PARITY_SPACE }
	Type of parity to use. More...

enum	MatchType { TYPE_DATA , TYPE_PARITY_ERR , TYPE_START , TYPE_STOP }
	What kind of pattern to match. More...

enum	Polarity { IDLE_HIGH , IDLE_LOW }
	Polarity of the port. More...

Public Types inherited from SerialTrigger
enum	Radix { RADIX_ASCII , RADIX_HEX , RADIX_BINARY }

Public Types inherited from Trigger
enum	Condition { CONDITION_EQUAL , CONDITION_NOT_EQUAL , CONDITION_LESS , CONDITION_LESS_OR_EQUAL , CONDITION_GREATER , CONDITION_GREATER_OR_EQUAL , CONDITION_BETWEEN , CONDITION_NOT_BETWEEN , CONDITION_ANY }
	Conditions for triggers that perform logical comparisons of values. More...

typedef Trigger (	CreateProcType) (Oscilloscope *)

Public Types inherited from FlowGraphNode
enum class	ExecutionCapabilities { None = 0 , CommandBufferAppend = 1 , CommandBufferTailCall = 2 , VulkanOnly = 4 , DynamicShader = 8 }

typedef std::map< std::string, FilterParameter >	ParameterMapType
	Short name for a map of strings to parameters.

Public Member Functions
	UartTrigger (Oscilloscope *scope)
	Creates a new UART trigger.

void	SetParityType (ParityType type)
	Set the parity for the trigger.

ParityType	GetParityType ()
	Get the currently selected parity mode.

void	SetMatchType (MatchType type)
	Sets the match mode for the trigger.

MatchType	GetMatchType ()
	Returns the currently selected match mode.

void	SetPolarity (Polarity type)
	Sets the UART polarity.

Polarity	GetPolarity ()
	Get the current trigger polarity.

int64_t	GetBitRate ()
	Get the current baud rate.

void	SetBitRate (int64_t t)
	Sets the baud rate.

float	GetStopBits ()
	Get the length of the stop bit, in UI.

void	SetStopBits (float n)
	Set the length of the stop bit.

virtual bool	ValidateChannel (size_t i, StreamDescriptor stream) override
	Check if a stream is allowed to be connected to the given input.

	TRIGGER_INITPROC (UartTrigger)

Public Member Functions inherited from SerialTrigger
	SerialTrigger (Oscilloscope *scope)

void	SetCondition (Condition cond)

Condition	GetCondition ()

void	SetRadix (Radix rad)

Radix	GetRadix ()

void	SetPatterns (const std::string &p1, const std::string &p2, bool ignore_p2)
	Converts a pattern from ASCII ternary (0-1-x) to a more display-friendly format.

std::string	GetPattern1 ()

std::string	GetPattern2 ()

Public Member Functions inherited from Trigger
	Trigger (Oscilloscope *scope)
	Initialize a new trigger.

virtual void	Refresh (vk::raii::CommandBuffer &cmdBuf, std::shared_ptr< QueueHandle > queue) override

float	GetLevel ()
	Get the trigger level.

float	GetUpperLevel ()

void	SetLevel (float level)
	Sets the trigger level.

void	SetUpperLevel (float level)

Oscilloscope *	GetScope ()
	Gets the scope this trigger is attached to.

virtual std::string	GetTriggerDisplayName ()=0

virtual YAML::Node	SerializeConfiguration (IDTable &table) override
	Serializes this trigger's configuration to a YAML string.

Public Member Functions inherited from FlowGraphNode
void	DetachInputs ()
	Disconnects all inputs from the node without releasing them.

size_t	GetInputCount ()
	Get the number of input ports.

std::string	GetInputName (size_t i)

void	SetInput (size_t i, StreamDescriptor stream, bool force=false)
	Connects a stream to the input of this node.

void	SetInput (const std::string &name, StreamDescriptor stream, bool force=false)

bool	HasInput (StreamDescriptor desc)
	Checks if the given stream is connected to at least one of our inputs.

StreamDescriptor	GetInput (size_t i)
	Gets the descriptor for one of our inputs.

std::shared_ptr< InputConstraint >	GetInputConstraints (size_t i)
	Get the constraints on one of our inputs.

FilterParameter &	GetParameter (std::string s)

bool	HasParameter (std::string s)
	Checks if we have a parameter with a given name.

ParameterMapType::iterator	GetParamBegin ()
	Returns an iterator to the beginning of our parameter map.

ParameterMapType::iterator	GetParamEnd ()
	Returns an iterator to the end of our parameter map.

size_t	GetParamCount ()
	Returns the number of parameter we have.

virtual void	LoadParameters (const YAML::Node &node, IDTable &table)
	Load configuration from a save file.

virtual void	LoadInputs (const YAML::Node &node, IDTable &table)

bool	IsDownstreamOf (std::set< FlowGraphNode * > nodes)
	Determines if this node is downstream of any of the specified other nodes.

virtual uint32_t	GetExecutionCapabilitiesMask ()
	Returns a bitmask of ExecutionCapabilities fields.

bool	HasMessages () const
	Checks if this graph has any messages.

const std::vector< FlowGraphNodeMessage > &	GetMessages () const
	Walking through any messages.

const FlowGraphNodeMessage *	GetMostSevereMessage () const

void	AddSink (size_t stream, FlowGraphNode *node)

void	RemoveSink (size_t stream, FlowGraphNode *node)

const std::set< FlowGraphNode * > &	GetSinks (size_t stream)

sigc::signal< void()>	signal_parametersChanged ()

sigc::signal< void()>	signal_inputsChanged ()

Static Public Member Functions
static std::string	GetTriggerName ()
	Returns the trigger name "UART".

Static Public Member Functions inherited from Trigger
static void	DoAddTriggerClass (std::string name, CreateProcType proc)
	Register a new trigger class for dynamic creation.

static void	EnumTriggers (std::vector< std::string > &names)
	Gets a list of all registered trigger types.

static Trigger *	CreateTrigger (std::string name, Oscilloscope *scope)
	Creates a new trigger for an oscilloscope.

Protected Attributes
FilterParameter &	m_baudrate
	Baud rate.

FilterParameter &	m_parity
	Parity type.

FilterParameter &	m_matchtype
	Match type.

FilterParameter &	m_stoptype
	Stop type.

FilterParameter &	m_polarity
	Polarity.

Protected Attributes inherited from SerialTrigger
FilterParameter	m_radix

FilterParameter	m_condition

FilterParameter	m_pattern

FilterParameter	m_pattern2

Protected Attributes inherited from Trigger
Oscilloscope *	m_scope
	The scope this trigger is part of.

FilterParameter &	m_level
	"Trigger level" parameter

FilterParameter &	m_triggerLevel

FilterParameter &	m_upperLevel

Protected Attributes inherited from FlowGraphNode
std::vector< std::shared_ptr< InputDescriptor > >	m_inputs
	Input ports.

std::vector< std::set< FlowGraphNode * > >	m_sinks
	The nodes (if any) that each of our streams drives.

ParameterMapType	m_parameters

sigc::signal< void()>	m_parametersChangedSignal
	Signal emitted when the set of parameters changes.

sigc::signal< void()>	m_inputsChangedSignal
	Signal emitted when the set of inputs changes.

std::vector< FlowGraphNodeMessage >	m_messages

Additional Inherited Members
Protected Types inherited from Trigger
typedef std::map< std::string, CreateProcType >	CreateMapType
	Helper typedef for m_createprocs.

Protected Member Functions inherited from SerialTrigger
std::string	FormatPattern (const std::string &str)
	Converts a pattern in the current radix back to ASCII ternary.

Protected Member Functions inherited from FlowGraphNode
virtual void	OnInputChanged (size_t i)
	Called when a new input is connected to the node.

WaveformBase *	GetInputWaveform (size_t i)
	Gets the waveform attached to the specified input.

SparseAnalogWaveform *	GetSparseAnalogInputWaveform (size_t i)
	Gets the analog waveform attached to the specified input.

UniformAnalogWaveform *	GetUniformAnalogInputWaveform (size_t i)
	Gets the analog waveform attached to the specified input.

SparseDigitalWaveform *	GetSparseDigitalInputWaveform (size_t i)
	Gets the digital waveform attached to the specified input.

UniformDigitalWaveform *	GetUniformDigitalInputWaveform (size_t i)
	Gets the digital waveform attached to the specified input.

virtual void	CreateInput (const std::string &name)
	Gets the digital bus waveform attached to the specified input.

template<class T , class... Args>
void	CreateInput (const std::string &name, Args &&... args)

std::string	GetInputDisplayName (size_t i)
	Gets the display name for one of our inputs.

void	ClearMessages ()
	Remove any messages left over from the last graph refresh.

void	AddMessage (const FlowGraphNodeMessage &msg)
	Attach a new message to the node.

void	AddMessage (Severity severity, const std::string &title, const std::string &message)
	Attach a new message to the node.

void	AddErrorMessage (const std::string &err)
	Add a new error message.

void	AddErrorMessage (const std::string &title, const std::string &err)
	Add a new error message with a title.

Static Protected Attributes inherited from Trigger
static CreateMapType	m_createprocs
	Map of trigger type names to factory methods.

Detailed Description

Trigger when a UART sees a certain data pattern.

Member Enumeration Documentation

◆ MatchType

enum UartTrigger::MatchType

What kind of pattern to match.

Enumerator
TYPE_DATA	Match on a data byte.
TYPE_PARITY_ERR	Match on a parity error.
TYPE_START	Match on a start bit.
TYPE_STOP	Match on a stop bit.

◆ ParityType

enum UartTrigger::ParityType

Type of parity to use.

Enumerator
PARITY_NONE	No parity.
PARITY_ODD	Odd parity.
PARITY_EVEN	Even parity.
PARITY_MARK	Mark parity.
PARITY_SPACE	Space parity.

◆ Polarity

enum UartTrigger::Polarity

Polarity of the port.

Enumerator
IDLE_HIGH	Idle high, pull low to send a bit.
IDLE_LOW	Idle low, pull high to send a bit.

Constructor & Destructor Documentation

◆ UartTrigger()

UartTrigger::UartTrigger ( Oscilloscope * scope )

Creates a new UART trigger.

Parameters

scope Scope to create the trigger for

Member Function Documentation

◆ SetBitRate()

void UartTrigger::SetBitRate ( int64_t t )

inline

Sets the baud rate.

Parameters

t	Desired baud rate

◆ SetMatchType()

void UartTrigger::SetMatchType ( MatchType type )

inline

Sets the match mode for the trigger.

Parameters

type	Type of pattern to look for

◆ SetParityType()

void UartTrigger::SetParityType ( ParityType type )

inline

Set the parity for the trigger.

Parameters

type	Selected parity mode

◆ SetPolarity()

void UartTrigger::SetPolarity ( Polarity type )

inline

Sets the UART polarity.

Parameters

type	Desired polarity

◆ SetStopBits()

void UartTrigger::SetStopBits ( float n )

inline

Set the length of the stop bit.

Parameters

n	Length of the stop bit, in UI

◆ ValidateChannel()

bool UartTrigger::ValidateChannel	(	size_t	i,
		StreamDescriptor	stream
	)

overridevirtual

Check if a stream is allowed to be connected to the given input.

Reimplemented from FlowGraphNode.

The documentation for this class was generated from the following files:

lib/scopehal/UartTrigger.h
lib/scopehal/UartTrigger.cpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ MatchType

◆ ParityType

◆ Polarity

Constructor & Destructor Documentation

◆ UartTrigger()

Member Function Documentation

◆ SetBitRate()

◆ SetMatchType()

◆ SetParityType()

◆ SetPolarity()

◆ SetStopBits()

◆ ValidateChannel()