Table of Contents

SPI Layer (spi)

The SPI layer provides Serial Parallel Interface functionality. This layer can be placed on top of any layer.

SPI Layer Configuration Parameters

Parameter Type Description
Alias String
BitsPerWord Number
Debug Log Level Number Debug Level
Dependencies String Other dependencies to this element
Destination Peer Number
Device String
Event Filter String Filter of Event
Exact Match Boolean
Max Event Queue Size Number Maximum Queue Size
Mode Number
Name String Component Name
No Events Boolean
Passthrough Boolean High-to-Low Layer Passthrough
Raw Data To Inject String Data Packet to Inject
Raw Dst L2 To Inject String Destination L2 Address
Raw Dst L3 To Inject String Destination L3 Address
Raw Dst L4 To Inject String Destination L4 Address
Request Timeout Number
Save Dynamic Config Boolean
Show Commands Boolean Show Commands
Show Events Boolean Show Events
Speed Number
Topic String
Watch Boolean Watch Layer

SPI Layer Real-Time Parameters

Parameter Type Description
Allow Blocking Event Boolean Blocking Events
Blocked Boolean Disable Component
Debug Log Level Number Debug Level
Passthrough Boolean High-to-Low Layer Passthrough
Watch Boolean Watch Layer

SPI Layer Functions

Function Type Description
getSpiAllowBlockingEvent(layer) getter Get “Allow Blocking Event” Parameter
getSpiBitsPerWord(layer) getter Get “BitsPerWord” Parameter
getSpiBlocked(layer) getter Get “Blocked” Parameter
getSpiDebugLogLevel(layer) getter Get “Debug Log Level” Parameter
getSpiDestinationPeer(layer) getter Get “Destination Peer” Parameter
getSpiMode(layer) getter Get “Mode” Parameter
getSpiNoEvents(layer) getter Get “No Events” Parameter
getSpiPassthrough(layer) getter Get “Passthrough” Parameter
getSpiReadout(layer) getter Get “Readout” Parameter
getSpiSpeed(layer) getter Get “Speed” Parameter
getSpiTopic(layer) getter Get “Topic” Parameter
getSpiWatch(layer) getter Get “Watch” Parameter
getStatsSpiAvailableInstances(layer) getter Get “Available Instances” Parameter
getStatsSpiDownstreamLastPacket(layer) getter Get “Downstream Last Packet” Parameter
getStatsSpiDownstreamPacketCount(layer) getter Get “Downstream Packet Count” Parameter
getStatsSpiMaxDownstreamDelay(layer) getter Get “Max Downstream Delay” Parameter
getStatsSpiMaxUpstreamDelay(layer) getter Get “Max Upstream Delay” Parameter
getStatsSpiMeanDownstreamDelay(layer) getter Get “Mean Downstream Delay” Parameter
getStatsSpiMeanUpstreamDelay(layer) getter Get “Mean Upstream Delay” Parameter
getStatsSpiMinDownstreamDelay(layer) getter Get “Min Downstream Delay” Parameter
getStatsSpiMinUpstreamDelay(layer) getter Get “Min Upstream Delay” Parameter
getStatsSpiName(layer) getter Get “Name” Parameter
getStatsSpiRateBpsDownstream(layer) getter Get “Rate Bps Downstream” Parameter
getStatsSpiRateBpsUpstream(layer) getter Get “Rate Bps Upstream” Parameter
getStatsSpiTimestampIn(layer) getter Get “Timestamp In” Parameter
getStatsSpiTimestampOut(layer) getter Get “Timestamp Out” Parameter
getStatsSpiType(layer) getter Get “Type” Parameter
getStatsSpiUpstreamLastPacket(layer) getter Get “Upstream Last Packet” Parameter
getStatsSpiUpstreamPacketCount(layer) getter Get “Upstream Packet Count” Parameter
getStatsSpiVarianceDownstreamDelay(layer) getter Get “Variance Downstream Delay” Parameter
getStatsSpiVarianceUpstreamDelay(layer) getter Get “Variance Upstream Delay” Parameter
setSpiAllowBlockingEvent(layer,value) setter Set “Allow Blocking Event” Parameter
setSpiBitsPerWord(layer,value) setter Set “BitsPerWord” Parameter
setSpiBlocked(layer,value) setter Set “Blocked” Parameter
setSpiDebugLogLevel(layer,value) setter Set “Debug Log Level” Parameter
setSpiMode(layer,value) setter Set “Mode” Parameter
setSpiNoEvents(layer,value) setter Set “No Events” Parameter
setSpiPassthrough(layer,value) setter Set “Passthrough” Parameter
setSpiReadout(layer,value) setter Set “Readout” Parameter
setSpiSpeed(layer,value) setter Set “Speed” Parameter
setSpiTopic(layer,value) setter Set “Topic” Parameter
setSpiWatch(layer,value) setter Set “Watch” Parameter
spiWriteRead(layer,write_buffer,read_length) function Write/Read SPI data