One Pin Comms Link 1.0
One Pin Serial comms link layer implemented in software only
MD_OnePin_Protocol.h File Reference

Header for MD_OnePin library link protocol timing parameters. More...

This graph shows which files directly or indirectly include this file:

Macros

#define BPP_PRI   32
 
#define BPP_SEC   8
 

Typedefs

typedef uint32_t opPriPacket_t
 
typedef uint8_t opSecPacket_t
 

Variables

const uint16_t OPT = 80
 OnePin Timesleot in microseconds - all timing is multiples/fractions of this.
 
const uint16_t OPT_RST_SIGNAL = 5 * OPT
 Reset the device for a new command.
 
const uint16_t OPT_RST_PRESENCE = (3 * OPT) / 2
 Duration of SEC presence signal.
 
const uint16_t OPT_RST_PRS_SAMPLE = OPT
 PRI presence sampling time after setting rising edge.
 
const uint16_t OPT_RST_END = (3 * OPT) / 2
 Delay presence sampling before the next comms.
 
const uint16_t OPT_WR1_SIGNAL = OPT / 2
 Write a 1 line active time (low signal)
 
const uint16_t OPT_WR1_PAUSE = OPT - OPT_WR1_SIGNAL
 Write a 1 line delay time (high signal after active)
 
const uint16_t OPT_WR1_DETECT = OPT
 Write a 1 SEC read detection threshold.
 
const uint16_t OPT_WR0_SIGNAL = (3 * OPT) / 2
 Write a 0 line active time (low signal)
 
const uint16_t OPT_WR0_DETECT = 2 * OPT
 Write a 0 SEC read detection threshold.
 
const uint16_t OPT_WR0_PAUSE = (2 * OPT) - OPT_WR0_SIGNAL
 Write a 0 line delay time (high signal after active)
 
const uint16_t OPT_RD_INIT = (5 * OPT) / 2
 Read activation signal.
 
const uint16_t OPT_RD_DETECT = 3 * OPT
 Read bit SEC detection threshold.
 
const uint16_t OPT_RD0_SIGNAL = OPT
 SEC hold time to signal a 0.
 
const uint16_t OPT_RD_SAMPLE = OPT_RD0_SIGNAL / 2
 PRI read signal sampling time after read signal.
 
const uint16_t OPT_RD_PAUSE = OPT
 PRI read pause before next read.
 

Detailed Description

Header for MD_OnePin library link protocol timing parameters.

Macro Definition Documentation

◆ BPP_PRI

#define BPP_PRI   32

The size in bits of the link packet from PRI to SEC. The bits per packet (bpp) can be between 1 and 32 bits.

See also
BPP_SEC

◆ BPP_SEC

#define BPP_SEC   8

The size in bits of the link packet from SEC to PRI. The bits per packet (bpp) can be between 1 and 32 bits.

See also
BPP_PRI

Typedef Documentation

◆ opPriPacket_t

typedef uint32_t opPriPacket_t

Defines the packet type for PRI node. As PRI is much less resource constrained than SEC, we just define the largest data type only that will hold all packet sizes (defined as BPP_PRI bits).

◆ opSecPacket_t

typedef uint8_t opSecPacket_t

Defines packet typedef for the SEC node. As SEC is probably resource constrained the definition will generate the smallest size that fits BPP_SEC number of bits.