sigrok - User contributions [en]

Protocol decoders

2023-05-24T13:35:15Z

LiborT: /* Possible candidates for future protocol decoders */

This is a list of '''supported protocol decoders (PDs)''' and '''decoders which we might want to write in the future''' (or users might want to contribute).

See [[Protocol decoder API]] for details on how the decoders work in sigrok, and [[Protocol decoder HOWTO]] for a quick introduction about how to write your own decoders.

== Supported protocol decoders ==



Number of currently supported protocol decoders: '''131'''.

{| border="0" style="font-size: smaller" class="alternategrey sortable sigroktable"
|-
!Protocol
!Tags
!Input IDs
!Output IDs
!Status
!Full name
!Description

{{pd|ac97|AC '97|Audio Codec '97|Audio and modem control for PC systems.|Audio, PC|logic|—|supported}}
{{pd|ad5626|AD5626|Analog Devices AD5626|Analog Devices AD5626 12-bit nanoDAC.|IC, Analog/digital|spi|—|supported}}
{{pd|ad79x0|AD79x0|Analog Devices AD79x0|Analog Devices AD7910/AD7920 12-bit ADC.|IC, Analog/digital|spi|—|supported}}
{{pd|ade77xx|ADE77xx|Analog Devices ADE77xx|Poly phase multifunction energy metering IC protocol.|Analog/digital, IC, Sensor|spi|—|supported}}
{{pd|adf435x|ADF435x|Analog Devices ADF4350/1|Wideband synthesizer with integrated VCO.|Clock/timing, IC, Wireless/RF|spi|—|supported}}
{{pd|adns5020|ADNS-5020|Avago ADNS-5020|Bidirectional optical mouse sensor protocol.|IC, PC, Sensor|spi|—|supported}}
{{pd|adxl345|ADXL345|Analog Devices ADXL345|Analog Devices ADXL345 3-axis accelerometer.|IC, Sensor|spi|—|supported}}
{{pd|am230x|AM230x|Aosong AM230x/DHTxx/RHTxx|Aosong AM230x/DHTxx/RHTxx humidity/temperature sensor.|IC, Sensor|logic|—|supported}}
{{pd|amulet_ascii|Amulet ASCII|Amulet LCD ASCII|Amulet Technologies LCD controller ASCII protocol.|Display|uart|—|supported}}
{{pd|arm_etmv3|ARM ETMv3|ARM Embedded Trace Macroblock v3|ARM ETM v3 instruction trace protocol.|Debug/trace|uart|—|supported}}
{{pd|arm_itm|ARM ITM|ARM Instrumentation Trace Macroblock|ARM Cortex-M / ARMv7m ITM trace protocol.|Debug/trace|uart|—|supported}}
{{pd|arm_tpiu|ARM TPIU|ARM Trace Port Interface Unit|Filter TPIU formatted trace data into separate streams.|Debug/trace|uart|uart|supported}}
{{pd|atsha204a|ATSHA204A|Microchip ATSHA204A|Microchip ATSHA204A family crypto authentication protocol.|Security/crypto, IC, Memory|i2c|—|supported}}
{{pd|aud|AUD|Advanced User Debugger|Renesas/Hitachi Advanced User Debugger (AUD) protocol.|Debug/trace|logic|—|supported}}
{{pd|avr_isp|AVR ISP|AVR In-System Programming|Atmel AVR In-System Programming (ISP) protocol.|Debug/trace|spi|—|supported}}
{{pd|avr_pdi|AVR PDI|Atmel Program and Debug Interface|Atmel ATxmega Program and Debug Interface (PDI) protocol.|Debug/trace|logic|—|supported}}
{{pd|caliper|Caliper|Digital calipers|Protocol of cheap generic digital calipers.|Analog/digital, Sensor|logic|—|supported}}
{{pd|can|CAN|Controller Area Network|Field bus protocol for distributed realtime control.|Automotive|logic|—|supported}}
{{pd|cc1101|CC1101|Texas Instruments CC1101|Low-power sub-1GHz RF transceiver chip.|IC, Wireless/RF|spi|—|supported}}
{{pd|cec|CEC|HDMI-CEC|HDMI Consumer Electronics Control (CEC) protocol.|Display, PC|logic|—|supported}}
{{pd|cfp|CFP|100 Gigabit C form-factor pluggable|100 Gigabit C form-factor pluggable (CFP) protocol.|Networking|mdio|—|supported}}
{{pd|cjtag|cJTAG|Compact Joint Test Action Group (IEEE 1149.7)|Protocol for testing, debugging, and flashing ICs.|Debug/trace|logic|jtag|supported}}
{{pd|counter|Counter|Edge counter|Count the number of edges in a signal.|Util|logic|—|supported}}
{{pd|dali|DALI|Digital Addressable Lighting Interface|Digital Addressable Lighting Interface (DALI) protocol.|Embedded/industrial, Lighting|logic|—|supported}}
{{pd|dcf77|DCF77|DCF77 time protocol|European longwave time signal (77.5kHz carrier signal).|Clock/timing|logic|—|supported}}
{{pd|dmx512|DMX512|Digital MultipleX 512|Digital MultipleX 512 (DMX512) lighting protocol.|Embedded/industrial, Lighting|uart|dmx512|supported}}
{{pd|ds1307|DS1307|Dallas DS1307|Dallas DS1307 realtime clock module protocol.|Clock/timing, IC|i2c|—|supported}}
{{pd|ds2408|DS2408|Maxim DS2408|1-Wire 8-channel addressable switch.|Embedded/industrial, IC|onewire_network|—|supported}}
{{pd|ds243x|DS243x|Maxim DS2432/3|Maxim DS243x series 1-Wire EEPROM protocol.|IC, Memory|onewire_network|—|supported}}
{{pd|ds28ea00|DS28EA00|Maxim DS28EA00 1-Wire digital thermometer|1-Wire digital thermometer with Sequence Detect and PIO.|IC, Sensor|onewire_network|—|supported}}
{{pd|dsi|DSI|Digital Serial Interface|Digital Serial Interface (DSI) lighting protocol.|Embedded/industrial, Lighting|logic|—|supported}}
{{pd|edid|EDID|Extended Display Identification Data|Data structure describing display device capabilities.|Display, Memory, PC|i2c|—|supported}}
{{pd|eeprom24xx|24xx EEPROM|24xx I²C EEPROM|24xx series I²C EEPROM protocol.|IC, Memory|i2c|—|supported}}
{{pd|eeprom93xx|93xx EEPROM|93xx Microwire EEPROM|93xx series Microwire EEPROM protocol.|IC, Memory|microwire|—|supported}}
{{pd|em4100|EM4100|RFID EM4100|EM4100 100-150kHz RFID protocol.|IC, RFID|logic|—|supported}}
{{pd|em4305|EM4305|RFID EM4205/EM4305|EM4205/EM4305 100-150kHz RFID protocol.|IC, RFID|logic|—|supported}}
{{pd|enc28j60|ENC28J60|Microchip ENC28J60|Microchip ENC28J60 10Base-T Ethernet controller protocol.|Embedded/industrial, Networking|spi|—|supported}}
{{pd|flexray|FlexRay|FlexRay|Automotive network communications protocol.|Automotive|logic|—|supported}}
{{pd|graycode|Gray code|Gray code and rotary encoder|Accumulate rotary encoder increments, provide statistics.|Encoding|logic|—|supported}}
{{pd|guess_bitrate|Guess bitrate|Guess bitrate/baudrate|Guess the bitrate/baudrate of a UART (or other) protocol.|Clock/timing, Util|logic|—|supported}}
{{pd|hdcp|HDCP|HDCP over HDMI|HDCP protocol over HDMI.|PC, Security/crypto|i2c|hdcp|supported}}
{{pd|i2c|I²C|Inter-Integrated Circuit|Two-wire, multi-master, serial bus.|Embedded/industrial|logic|i2c|supported}}
{{pd|i2cdemux|I²C demux|I²C demultiplexer|Demux I²C packets into per-slave-address streams.|Util|i2c|—|supported}}
{{pd|i2cfilter|I²C filter|I²C filter|Filter out addresses/directions in an I²C stream.|Util|i2c|i2c|supported}}
{{pd|i2s|I²S|Integrated Interchip Sound|Serial bus for connecting digital audio devices.|Audio, PC|logic|i2s|supported}}
{{pd|ieee488|IEEE-488|IEEE-488 GPIB/HPIB/IEC|IEEE-488 General Purpose Interface Bus (GPIB/HPIB or IEC).|PC, Retro computing|logic|ieee488|supported}}
{{pd|ir_irmp|IR IRMP|IR IRMP|IRMP infrared remote control multi protocol.|IR|logic|—|supported}}
{{pd|ir_nec|IR NEC|IR NEC|NEC infrared remote control protocol.|IR|logic|—|supported}}
{{pd|ir_rc5|IR RC-5|IR RC-5|RC-5 infrared remote control protocol.|IR|logic|—|supported}}
{{pd|ir_rc6|IR RC-6|IR RC-6|RC-6 infrared remote control protocol.|IR|logic|—|supported}}
{{pd|ir_sirc|IR SIRC|Sony IR (SIRC)|Sony infrared remote control protocol (SIRC).|IR|logic|—|supported}}
{{pd|jitter|Jitter|Timing jitter calculation|Retrieves the timing jitter between two digital signals.|Clock/timing, Util|logic|—|supported}}
{{pd|jtag|JTAG|Joint Test Action Group (IEEE 1149.1)|Protocol for testing, debugging, and flashing ICs.|Debug/trace|logic|jtag|supported}}
{{pd|jtag_ejtag|JTAG / EJTAG|Joint Test Action Group / EJTAG (MIPS)|MIPS EJTAG protocol.|Debug/trace|jtag|—|supported}}
{{pd|jtag_stm32|JTAG / STM32|Joint Test Action Group / ST STM32|ST STM32-specific JTAG protocol.|Debug/trace|jtag|—|supported}}
{{pd|lfast|LFAST|NXP LFAST interface|Differential high-speed P2P interface|Embedded/industrial|logic|lfast|supported}}
{{pd|lin|LIN|Local Interconnect Network|Local Interconnect Network (LIN) protocol.|Automotive|uart|—|supported}}
{{pd|lm75|LM75|National LM75|National LM75 (and compatibles) temperature sensor.|Sensor|i2c|—|supported}}
{{pd|lpc|LPC|Low Pin Count|Protocol for low-bandwidth devices on PC mainboards.|PC|logic|—|supported}}
{{pd|ltc242x|LTC242x|Linear Technology LTC242x|Linear Technology LTC2421/LTC2422 1-/2-channel 20-bit ADC.|IC, Analog/digital|spi|—|supported}}
{{pd|ltc26x7|LTC26x7|Linear Technology LTC26x7|Linear Technology LTC26x7 16-/14-/12-bit rail-to-rail DACs.|IC, Analog/digital|i2c|—|supported}}
{{pd|maple_bus|Maple bus|SEGA Maple bus|Maple bus peripheral protocol for SEGA Dreamcast.|Retro computing|logic|—|supported}}
{{pd|max7219|MAX7219|Maxim MAX7219/MAX7221|Maxim MAX72xx series 8-digit LED display driver.|Display|spi|—|supported}}
{{pd|mcs48|MCS-48|Intel MCS-48|Intel MCS-48 external memory access protocol.|Retro computing|logic|—|supported}}
{{pd|mdio|MDIO|Management Data Input/Output|MII management bus between MAC and PHY.|Networking|logic|mdio|supported}}
{{pd|microwire|Microwire|Microwire|3-wire, half-duplex, synchronous serial bus.|Embedded/industrial|logic|microwire|supported}}
{{pd|midi|MIDI|Musical Instrument Digital Interface|Musical Instrument Digital Interface (MIDI) protocol.|Audio, PC|uart|—|supported}}
{{pd|mil-std-1553|MIL-STD-1553|MIL-STD-1553 avionic data bus.|MIL-STD-1553 avionic data bus protocol.|Embedded/industrial, Networking|logic|—|soon}}
{{pd|miller|Miller|Miller encoding|Miller encoding protocol.|Encoding|logic|—|supported}}
{{pd|mlx90614|MLX90614|Melexis MLX90614|Melexis MLX90614 infrared thermometer protocol.|IC, Sensor|i2c|—|supported}}
{{pd|modbus|Modbus|Modbus RTU over RS232/RS485|Modbus RTU protocol for industrial applications.|Embedded/industrial|uart|modbus|supported}}
{{pd|morse|Morse|Morse code|Demodulated morse code protocol.|Encoding|logic|—|supported}}
{{pd|mrf24j40|MRF24J40|Microchip MRF24J40|IEEE 802.15.4 2.4 GHz RF tranceiver chip.|IC, Wireless/RF|spi|—|supported}}
{{pd|mxc6225xu|MXC6225XU|MEMSIC MXC6225XU|Digital Thermal Orientation Sensor (DTOS) protocol.|IC, Sensor|i2c|—|supported}}
{{pd|nes_gamepad|NES gamepad|Nintendo Entertainment System gamepad|NES gamepad button states.|Retro computing|spi|—|supported}}
{{pd|nrf24l01|nRF24L01(+)|Nordic Semiconductor nRF24L01(+)|2.4GHz RF transceiver chip.|IC, Wireless/RF|spi|—|supported}}
{{pd|nrf905|nRF905|Nordic Semiconductor nRF905|433/868/933MHz transceiver chip.|IC, Wireless/RF|spi|—|supported}}
{{pd|numbers_and_state|Numbers and State|Interpret bit patters as numbers or state enums|Interpret bit patterns as different kinds of numbers (integer, float, enum).|Encoding, Util|logic|numbers_and_state|supported}}
{{pd|nunchuk|Nunchuk|Nintendo Wii Nunchuk|Nintendo Wii Nunchuk controller protocol.|Sensor|i2c|—|supported}}
{{pd|onewire_link|1-Wire link layer|1-Wire serial communication bus (link layer)|Bidirectional, half-duplex, asynchronous serial bus.|Embedded/industrial|logic|onewire_link|supported}}
{{pd|onewire_network|1-Wire network layer|1-Wire serial communication bus (network layer)|Bidirectional, half-duplex, asynchronous serial bus.|Embedded/industrial|onewire_link|onewire_network|supported}}
{{pd|ook|OOK|On-off keying|On-off keying protocol.|Encoding|logic|ook|supported}}
{{pd|ook_oregon|Oregon|Oregon Scientific|Oregon Scientific weather sensor protocol.|Sensor|ook|—|supported}}
{{pd|ook_vis|OOK visualisation|On-off keying visualisation|OOK visualisation in various formats.|Encoding|ook|ook|supported}}
{{pd|pan1321|PAN1321|Panasonic PAN1321|Bluetooth RF module with Serial Port Profile (SPP).|Wireless/RF|uart|—|supported}}
{{pd|parallel|Parallel|Parallel sync bus|Generic parallel synchronous bus.|Util|logic|parallel|supported}}
{{pd|pca9571|PCA9571|NXP PCA9571|NXP PCA9571 8-bit I²C output expander.|Embedded/industrial, IC|i2c|—|supported}}
{{pd|pjdl|PJDL|Padded Jittering Data Link|PJDL, a single wire serial link layer for PJON.|Embedded/industrial|logic|pjon_link|supported}}
{{pd|pjon|PJON|PJON|The PJON protocol.|Embedded/industrial|pjon_link|—|supported}}
{{pd|ps2|PS/2|PS/2|PS/2 keyboard/mouse interface.|PC|logic|—|supported}}
{{pd|pwm|PWM|Pulse-width modulation|Analog level encoded in duty cycle percentage.|Encoding|logic|—|supported}}
{{pd|qi|Qi|Qi charger protocol|Protocol used by Qi receiver.|Embedded/industrial, Wireless/RF|logic|—|supported}}
{{pd|rc_encode|RC encode|Remote control encoder|PT2262/HX2262/SC5262 remote control encoder protocol.|IC, IR|logic|—|supported}}
{{pd|rfm12|RFM12|HopeRF RFM12|HopeRF RFM12 wireless transceiver control protocol.|Wireless/RF|spi|—|supported}}
{{pd|rgb_led_spi|RGB LED (SPI)|RGB LED string decoder (SPI)|RGB LED string protocol (RGB values clocked over SPI).|Display|spi|—|supported}}
{{pd|rgb_led_ws281x|RGB LED (WS281x)|RGB LED string decoder (WS281x)|RGB LED string protocol (WS281x).|Display, IC|logic|—|supported}}
{{pd|rtc8564|RTC-8564|Epson RTC-8564 JE/NB|Realtime clock module protocol.|Clock/timing|i2c|—|supported}}
{{pd|sae_j1850_vpw|SAE J1850 VPW|SAE J1850 VPW.|SAE J1850 Variable Pulse Width 1x and 4x.|Automotive|logic|—|supported}}
{{pd|sbus_futaba|SBUS (Futaba)|Futaba SBUS (Serial bus)|Serial bus for hobby remote control by Futaba|Remote Control|uart|sbus_futaba|supported}}
{{pd|sda2506|SDA2506|Siemens SDA 2506-5|Serial nonvolatile 1-Kbit EEPROM.|IC, Memory|logic|—|supported}}
{{pd|sdcard_sd|SD card (SD mode)|Secure Digital card (SD mode)|Secure Digital card (SD mode) low-level protocol.|Memory|logic|—|supported}}
{{pd|sdcard_spi|SD card (SPI mode)|Secure Digital card (SPI mode)|Secure Digital card (SPI mode) low-level protocol.|Memory|spi|—|supported}}
{{pd|sdq|SDQ|Texas Instruments SDQ|Texas Instruments SDQ. The SDQ protocol is also used by Apple.|Embedded/industrial|logic|—|supported}}
{{pd|seven_segment|7-segment|7-segment display|7-segment display protocol.|Display|logic|—|supported}}
{{pd|signature|Signature|Signature analysis|Annotate signature of logic patterns.|Debug/trace, Util, Encoding|logic|—|supported}}
{{pd|sipi|SIPI (Zipwire)|NXP SIPI interface|Serial Inter-Processor Interface (SIPI) aka Zipwire, aka HSSL|Embedded/industrial|lfast|none|supported}}
{{pd|sle44xx|SLE 44xx|SLE44xx memory card|SLE 4418/28/32/42 memory card serial protocol|Memory|logic|—|supported}}
{{pd|spdif|S/PDIF|Sony/Philips Digital Interface Format|Serial bus for connecting digital audio devices.|Audio, PC|logic|—|supported}}
{{pd|spi|SPI|Serial Peripheral Interface|Full-duplex, synchronous, serial bus.|Embedded/industrial|logic|spi|supported}}
{{pd|spiflash|SPI flash/EEPROM|SPI flash/EEPROM chips|xx25 series SPI (NOR) flash/EEPROM chip protocol.|IC, Memory|spi|—|supported}}
{{pd|ssi32|SSI32|Synchronous Serial Interface (32bit)|Synchronous Serial Interface (32bit) protocol.|Embedded/industrial|spi|—|supported}}
{{pd|st25r39xx|ST25R39xx|STMicroelectronics ST25R39xx|High performance NFC universal device and EMVCo reader protocol.|IC, Wireless/RF|spi|—|supported}}
{{pd|st7735|ST7735|Sitronix ST7735|Sitronix ST7735 TFT controller protocol.|Display, IC|logic|—|supported}}
{{pd|stepper_motor|Stepper motor|Stepper motor position / speed|Absolute position and movement speed from step/dir.|Embedded/industrial|logic|—|supported}}
{{pd|swd|SWD|Serial Wire Debug|Two-wire protocol for debug access to ARM CPUs.|Debug/trace|logic|swd|supported}}
{{pd|swim|SWIM|STM8 SWIM bus|STM8 Single Wire Interface Module (SWIM) protocol.|Debug/trace|logic|—|supported}}
{{pd|t55xx|T55xx|RFID T55xx|T55xx 100-150kHz RFID protocol.|IC, RFID|logic|—|supported}}
{{pd|tca6408a|TI TCA6408A|Texas Instruments TCA6408A|Texas Instruments TCA6408A 8-bit I²C I/O expander.|Embedded/industrial, IC|i2c|—|supported}}
{{pd|tdm_audio|TDM audio|Time division multiplex audio|TDM multi-channel audio protocol.|Audio|logic|—|supported}}
{{pd|timing|Timing|Timing calculation with frequency and averaging|Calculate time between edges.|Clock/timing, Util|logic|—|supported}}
{{pd|tlc5620|TI TLC5620|Texas Instruments TLC5620|Texas Instruments TLC5620 8-bit quad DAC.|IC, Analog/digital|logic|—|supported}}
{{pd|uart|UART|Universal Asynchronous Receiver/Transmitter|Asynchronous, serial bus.|Embedded/industrial|logic|uart|supported}}
{{pd|usb_packet|USB packet|Universal Serial Bus (LS/FS) packet|USB (low-speed and full-speed) packet protocol.|PC|usb_signalling|usb_packet|supported}}
{{pd|usb_power_delivery|USB PD|USB Power Delivery|USB Power Delivery protocol.|PC|logic|usb_pd|supported}}
{{pd|usb_request|USB request|Universal Serial Bus (LS/FS) transaction/request|USB (low-speed/full-speed) transaction/request protocol.|PC|usb_packet|usb_request|supported}}
{{pd|usb_signalling|USB signalling|Universal Serial Bus (LS/FS) signalling|USB (low-speed/full-speed) signalling protocol.|PC|logic|usb_signalling|supported}}
{{pd|wiegand|Wiegand|Wiegand interface|Wiegand interface for electronic entry systems.|Embedded/industrial, RFID|logic|—|supported}}
{{pd|x2444m|X2444M/P|Xicor X2444M/P|Xicor X2444M/P nonvolatile static RAM protocol.|IC, Memory|spi|—|supported}}
{{pd|xfp|XFP|10 Gigabit Small Form Factor Pluggable Module (XFP)|XFP I²C management interface structures/protocol|Networking|i2c|—|supported}}
{{pd|xy2-100|XY2-100|XY2-100 and XY2-200 interface|XY2-100 protocol used for laser applications.|Embedded/industrial|logic|—|supported}}
{{pd|z80|Z80|Zilog Z80 CPU|Zilog Z80 microprocessor disassembly.|Retro computing|logic|—|supported}}

|}

== Possible candidates for future protocol decoders ==

{| border="0" style="font-size: smaller" class="alternategrey sortable sigroktable"
|-
!Protocol
!Category
!Input ID(s)
!Output ID(s)
!Status
!Description
!Comments

|-
| SA8807A
| Displays
| spi
|
| bgcolor="red" | 0%
| SPI-attached LCD. Datasheet: [http://pdf1.alldatasheet.com/datasheet-pdf/view/36922/SAMES/SA8807A.html Sames SA8807A].
|

|-
| EA eDIPTFT43-A
| Displays
| i2c
|
| bgcolor="red" | 0%
| I2C-attached LCD. Datasheet: [http://www.lcd-module.de/pdf/grafik/ediptft43-a.pdf EA eDIPTFT43-A].
|

|-
| Analog Devices AD7291
| ADC
| i2c
|
| bgcolor="red" | 0%
| I2C-attached ADC. Datasheet: [http://pdf1.alldatasheet.com/datasheet-pdf/view/318172/AD/AD7291.html Analog Devices AD7291].
|

|-
| Analog Devices ADS1258
| ADC
| spi
| ads1258
| bgcolor="orange" | 0%
| SPI-attached ADC.
| Planned (Uwe Hermann).

|-
| [https://en.wikipedia.org/wiki/ccTalk ccTalk]
| Automation/Industrial
| uart
| cctalk
| bgcolor="red" | 20%
| Serial protocol in widespread use throughout the money transaction and point-of-sale industry.
|In progress - https://github.com/plaes/libsigrokdecode/tree/cctalk

|-
| Microchip MCP3901
| ADC
| spi
| mcp3901
| bgcolor="orange" | 0%
| Can be controlled via a parallel protocol, or SPI, or I2C.
| Planned (Uwe Hermann).

|-
| JTAG / TMPA9xx
| Flash/debug
| jtag
| jtag_tmpa9xx
| bgcolor="red" | 0%
| Toshiba TMPA9xx specific JTAG protocol details.
|

|-
| USB transfer
| USB
| usb_request
| usb_transfer
| bgcolor="red" | 0%
|
|

|-
| USB / HID
| USB
| usb_transfer
| usb_hid
| bgcolor="red" | 0%
|
|

|-
| USB / CDC
| USB
| usb_transfer
| usb_cdc
| bgcolor="red" | 0%
|
|

|-
| USB / USBTMC
| USB
| usb_transfer
| usb_usbtmc
| bgcolor="red" | 0%
|
|

|-
| Dallas DS1985
| Other
| onewire_network
|
| bgcolor="orange" | 0%
| Dallas DS1985 iButton (1-Wire) device.
| Planned (Uwe Hermann).

|-
| UNI/O
| Embedded
| —
|
| bgcolor="red" | 0%
|
|

|-
| [https://en.wikipedia.org/wiki/Synchronous_Serial_Interface SSI]
| Embedded
| —
|
| bgcolor="red" | 0%
| Synchronous Serial Interface
|

|-
| CompactFlash
| Memory
| —
|
| bgcolor="red" | 0%
|
|

|-
| MMC
| Memory
| —
|
| bgcolor="red" | 0%
|
|

|-
| Memory Stick
| Memory
| —
|
| bgcolor="red" | 0%
|
|

|-
| SmartMedia
| Memory
| —
|
| bgcolor="red" | 0%
|
|

|-
| xD-Picture Card
| Memory
| —
|
| bgcolor="red" | 0%
|
|

|-
| [https://en.wikipedia.org/wiki/ISO/IEC_7816 ISO 7816]
| Smartcards
| —
|
| bgcolor="red" | 0%
|
|

|-
| AVR TPI
| Flash/debug
| —
|
| bgcolor="red" | 0%
| Atmel Tiny Programming Interface (TPI) protocol.
|

|-
| FWH
| PC
| —
|
| bgcolor="red" | 0%
|
|

|-
| ISA
| PC
| —
|
| bgcolor="red" | 0%
|
|

|-
| PCI
| PC
| —
|
| bgcolor="red" | 0%
|
|

|-
| SMBus
| PC
| —
|
| bgcolor="red" | 0%
|
|

|-
| IDE
| PC
| —
|
| bgcolor="red" | 0%
|
|

|-
| SCSI
| PC
| —
|
| bgcolor="red" | 0%
|
|

|-
| [https://en.wikipedia.org/wiki/Platform_Environment_Control_Interface PECI]
| PC
| —
|
| bgcolor="red" | 0%
| Platform Environment Control Interface
|

|-
| [https://en.wikipedia.org/wiki/SVID SVID]
| PC
| —
|
| bgcolor="red" | 0%
| Serial Voltage Identification
|

|-
| [[Protocol_decoder:mfm|MFM]]
| PC
| —
|
| bgcolor="yellow" | 90%
| Floppy disk FM and [https://en.wikipedia.org/wiki/Modified_Frequency_Modulation MFM].
| Work in progress (David Wiens).

|-
| HD Audio
| Audio
| —
|
| bgcolor="red" | 0%
|
|

|-
| Nokia NRC17
| IR
| —
|
| bgcolor="red" | 0%
|
|

|-
| Philips RC-MM
| IR
| —
|
| bgcolor="red" | 0%
|
|

|-
| Philips RECS80
| IR
| —
|
| bgcolor="red" | 0%
|
|

|-
| [http://en.wikipedia.org/wiki/Infrared_Data_Association IrDA]
| Misc
| —
|
| bgcolor="red" | 0%
|
|

|-
| HD44780
| Displays
| —
|
| bgcolor="red" | 0%
| [http://en.wikipedia.org/wiki/HD44780_Character_LCD HD44780 character LCD] protocol
|

|-
| [[Protocol_decoder:Pcf8814|PCF8814]]
| Displays
| —
| pcf8814
| bgcolor="yellow" | 50%
| Philips PCF8814 65 x 96 pixels matrix LCD driver
| Work in progress (Uwe Hermann).

|-
| [[Protocol_decoder:Pcf8814_lcd|PCF8814 LCD]]
| Displays
| pcf8814
| pcf8814_lcd
| bgcolor="yellow" | 50%
| Philips PCF8814 65 x 96 pixels matrix LCD driver
| Work in progress (Uwe Hermann).

|-
| [https://en.wikipedia.org/wiki/RDM_%28lighting%29 RDM]
| Industrial Lighting
| —
| rdm
| bgcolor="red" | 0%
|
|

|-
| [https://en.wikipedia.org/wiki/NMEA_0183 NMEA 0183]
| GPS
| uart
| nmea0183
| bgcolor="red" | 0%
|
|

|-
| [[Protocol_decoder:Nmea2000|NMEA2000]]
| Marine
| can
| nmea2000
| bgcolor="red" | 0%
| [https://en.wikipedia.org/wiki/NMEA_2000 NMEA 2000 Wikipedia page]
|

|-
| [https://en.wikipedia.org/wiki/Digital_Command_Control DCC]
| Trains
| —
| dcc
| bgcolor="red" | 0%
|
|

|-
| [https://en.wikipedia.org/wiki/Train_Communication_Network MVB]
| Trains
| —
| mvb
| bgcolor="yellow" | 90%
| Multifunction Vehicle Bus
| Working in separate [https://github.com/yeckel/sigrok_mvb_decoder/ repository] (Libor Tomsik).

|-
| [https://en.wikipedia.org/wiki/Train_Communication_Network WTB]
| Trains
| —
| wtb
| bgcolor="red" | 0%
| Wire Train Bus
|

|-
| [https://en.wikipedia.org/wiki/C-Bus_%28protocol%29 C-Bus]
| Home automation
| —
| cbus
| bgcolor="red" | 0%
|
|

|-
| [https://en.wikipedia.org/wiki/X10_%28industry_standard%29 X10]
| Home automation
| —
| x10
| bgcolor="red" | 0%
|
|

|-
| [https://en.wikipedia.org/wiki/LonWorks LonWorks]
| Home automation
| —
| lonworks
| bgcolor="red" | 0%
|
|

|-
| [https://en.wikipedia.org/wiki/Meter-Bus M-Bus]
| Automation
| —
| mbus
| bgcolor="red" | 0%
|
|

|-
| [https://en.wikipedia.org/wiki/Modbus Modbus ASCII]
| Automation
| uart
| modbus
| bgcolor="red" | 0%
|
|

|-
| [https://en.wikipedia.org/wiki/Modbus Modbus TCP]
| Automation
| ip
| modbus
| bgcolor="red" | 0%
|
|

|-
| [https://en.wikipedia.org/wiki/Highway_Addressable_Remote_Transducer_Protocol HART protocol]
| Automation
| —
| hart
| bgcolor="red" | 0%
|
|

|-
| [https://en.wikipedia.org/wiki/INTERBUS INTERBUS]
| Automation
| —
| interbus
| bgcolor="red" | 0%
|
|

|-
| [https://en.wikipedia.org/wiki/DirectNET_Protocol DirectNET]
| Automation
| uart
| directnet
| bgcolor="red" | 0%
|
|

|-
| [https://en.wikipedia.org/wiki/KNX_%28standard%29 KNX]
| Automation
| various
| knx
| bgcolor="red" | 0%
|
|

|-
| [https://en.wikipedia.org/wiki/Bacnet BACnet]
| Automation
|
| bacnet
| bgcolor="red" | 0%
|
|

|-
| [https://en.wikipedia.org/wiki/OpenTherm OpenTherm]
| Automation
| —
| opentherm
| bgcolor="red" | 0%
|
|

|-
| [https://en.wikipedia.org/wiki/EBUS_%28serial_buses%29 EBUS]
| Automation
| uart
| ebus
| bgcolor="red" | 0%
|
|

|-
| [https://en.wikipedia.org/wiki/Attachment_Unit_Interface AUI]
| Networking
| —
| aui
| bgcolor="red" | 0%
| Attachment Unit Interface
|

|-
| [https://en.wikipedia.org/wiki/Medium_Dependent_Interface MDI]
| Networking
| —
| mdi
| bgcolor="red" | 0%
| Medium Dependent Interface
|

|-
| [https://en.wikipedia.org/wiki/Media_Independent_Interface MII]
| Networking
| —
| mii
| bgcolor="red" | 0%
| Media Independent Interface
|

|-
| [https://en.wikipedia.org/wiki/Gigabit_Media_Independent_Interface#Gigabit_Media_Independent_Interface GMII]
| Networking
| —
| gmii
| bgcolor="red" | 0%
| Gigabit Media Independent Interface
|

|-
| [https://en.wikipedia.org/wiki/10_Gigabit_Media_Independent_Interface#10_Gigabit_Media_Independent_Interface XGMII]
| Networking
| —
| xgmii
| bgcolor="red" | 0%
| 10 Gigabit Media Independent Interface
|

|-
| [[Protocol_decoder:esp8266|ESP8266]]
| Wireless
| uart
| esp8266
| bgcolor="red" | 0%
| WiFi Serial Transceiver
|

|-
| [[Protocol Decoder:tmds|TMDS (HDMI / DVI Pixel Data)]]
| Display
| tmds
| —
| bgcolor="orange" | 1%
| https://github.com/mithro/tmds_encoding
| Work in progress ([[User:Mithro|mithro]])

|-
| [[Protocol Decoder:Easymatic|Easymatic]]
| Home automation
| uart
| easymatic
| bgcolor="red" | 10%
|
| Work in progress (Platypus)

|-
| [[Protocol Decoder:DDC/CI|DDC/CI]]
| PC
| i2c
| —
| bgcolor="red" | 0%
|
|

|-
| Kenwood VH
| Misc
| —
| —
| bgcolor="yellow" | 50%
| SYSTEM CONTROL protocol used by Kenwood's VH HiFi-system
| In progress: https://github.com/kripton/libsigrokdecode/compare/kenwood_vh

|-
| IEC 61131-9
| Industrial
| —
| —
| bgcolor="red" | 0%
| "Single-drop digital communication interface for small sensors and actuators (SDCI, marketed as IO-Link)" https://en.wikipedia.org/wiki/IEC_61131
|

|-
| NRZ encoding family
| —
| —
| —
| bgcolor="red" | 0%
| Non-Return-to-Zero and its [https://en.wikipedia.org/wiki/Non-return-to-zero#Variants variants]
| whoever wants it

|-
| Bi-Phase encoding family
| —
| —
| —
| bgcolor="red" | 0%
| [http://ckp.made-it.com/encodingschemes.html several variations] of codes, including [https://en.wikipedia.org/wiki/Manchester_code Manchester code]
| whoever wants it

|-
| Sony LANC
| —
| —
| —
| bgcolor="red" | 0%
| [http://www.boehmel.de/lanc.htm Sony LANC]
| whoever wants it, contact [[User:Alexdaniel|AlexDaniel]] for more info. You can already decode the raw data by using UART with 9600 baud and no parity, but it'd be better if pulseview displayed the meaning (as in what these commands do)

|-
| CCD (Chrysler's Collision Detection)
| —
| —
| —
| bgcolor="green" | 99%
| CCD (Chrysler's Collision Detection) is internal bus used on Chrysler cars produced about 1990-2000.
| It works, but decodes only subset of all possible CCD messages, mostly from Jeep ZJ '98. Need a little work to improve performance and better support of API 3. [https://github.com/majekw/sigrok-ccd-pd https://github.com/majekw/sigrok-ccd-pd]

|-
| Mate-trac
| —
| (bi-phase)
| —
| bgcolor="red" | 0%
| 20th century protocol for remote control of projectors, often stored on audio tapes; [https://www.aidtopia.com/mccarthy/aid/multi-image/matetrac.html described well by Adrian McCarthy]
| whoever wants it, possibly [[User:chrysn|chrysn]]

|-
| PN532 NFC reader communication protocol
| NFC
| uart / spi / i2c
| ISO14443
| bgcolor="yellow" | 80%
| PN532 is a 13.56 MHz NFC reader, supporting SPI, I2C or Serial UART
| WIP for Serial UART: [https://github.com/plaes/libsigrokdecode/tree/pn542-uart https://github.com/plaes/libsigrokdecode/tree/pn542-uart] based on [https://git.mittelab.org/wifasoi/sigrokdecode-pn532 code from this repository]

|-
| SAE J2716 SENT
| Automotive
| —
|
| bgcolor="red" | 0%
| SENT - Single Edge Nibble Transmission for Automotive Applications
|

|}

__FORCETOC__

Protocol decoder HOWTO

2023-05-02T18:03:23Z

LiborT: Adopted for new API

This page serves as a quick-start guide for people who want to write their own [[libsigrokdecode]] protocol decoders ([[Protocol decoders|PDs]]).

It is '''not''' intended to replace the [[Protocol decoder API]] page, but rather to give a short overview/tutorial and some tips.

== Introduction ==

Protocol decoders are written entirely in Python (>= 3.0).

== Files ==

Every protocol decoder is a Python module and has its own subdirectory in libsigrokdecode's '''[http://sigrok.org/gitweb/?p=libsigrokdecode.git;a=tree;f=decoders decoders]''' directory.

This is a minimalistic example of how a protocol decoder looks like, in this case the '''[[Protocol_decoder:I2c|i2c]]''' decoder (license header, comments, and some other parts omitted).

'''Note''': Do not start new protocol decoders by copying code from here. Instead, it's recommended to select an already existing decoder in the source code which is similar to the one you plan to write, and copy that as a starting point.

=== __init__.py ===


<source lang="python">
'''
I²C (Inter-Integrated Circuit) is a bidirectional, multi-master
bus using two signals (SCL = serial clock line, SDA = serial data line).

<Insert notes and hints for the user here>
'''

from .pd import Decoder
</source>


This is a standard Python file, required in every Python module. It contains a module-level docstring, which is accessible by frontends via the [http://sigrok.org/api/libsigrokdecode/unstable/index.html libsigrokdecode API]. It should contain a (very) short description of what the protocol (in this case [[Protocol_decoder:I2c|I²C]]) is about, and some notes and hints for the user of this protocol decoder (which can be shown in GUIs when the user selects/browses different PDs).

This docstring should '''not''' contain the full, extensive protocol description. Instead, the per-PD wiki page should be used for protocol description, photos of devices or photos of example acquisition setups, and so on. Each decoder has one unique wiki page at the URL '''<nowiki>http://sigrok.org/wiki/Protocol_decoder:<pd></nowiki>''', where '''<pd>''' is the Python module name of the decoder ('''i2c''' in this case). Some examples for such per-PD wiki pages: [[Protocol_decoder:Uart|UART]], [[Protocol_decoder:Pan1321|PAN1321]], [[Protocol_decoder:Mx25lxx05d|MX25Lxx05D]], [[Protocol_decoder:Dcf77|DCF77]].

The "'''from .pd import Decoder'''" line will make sure the code from '''pd.py''' gets properly imported when this module is used.

=== pd.py ===


<source lang="python">
import sigrokdecode as srd

class Decoder(srd.Decoder):
api_version = 3
id = 'i2c'
name = 'I²C'
longname = 'Inter-Integrated Circuit'
desc = 'Two-wire, multi-master, serial bus.'
license = 'gplv2+'
inputs = ['logic']
outputs = ['i2c']
channels = (
{'id': 'scl', 'name': 'SCL', 'desc': 'Serial clock line'},
{'id': 'sda', 'name': 'SDA', 'desc': 'Serial data line'},
)
optional_channels = ()
options = (
{'id': 'address_format', 'desc': 'Displayed slave address format',
'default': 'shifted', 'values': ('shifted', 'unshifted')},
)
annotations = (
('start', 'Start condition'),
('repeat-start', 'Repeat start condition'),
('stop', 'Stop condition'),
('ack', 'ACK'),
('nack', 'NACK'),
('bit', 'Data/address bit'),
('address-read', 'Address read'),
('address-write', 'Address write'),
('data-read', 'Data read'),
('data-write', 'Data write'),
('warnings', 'Human-readable warnings'),
)
annotation_rows = (
('bits', 'Bits', (5,)),
('addr-data', 'Address/Data', (0, 1, 2, 3, 4, 6, 7, 8, 9)),
('warnings', 'Warnings', (10,)),
)

def __init__(self, **kwargs):
self.state = 'FIND START'
# And various other variable initializations...

def metadata(self, key, value):
if key == srd.SRD_CONF_SAMPLERATE:
self.samplerate = value

def reset(self):
#reset inner states

def start(self):
self.out_ann = self.register(srd.OUTPUT_ANN)

def decode(self):
decode_the_sample(self.wait())

</source>


The recommended name for the actual decoder file is '''pd.py'''. This file contains some meta information about the decoder, and the actual code itself, mostly in the '''decode()''' method.

If needed, large unwieldy lists or similar things can also be factored out into another *.py file (examples: [http://sigrok.org/gitweb/?p=libsigrokdecode.git;a=tree;f=decoders/midi midi], [http://sigrok.org/gitweb/?p=libsigrokdecode.git;a=tree;f=decoders/z80 z80]).

== Copyright and license ==

Every protocol decoder '''must''' come with source code in the form of '''*.py''' files. No pre-compiled code should be present, Python or otherwise. The PD must not use any helpers that are not provided as source code under the same license as the PD itself.

The '''<tt>Decoder</tt>''' class must have a license declaration (see above), stating the license under which all the contents in the decoder's directory are provided. This is usually <tt>'gplv2+'</tt> or <tt>'gplv3+'</tt>, whichever you prefer. In either case, the decoder license must be compatible with the [[libsigrokdecode]] license (which is "GPL, version 3 or later").

== <tt>channels</tt> & <tt>optional_channels</tt> ==

The following excerpt from the [[Protocol_decoder:spi|SPI]] PD shows how to use '''<tt>channels</tt>''' and '''<tt>optional_channels</tt>'''. To decode SPI, the clock signal is always needed, the chip-select signal is optional and only used when provided. To give the user the flexibility to provide only one of the MOSI/MISO signals, they are both also defined as optional:


<source lang="python">
class Decoder(srd.Decoder):
...
id = 'spi'
...
channels = (
{'id': 'clk', 'name': 'CLK', 'desc': 'Clock'},
)
optional_channels = (
{'id': 'miso', 'name': 'MISO', 'desc': 'Master in, slave out'},
{'id': 'mosi', 'name': 'MOSI', 'desc': 'Master out, slave in'},
{'id': 'cs', 'name': 'CS#', 'desc': 'Chip-select'},
)
</source>


'''<tt>data</tt>''', the argument of the decoder's [[Protocol decoder API#decode-function|'''<tt>decode()</tt>''']] function that contains the data to decode, is a list of tuples. These tuples contain the (absolute) number of the sample and the data at that sample. To process all samples, the SPI decoder loops over '''<tt>data</tt>''' like this:


<source lang="python">
def decode(self, ss, es, data):
...
for (self.samplenum, pins) in data:
</source>


'''<tt>channels</tt>''' and '''<tt>optional_channels</tt>''' contain in total four channels, therefore the second member of the tuple is an object of Python's [https://docs.python.org/3/library/stdtypes.html#typebytes '''<tt>bytes</tt>'''] class containing 4 bytes, one for each channel. The decoder unpacks the bytes into the variables '''<tt>clk</tt>''', '''<tt>miso</tt>''', '''<tt>mosi</tt>''', and '''<tt>cs</tt>''' as shown below.

Then, it checks for the optional channels, if their value is either 0 or 1. If it is not, that optional channel is not provided to the decoder. In the case that neither of them is supplied, an exception is raised:


<source lang="python">
(clk, miso, mosi, cs) = pins
self.have_miso = (miso in (0, 1))
self.have_mosi = (mosi in (0, 1))
self.have_cs = (cs in (0, 1))

# Either MISO or MOSI (but not both) can be omitted.
if not (self.have_miso or self.have_mosi):
raise ChannelError('Either MISO or MOSI (or both) pins required.')
</source>


== <tt>annotations</tt> & <tt>annotation_rows</tt> ==

To make the relation between the '''<tt>annotations</tt>''' and the '''<tt>annotation_rows</tt>''' members of a decoder object more clear, take a look at how the [[Protocol_decoder:Ir_nec|ir_nec]] PD uses them:


<source lang="python">
class Decoder(srd.Decoder):
...
id = 'ir_nec'
...
annotations = ( # Implicitly assigned annotation type ID
('bit', 'Bit'), # 0
('agc-pulse', 'AGC pulse'), # 1
('longpause', 'Long pause'), # 2
('shortpause', 'Short pause'), # 3
('stop-bit', 'Stop bit'), # 4
('leader-code', 'Leader code'), # 5
('addr', 'Address'), # 6
('addr-inv', 'Address#'), # 7
('cmd', 'Command'), # 8
('cmd-inv', 'Command#'), # 9
('repeat-code', 'Repeat code'), # 10
('remote', 'Remote'), # 11
('warnings', 'Warnings'), # 12
)
annotation_rows = (
('bits', 'Bits', (0, 1, 2, 3, 4)),
('fields', 'Fields', (5, 6, 7, 8, 9, 10)),
('remote', 'Remote', (11,)),
('warnings', 'Warnings', (12,)),
)
</source>


It groups the first five annotation types together into the '''<tt>bits</tt>''' row and the next six into the '''<tt>fields</tt>''' row. The rows '''<tt>remote</tt>''' and '''<tt>warnings</tt>''' both only contain one annotation type.

Without '''<tt>annotation_rows</tt>''', [[PulseView]] would have to put each annotation type in its own row (which is unhandy if the decoder has many annotations) or it would have to put them all on the same row (which would result in unreadable output due to overlaps). But because of the '''<tt>annotation_rows</tt>''', the output of the [[Protocol_decoder:Ir_nec|ir_nec]] decoder is grouped together as shown in the following picture (note how different annotation types, distinguishable by their different colors, share the same row):

[[File:Pv example ir nec cropped.png]]

However, as you can imagine, handling numeric IDs is quite bothersome - especially if they change and all affected IDs have to be changed throughout the PD. To avoid this, you can use a pseudo-enum:


<source lang="python">
ann_bit, ann_agc_pulse, ann_long_pause, ann_short_pause, ann_stop_bit, ann_leader_code, ann_addr, ann_addr_inv, ann_cmd, ann_cmd_inv, ann_repeat_code, ann_remote, ann_warning = range(13)

class Decoder(srd.Decoder):
...
id = 'ir_nec'
...
annotations = ( # Implicitly assigned annotation type ID
('bit', 'Bit'), # 0 = ann_bit
('agc-pulse', 'AGC pulse'), # 1 = ann_agc_pulse
('longpause', 'Long pause'), # 2 = ann_long_pause
('shortpause', 'Short pause'), # 3 = ann_short_pause
('stop-bit', 'Stop bit'), # 4 = ann_stop_bit
('leader-code', 'Leader code'), # 5 = ann_leader_code
('addr', 'Address'), # 6 = ann_addr
('addr-inv', 'Address#'), # 7 = ann_addr_inv
('cmd', 'Command'), # 8 = ann_cmd
('cmd-inv', 'Command#'), # 9 = ann_cmd_inv
('repeat-code', 'Repeat code'), # 10 = ann_repeat_code
('remote', 'Remote'), # 11 = ann_remote
('warnings', 'Warnings'), # 12 = ann_warning
)
annotation_rows = (
('bits', 'Bits', (ann_bit, ann_agc_pulse, ann_long_pause, ann_short_pause, ann_stop_bit)),
('fields', 'Fields', (ann_leader_code, ann_addr, ann_addr_inv, ann_cmd, ann_cmd_inv, ann_repeat_code)),
('remote', 'Remote', (ann_remote,)),
('warnings', 'Warnings', (ann_warning,)),
)
</source>


This way, all you need to ensure is that the order of the enum entries is the same as in the annotations array and you're set. There is one downside, though, as always: pseudo-enums are pitifully slow in python, so if you use them and you use them in a lot of places, your protocol decoder may be significantly slower (up to 4x has been observed), so choose wisely. You can use the PD test facility to compare, using e.g. 'time ./pdtest -r $YOUR_PD'

== Random notes, tips and tricks ==

* You should usually only use '''raise''' in a protocol decoder to raise exceptions in cases which are a clear bug in how the protocol decoder is invoked (e.g. if no samplerate was provided for a PD which needs the samplerate, or if some of the required channels were not provided by the user, and so on).
* Use the <code>has_channel()</code> method to check whether an optional channel has been provided or not.
* A simple and fast way to calculate a parity (i.e., count the number of 1 bits) over a number (0x55 in this example) is:<source lang="python">
ones = bin(0x55).count('1')
</source>
* A simple function to convert a BCD number (max. 8 bits) to an integer is:<source lang="python">
def bcd2int(b):
return (b & 0x0f) + ((b >> 4) * 10)
</source> This is available as <code>from common.srdhelper import bcd2int</code>
* An elegant way to convert a sequence of bus pins to a numeric value:<source lang="python">
from functools import reduce

def reduce_bus(bus):
if 0xFF in bus:
return None # unassigned bus channels
else:
return reduce(lambda a, b: (a << 1) | b, reversed(bus))
</source>
* A nice way to construct method names according to e.g. protocol commands is (assuming '''cmd''' is 8, this would call the function '''self.handle_cmd_0x08'''):<source lang="python">
fn = getattr(self, 'handle_cmd_0x%02x' % cmd);
fn(arg1, arg2, ...)
</source>
* A cheap way to deal with Python's lack of enumerations (useful for states, pin indices, annotation indices, etc.):<source lang="python">
class Cycle:
NONE, MEMRD, MEMWR, IORD, IOWR, FETCH, INTACK = range(7)
</source>Please be aware, though, that using this mechanism may slow down your decoder significantly. It may make sense to perform some basic profiling to see if this affects you, e.g. using <code>time ./pdtest -r $YOUR_PD</code>.
** A class <code>SrdIntEnum</code> is now available from <code>common.srdhelper</code> based on Python's native [https://docs.python.org/3/library/enum.html#enum.IntEnum <code>IntEnum</code>]
* <div id="SIGROKDECODE_DIR"></div>You don't need to reinstall the whole [[libsigrokdecode]] project every time you make a change on your decoder. Instead, you can use the environment variable '''<tt>SIGROKDECODE_DIR</tt>''' to point the software to your development directory: <source lang="bash">$ SIGROKDECODE_DIR=/path/to/libsigrokdecode/decoders/ sigrok-cli … -P <decodername></source>Because this environment variable is evaluated by the [[libsigrokdecode]] code itself, it can be used for any program that uses the library, for example when calling [[PulseView]] or the '''<tt>pdtest</tt>''' unit test utility from the [http://sigrok.org/gitweb/?p=sigrok-test.git;a=summary sigrok-test] repository. If you compiled a recent [[libsigrokdecode]] by yourself ([http://sigrok.org/gitweb/?p=libsigrokdecode.git;a=commit;h=40c6ac1d3fbded276dcbff23e8bc099896ab2fb5 newer than this commit]), you can also put decoders into your home directory, without the need for an additional environment variable. On Linux systems, this name follows the [http://standards.freedesktop.org/basedir-spec/latest/ar01s03.html XDG base directory specification], which by default resolves to <tt>~/.local/share/libsigrokdecode/decoders</tt>. If that folder does not exist, you can simply create it and drop your decoders there, in their own subdirectory, like you would do in the libsigrokdecode source tree. On Windows systems additional decoders are read from <tt>%ProgramData%\libsigrokdecode\decoders</tt>.

* To debug the Python implementation of a decoder during development, maintenance or research either add <code>print()</code> statements at appropriate locations. Or get WinPDB and use the remote debugging feature as outlined below (add this hook somewhere in pd.py, then "File -> Attach" to the running process). Decoders cannot be used in "regular" debuggers since they expect a rather specific environment to execute in, for all of receiving their input as well as having their output saved or presented as well as processing samples (data types, runtime routines). Remote debugging works in both the sigrok-cli and pulseview context. Adding another <code>print()</code> statement before starting the embedded debugger can help identify the moment in time when to attach.<source lang="python">
def __init__():
import rpdb2
rpdb2.start_embedded_debugger("pd")
...
</source>

For Windows you might want to use the following code, adapting it to your Python and WinPDB-reborn version:<source lang="python">
def __init__():
import sys
sys.path.insert(0, 'c:/Program Files (x86)/Python38-32/Lib/site-packages/winpdb_reborn-2.0.0.1-py3.8.egg')
import rpdb2
rpdb2.start_embedded_debugger("pd", fAllowRemote=True)
...
</source>

== Unit tests ==

In order to keep protocol decoders in a running state even when we make changes to a decoder or libsigrokdecode itself, we use unit tests for as many decoders as we can. These are stored in the [http://sigrok.org/gitweb/?p=sigrok-test.git sigrok-test repository]. If you want to add, modify or run one of them, clone that repository and [https://sigrok.org/gitweb/?p=sigrok-test.git;a=blob;f=README check the README] for documentation.
We greatly appreciate it when you submit unit tests for your decoder so we can keep it in good health!

== Submitting your decoder ==

When you've finished your decoder and everything is working nicely, please contribute the decoder to the sigrok project so that other people can benefit from it (and test it, improve upon it, and so on).

* Check the decoder's operation in the most recent version of the software. You expect the decoder to get accepted in the project's mainline codebase. So it should work in that environment. Either build from up-to-date sources, or download nightly builds.
* Tell us about the location of your public git repo on the '''#sigrok''' IRC channel on libera.chat. As an alternative send the decoder to the [https://lists.sourceforge.net/lists/listinfo/sigrok-devel sigrok-devel] mailing list (preferrably against current master and as a full commit instead of a mere diff). Remember that pushing to a public git repo is preferred over email attachments.
* Please also make example data files (*.sr) including a small README available. Developers need these in order to properly review and test your decoder. Users need these to learn what the captures are about in the first place. Preferrably these files should also come as patches against the latest git master of the [http://sigrok.org/gitweb/?p=sigrok-dumps.git;a=tree sigrok-dumps] repository. See [[Example dumps]] for details. Submitting captures before any decoder materializes or work on a decoder even starts is very useful.
* Finally, please also consider adding a few "unit tests" for your decoder in the [http://sigrok.org/gitweb/?p=sigrok-test.git;a=tree sigrok-test] repository. These test will automatically run the decoder against various input files specified in '''test.conf''' and check whether the expected output is produced (examples: [http://sigrok.org/gitweb/?p=sigrok-test.git;a=blob;f=decoder/test/rfm12/test.conf rfm12], [http://sigrok.org/gitweb/?p=sigrok-test.git;a=blob;f=decoder/test/nrf24l01/test.conf nrf24l01]). This allows us to notice and fix any regressions in the decoder and/or the [[libsigrokdecode]] backend that may arise over time.

Thanks a lot!

[[Category:APIs]]

Protocol decoders

2023-05-02T17:49:38Z

LiborT: Assigned myself to mvb.

This is a list of '''supported protocol decoders (PDs)''' and '''decoders which we might want to write in the future''' (or users might want to contribute).

See [[Protocol decoder API]] for details on how the decoders work in sigrok, and [[Protocol decoder HOWTO]] for a quick introduction about how to write your own decoders.

== Supported protocol decoders ==



Number of currently supported protocol decoders: '''131'''.

{| border="0" style="font-size: smaller" class="alternategrey sortable sigroktable"
|-
!Protocol
!Tags
!Input IDs
!Output IDs
!Status
!Full name
!Description

{{pd|ac97|AC '97|Audio Codec '97|Audio and modem control for PC systems.|Audio, PC|logic|—|supported}}
{{pd|ad5626|AD5626|Analog Devices AD5626|Analog Devices AD5626 12-bit nanoDAC.|IC, Analog/digital|spi|—|supported}}
{{pd|ad79x0|AD79x0|Analog Devices AD79x0|Analog Devices AD7910/AD7920 12-bit ADC.|IC, Analog/digital|spi|—|supported}}
{{pd|ade77xx|ADE77xx|Analog Devices ADE77xx|Poly phase multifunction energy metering IC protocol.|Analog/digital, IC, Sensor|spi|—|supported}}
{{pd|adf435x|ADF435x|Analog Devices ADF4350/1|Wideband synthesizer with integrated VCO.|Clock/timing, IC, Wireless/RF|spi|—|supported}}
{{pd|adns5020|ADNS-5020|Avago ADNS-5020|Bidirectional optical mouse sensor protocol.|IC, PC, Sensor|spi|—|supported}}
{{pd|adxl345|ADXL345|Analog Devices ADXL345|Analog Devices ADXL345 3-axis accelerometer.|IC, Sensor|spi|—|supported}}
{{pd|am230x|AM230x|Aosong AM230x/DHTxx/RHTxx|Aosong AM230x/DHTxx/RHTxx humidity/temperature sensor.|IC, Sensor|logic|—|supported}}
{{pd|amulet_ascii|Amulet ASCII|Amulet LCD ASCII|Amulet Technologies LCD controller ASCII protocol.|Display|uart|—|supported}}
{{pd|arm_etmv3|ARM ETMv3|ARM Embedded Trace Macroblock v3|ARM ETM v3 instruction trace protocol.|Debug/trace|uart|—|supported}}
{{pd|arm_itm|ARM ITM|ARM Instrumentation Trace Macroblock|ARM Cortex-M / ARMv7m ITM trace protocol.|Debug/trace|uart|—|supported}}
{{pd|arm_tpiu|ARM TPIU|ARM Trace Port Interface Unit|Filter TPIU formatted trace data into separate streams.|Debug/trace|uart|uart|supported}}
{{pd|atsha204a|ATSHA204A|Microchip ATSHA204A|Microchip ATSHA204A family crypto authentication protocol.|Security/crypto, IC, Memory|i2c|—|supported}}
{{pd|aud|AUD|Advanced User Debugger|Renesas/Hitachi Advanced User Debugger (AUD) protocol.|Debug/trace|logic|—|supported}}
{{pd|avr_isp|AVR ISP|AVR In-System Programming|Atmel AVR In-System Programming (ISP) protocol.|Debug/trace|spi|—|supported}}
{{pd|avr_pdi|AVR PDI|Atmel Program and Debug Interface|Atmel ATxmega Program and Debug Interface (PDI) protocol.|Debug/trace|logic|—|supported}}
{{pd|caliper|Caliper|Digital calipers|Protocol of cheap generic digital calipers.|Analog/digital, Sensor|logic|—|supported}}
{{pd|can|CAN|Controller Area Network|Field bus protocol for distributed realtime control.|Automotive|logic|—|supported}}
{{pd|cc1101|CC1101|Texas Instruments CC1101|Low-power sub-1GHz RF transceiver chip.|IC, Wireless/RF|spi|—|supported}}
{{pd|cec|CEC|HDMI-CEC|HDMI Consumer Electronics Control (CEC) protocol.|Display, PC|logic|—|supported}}
{{pd|cfp|CFP|100 Gigabit C form-factor pluggable|100 Gigabit C form-factor pluggable (CFP) protocol.|Networking|mdio|—|supported}}
{{pd|cjtag|cJTAG|Compact Joint Test Action Group (IEEE 1149.7)|Protocol for testing, debugging, and flashing ICs.|Debug/trace|logic|jtag|supported}}
{{pd|counter|Counter|Edge counter|Count the number of edges in a signal.|Util|logic|—|supported}}
{{pd|dali|DALI|Digital Addressable Lighting Interface|Digital Addressable Lighting Interface (DALI) protocol.|Embedded/industrial, Lighting|logic|—|supported}}
{{pd|dcf77|DCF77|DCF77 time protocol|European longwave time signal (77.5kHz carrier signal).|Clock/timing|logic|—|supported}}
{{pd|dmx512|DMX512|Digital MultipleX 512|Digital MultipleX 512 (DMX512) lighting protocol.|Embedded/industrial, Lighting|uart|dmx512|supported}}
{{pd|ds1307|DS1307|Dallas DS1307|Dallas DS1307 realtime clock module protocol.|Clock/timing, IC|i2c|—|supported}}
{{pd|ds2408|DS2408|Maxim DS2408|1-Wire 8-channel addressable switch.|Embedded/industrial, IC|onewire_network|—|supported}}
{{pd|ds243x|DS243x|Maxim DS2432/3|Maxim DS243x series 1-Wire EEPROM protocol.|IC, Memory|onewire_network|—|supported}}
{{pd|ds28ea00|DS28EA00|Maxim DS28EA00 1-Wire digital thermometer|1-Wire digital thermometer with Sequence Detect and PIO.|IC, Sensor|onewire_network|—|supported}}
{{pd|dsi|DSI|Digital Serial Interface|Digital Serial Interface (DSI) lighting protocol.|Embedded/industrial, Lighting|logic|—|supported}}
{{pd|edid|EDID|Extended Display Identification Data|Data structure describing display device capabilities.|Display, Memory, PC|i2c|—|supported}}
{{pd|eeprom24xx|24xx EEPROM|24xx I²C EEPROM|24xx series I²C EEPROM protocol.|IC, Memory|i2c|—|supported}}
{{pd|eeprom93xx|93xx EEPROM|93xx Microwire EEPROM|93xx series Microwire EEPROM protocol.|IC, Memory|microwire|—|supported}}
{{pd|em4100|EM4100|RFID EM4100|EM4100 100-150kHz RFID protocol.|IC, RFID|logic|—|supported}}
{{pd|em4305|EM4305|RFID EM4205/EM4305|EM4205/EM4305 100-150kHz RFID protocol.|IC, RFID|logic|—|supported}}
{{pd|enc28j60|ENC28J60|Microchip ENC28J60|Microchip ENC28J60 10Base-T Ethernet controller protocol.|Embedded/industrial, Networking|spi|—|supported}}
{{pd|flexray|FlexRay|FlexRay|Automotive network communications protocol.|Automotive|logic|—|supported}}
{{pd|graycode|Gray code|Gray code and rotary encoder|Accumulate rotary encoder increments, provide statistics.|Encoding|logic|—|supported}}
{{pd|guess_bitrate|Guess bitrate|Guess bitrate/baudrate|Guess the bitrate/baudrate of a UART (or other) protocol.|Clock/timing, Util|logic|—|supported}}
{{pd|hdcp|HDCP|HDCP over HDMI|HDCP protocol over HDMI.|PC, Security/crypto|i2c|hdcp|supported}}
{{pd|i2c|I²C|Inter-Integrated Circuit|Two-wire, multi-master, serial bus.|Embedded/industrial|logic|i2c|supported}}
{{pd|i2cdemux|I²C demux|I²C demultiplexer|Demux I²C packets into per-slave-address streams.|Util|i2c|—|supported}}
{{pd|i2cfilter|I²C filter|I²C filter|Filter out addresses/directions in an I²C stream.|Util|i2c|i2c|supported}}
{{pd|i2s|I²S|Integrated Interchip Sound|Serial bus for connecting digital audio devices.|Audio, PC|logic|i2s|supported}}
{{pd|ieee488|IEEE-488|IEEE-488 GPIB/HPIB/IEC|IEEE-488 General Purpose Interface Bus (GPIB/HPIB or IEC).|PC, Retro computing|logic|ieee488|supported}}
{{pd|ir_irmp|IR IRMP|IR IRMP|IRMP infrared remote control multi protocol.|IR|logic|—|supported}}
{{pd|ir_nec|IR NEC|IR NEC|NEC infrared remote control protocol.|IR|logic|—|supported}}
{{pd|ir_rc5|IR RC-5|IR RC-5|RC-5 infrared remote control protocol.|IR|logic|—|supported}}
{{pd|ir_rc6|IR RC-6|IR RC-6|RC-6 infrared remote control protocol.|IR|logic|—|supported}}
{{pd|ir_sirc|IR SIRC|Sony IR (SIRC)|Sony infrared remote control protocol (SIRC).|IR|logic|—|supported}}
{{pd|jitter|Jitter|Timing jitter calculation|Retrieves the timing jitter between two digital signals.|Clock/timing, Util|logic|—|supported}}
{{pd|jtag|JTAG|Joint Test Action Group (IEEE 1149.1)|Protocol for testing, debugging, and flashing ICs.|Debug/trace|logic|jtag|supported}}
{{pd|jtag_ejtag|JTAG / EJTAG|Joint Test Action Group / EJTAG (MIPS)|MIPS EJTAG protocol.|Debug/trace|jtag|—|supported}}
{{pd|jtag_stm32|JTAG / STM32|Joint Test Action Group / ST STM32|ST STM32-specific JTAG protocol.|Debug/trace|jtag|—|supported}}
{{pd|lfast|LFAST|NXP LFAST interface|Differential high-speed P2P interface|Embedded/industrial|logic|lfast|supported}}
{{pd|lin|LIN|Local Interconnect Network|Local Interconnect Network (LIN) protocol.|Automotive|uart|—|supported}}
{{pd|lm75|LM75|National LM75|National LM75 (and compatibles) temperature sensor.|Sensor|i2c|—|supported}}
{{pd|lpc|LPC|Low Pin Count|Protocol for low-bandwidth devices on PC mainboards.|PC|logic|—|supported}}
{{pd|ltc242x|LTC242x|Linear Technology LTC242x|Linear Technology LTC2421/LTC2422 1-/2-channel 20-bit ADC.|IC, Analog/digital|spi|—|supported}}
{{pd|ltc26x7|LTC26x7|Linear Technology LTC26x7|Linear Technology LTC26x7 16-/14-/12-bit rail-to-rail DACs.|IC, Analog/digital|i2c|—|supported}}
{{pd|maple_bus|Maple bus|SEGA Maple bus|Maple bus peripheral protocol for SEGA Dreamcast.|Retro computing|logic|—|supported}}
{{pd|max7219|MAX7219|Maxim MAX7219/MAX7221|Maxim MAX72xx series 8-digit LED display driver.|Display|spi|—|supported}}
{{pd|mcs48|MCS-48|Intel MCS-48|Intel MCS-48 external memory access protocol.|Retro computing|logic|—|supported}}
{{pd|mdio|MDIO|Management Data Input/Output|MII management bus between MAC and PHY.|Networking|logic|mdio|supported}}
{{pd|microwire|Microwire|Microwire|3-wire, half-duplex, synchronous serial bus.|Embedded/industrial|logic|microwire|supported}}
{{pd|midi|MIDI|Musical Instrument Digital Interface|Musical Instrument Digital Interface (MIDI) protocol.|Audio, PC|uart|—|supported}}
{{pd|mil-std-1553|MIL-STD-1553|MIL-STD-1553 avionic data bus.|MIL-STD-1553 avionic data bus protocol.|Embedded/industrial, Networking|logic|—|soon}}
{{pd|miller|Miller|Miller encoding|Miller encoding protocol.|Encoding|logic|—|supported}}
{{pd|mlx90614|MLX90614|Melexis MLX90614|Melexis MLX90614 infrared thermometer protocol.|IC, Sensor|i2c|—|supported}}
{{pd|modbus|Modbus|Modbus RTU over RS232/RS485|Modbus RTU protocol for industrial applications.|Embedded/industrial|uart|modbus|supported}}
{{pd|morse|Morse|Morse code|Demodulated morse code protocol.|Encoding|logic|—|supported}}
{{pd|mrf24j40|MRF24J40|Microchip MRF24J40|IEEE 802.15.4 2.4 GHz RF tranceiver chip.|IC, Wireless/RF|spi|—|supported}}
{{pd|mxc6225xu|MXC6225XU|MEMSIC MXC6225XU|Digital Thermal Orientation Sensor (DTOS) protocol.|IC, Sensor|i2c|—|supported}}
{{pd|nes_gamepad|NES gamepad|Nintendo Entertainment System gamepad|NES gamepad button states.|Retro computing|spi|—|supported}}
{{pd|nrf24l01|nRF24L01(+)|Nordic Semiconductor nRF24L01(+)|2.4GHz RF transceiver chip.|IC, Wireless/RF|spi|—|supported}}
{{pd|nrf905|nRF905|Nordic Semiconductor nRF905|433/868/933MHz transceiver chip.|IC, Wireless/RF|spi|—|supported}}
{{pd|numbers_and_state|Numbers and State|Interpret bit patters as numbers or state enums|Interpret bit patterns as different kinds of numbers (integer, float, enum).|Encoding, Util|logic|numbers_and_state|supported}}
{{pd|nunchuk|Nunchuk|Nintendo Wii Nunchuk|Nintendo Wii Nunchuk controller protocol.|Sensor|i2c|—|supported}}
{{pd|onewire_link|1-Wire link layer|1-Wire serial communication bus (link layer)|Bidirectional, half-duplex, asynchronous serial bus.|Embedded/industrial|logic|onewire_link|supported}}
{{pd|onewire_network|1-Wire network layer|1-Wire serial communication bus (network layer)|Bidirectional, half-duplex, asynchronous serial bus.|Embedded/industrial|onewire_link|onewire_network|supported}}
{{pd|ook|OOK|On-off keying|On-off keying protocol.|Encoding|logic|ook|supported}}
{{pd|ook_oregon|Oregon|Oregon Scientific|Oregon Scientific weather sensor protocol.|Sensor|ook|—|supported}}
{{pd|ook_vis|OOK visualisation|On-off keying visualisation|OOK visualisation in various formats.|Encoding|ook|ook|supported}}
{{pd|pan1321|PAN1321|Panasonic PAN1321|Bluetooth RF module with Serial Port Profile (SPP).|Wireless/RF|uart|—|supported}}
{{pd|parallel|Parallel|Parallel sync bus|Generic parallel synchronous bus.|Util|logic|parallel|supported}}
{{pd|pca9571|PCA9571|NXP PCA9571|NXP PCA9571 8-bit I²C output expander.|Embedded/industrial, IC|i2c|—|supported}}
{{pd|pjdl|PJDL|Padded Jittering Data Link|PJDL, a single wire serial link layer for PJON.|Embedded/industrial|logic|pjon_link|supported}}
{{pd|pjon|PJON|PJON|The PJON protocol.|Embedded/industrial|pjon_link|—|supported}}
{{pd|ps2|PS/2|PS/2|PS/2 keyboard/mouse interface.|PC|logic|—|supported}}
{{pd|pwm|PWM|Pulse-width modulation|Analog level encoded in duty cycle percentage.|Encoding|logic|—|supported}}
{{pd|qi|Qi|Qi charger protocol|Protocol used by Qi receiver.|Embedded/industrial, Wireless/RF|logic|—|supported}}
{{pd|rc_encode|RC encode|Remote control encoder|PT2262/HX2262/SC5262 remote control encoder protocol.|IC, IR|logic|—|supported}}
{{pd|rfm12|RFM12|HopeRF RFM12|HopeRF RFM12 wireless transceiver control protocol.|Wireless/RF|spi|—|supported}}
{{pd|rgb_led_spi|RGB LED (SPI)|RGB LED string decoder (SPI)|RGB LED string protocol (RGB values clocked over SPI).|Display|spi|—|supported}}
{{pd|rgb_led_ws281x|RGB LED (WS281x)|RGB LED string decoder (WS281x)|RGB LED string protocol (WS281x).|Display, IC|logic|—|supported}}
{{pd|rtc8564|RTC-8564|Epson RTC-8564 JE/NB|Realtime clock module protocol.|Clock/timing|i2c|—|supported}}
{{pd|sae_j1850_vpw|SAE J1850 VPW|SAE J1850 VPW.|SAE J1850 Variable Pulse Width 1x and 4x.|Automotive|logic|—|supported}}
{{pd|sbus_futaba|SBUS (Futaba)|Futaba SBUS (Serial bus)|Serial bus for hobby remote control by Futaba|Remote Control|uart|sbus_futaba|supported}}
{{pd|sda2506|SDA2506|Siemens SDA 2506-5|Serial nonvolatile 1-Kbit EEPROM.|IC, Memory|logic|—|supported}}
{{pd|sdcard_sd|SD card (SD mode)|Secure Digital card (SD mode)|Secure Digital card (SD mode) low-level protocol.|Memory|logic|—|supported}}
{{pd|sdcard_spi|SD card (SPI mode)|Secure Digital card (SPI mode)|Secure Digital card (SPI mode) low-level protocol.|Memory|spi|—|supported}}
{{pd|sdq|SDQ|Texas Instruments SDQ|Texas Instruments SDQ. The SDQ protocol is also used by Apple.|Embedded/industrial|logic|—|supported}}
{{pd|seven_segment|7-segment|7-segment display|7-segment display protocol.|Display|logic|—|supported}}
{{pd|signature|Signature|Signature analysis|Annotate signature of logic patterns.|Debug/trace, Util, Encoding|logic|—|supported}}
{{pd|sipi|SIPI (Zipwire)|NXP SIPI interface|Serial Inter-Processor Interface (SIPI) aka Zipwire, aka HSSL|Embedded/industrial|lfast|none|supported}}
{{pd|sle44xx|SLE 44xx|SLE44xx memory card|SLE 4418/28/32/42 memory card serial protocol|Memory|logic|—|supported}}
{{pd|spdif|S/PDIF|Sony/Philips Digital Interface Format|Serial bus for connecting digital audio devices.|Audio, PC|logic|—|supported}}
{{pd|spi|SPI|Serial Peripheral Interface|Full-duplex, synchronous, serial bus.|Embedded/industrial|logic|spi|supported}}
{{pd|spiflash|SPI flash/EEPROM|SPI flash/EEPROM chips|xx25 series SPI (NOR) flash/EEPROM chip protocol.|IC, Memory|spi|—|supported}}
{{pd|ssi32|SSI32|Synchronous Serial Interface (32bit)|Synchronous Serial Interface (32bit) protocol.|Embedded/industrial|spi|—|supported}}
{{pd|st25r39xx|ST25R39xx|STMicroelectronics ST25R39xx|High performance NFC universal device and EMVCo reader protocol.|IC, Wireless/RF|spi|—|supported}}
{{pd|st7735|ST7735|Sitronix ST7735|Sitronix ST7735 TFT controller protocol.|Display, IC|logic|—|supported}}
{{pd|stepper_motor|Stepper motor|Stepper motor position / speed|Absolute position and movement speed from step/dir.|Embedded/industrial|logic|—|supported}}
{{pd|swd|SWD|Serial Wire Debug|Two-wire protocol for debug access to ARM CPUs.|Debug/trace|logic|swd|supported}}
{{pd|swim|SWIM|STM8 SWIM bus|STM8 Single Wire Interface Module (SWIM) protocol.|Debug/trace|logic|—|supported}}
{{pd|t55xx|T55xx|RFID T55xx|T55xx 100-150kHz RFID protocol.|IC, RFID|logic|—|supported}}
{{pd|tca6408a|TI TCA6408A|Texas Instruments TCA6408A|Texas Instruments TCA6408A 8-bit I²C I/O expander.|Embedded/industrial, IC|i2c|—|supported}}
{{pd|tdm_audio|TDM audio|Time division multiplex audio|TDM multi-channel audio protocol.|Audio|logic|—|supported}}
{{pd|timing|Timing|Timing calculation with frequency and averaging|Calculate time between edges.|Clock/timing, Util|logic|—|supported}}
{{pd|tlc5620|TI TLC5620|Texas Instruments TLC5620|Texas Instruments TLC5620 8-bit quad DAC.|IC, Analog/digital|logic|—|supported}}
{{pd|uart|UART|Universal Asynchronous Receiver/Transmitter|Asynchronous, serial bus.|Embedded/industrial|logic|uart|supported}}
{{pd|usb_packet|USB packet|Universal Serial Bus (LS/FS) packet|USB (low-speed and full-speed) packet protocol.|PC|usb_signalling|usb_packet|supported}}
{{pd|usb_power_delivery|USB PD|USB Power Delivery|USB Power Delivery protocol.|PC|logic|usb_pd|supported}}
{{pd|usb_request|USB request|Universal Serial Bus (LS/FS) transaction/request|USB (low-speed/full-speed) transaction/request protocol.|PC|usb_packet|usb_request|supported}}
{{pd|usb_signalling|USB signalling|Universal Serial Bus (LS/FS) signalling|USB (low-speed/full-speed) signalling protocol.|PC|logic|usb_signalling|supported}}
{{pd|wiegand|Wiegand|Wiegand interface|Wiegand interface for electronic entry systems.|Embedded/industrial, RFID|logic|—|supported}}
{{pd|x2444m|X2444M/P|Xicor X2444M/P|Xicor X2444M/P nonvolatile static RAM protocol.|IC, Memory|spi|—|supported}}
{{pd|xfp|XFP|10 Gigabit Small Form Factor Pluggable Module (XFP)|XFP I²C management interface structures/protocol|Networking|i2c|—|supported}}
{{pd|xy2-100|XY2-100|XY2-100 and XY2-200 interface|XY2-100 protocol used for laser applications.|Embedded/industrial|logic|—|supported}}
{{pd|z80|Z80|Zilog Z80 CPU|Zilog Z80 microprocessor disassembly.|Retro computing|logic|—|supported}}

|}

== Possible candidates for future protocol decoders ==

{| border="0" style="font-size: smaller" class="alternategrey sortable sigroktable"
|-
!Protocol
!Category
!Input ID(s)
!Output ID(s)
!Status
!Description
!Comments

|-
| SA8807A
| Displays
| spi
|
| bgcolor="red" | 0%
| SPI-attached LCD. Datasheet: [http://pdf1.alldatasheet.com/datasheet-pdf/view/36922/SAMES/SA8807A.html Sames SA8807A].
|

|-
| EA eDIPTFT43-A
| Displays
| i2c
|
| bgcolor="red" | 0%
| I2C-attached LCD. Datasheet: [http://www.lcd-module.de/pdf/grafik/ediptft43-a.pdf EA eDIPTFT43-A].
|

|-
| Analog Devices AD7291
| ADC
| i2c
|
| bgcolor="red" | 0%
| I2C-attached ADC. Datasheet: [http://pdf1.alldatasheet.com/datasheet-pdf/view/318172/AD/AD7291.html Analog Devices AD7291].
|

|-
| Analog Devices ADS1258
| ADC
| spi
| ads1258
| bgcolor="orange" | 0%
| SPI-attached ADC.
| Planned (Uwe Hermann).

|-
| [https://en.wikipedia.org/wiki/ccTalk ccTalk]
| Automation/Industrial
| uart
| cctalk
| bgcolor="red" | 20%
| Serial protocol in widespread use throughout the money transaction and point-of-sale industry.
|In progress - https://github.com/plaes/libsigrokdecode/tree/cctalk

|-
| Microchip MCP3901
| ADC
| spi
| mcp3901
| bgcolor="orange" | 0%
| Can be controlled via a parallel protocol, or SPI, or I2C.
| Planned (Uwe Hermann).

|-
| JTAG / TMPA9xx
| Flash/debug
| jtag
| jtag_tmpa9xx
| bgcolor="red" | 0%
| Toshiba TMPA9xx specific JTAG protocol details.
|

|-
| USB transfer
| USB
| usb_request
| usb_transfer
| bgcolor="red" | 0%
|
|

|-
| USB / HID
| USB
| usb_transfer
| usb_hid
| bgcolor="red" | 0%
|
|

|-
| USB / CDC
| USB
| usb_transfer
| usb_cdc
| bgcolor="red" | 0%
|
|

|-
| USB / USBTMC
| USB
| usb_transfer
| usb_usbtmc
| bgcolor="red" | 0%
|
|

|-
| Dallas DS1985
| Other
| onewire_network
|
| bgcolor="orange" | 0%
| Dallas DS1985 iButton (1-Wire) device.
| Planned (Uwe Hermann).

|-
| UNI/O
| Embedded
| —
|
| bgcolor="red" | 0%
|
|

|-
| [https://en.wikipedia.org/wiki/Synchronous_Serial_Interface SSI]
| Embedded
| —
|
| bgcolor="red" | 0%
| Synchronous Serial Interface
|

|-
| CompactFlash
| Memory
| —
|
| bgcolor="red" | 0%
|
|

|-
| MMC
| Memory
| —
|
| bgcolor="red" | 0%
|
|

|-
| Memory Stick
| Memory
| —
|
| bgcolor="red" | 0%
|
|

|-
| SmartMedia
| Memory
| —
|
| bgcolor="red" | 0%
|
|

|-
| xD-Picture Card
| Memory
| —
|
| bgcolor="red" | 0%
|
|

|-
| [https://en.wikipedia.org/wiki/ISO/IEC_7816 ISO 7816]
| Smartcards
| —
|
| bgcolor="red" | 0%
|
|

|-
| AVR TPI
| Flash/debug
| —
|
| bgcolor="red" | 0%
| Atmel Tiny Programming Interface (TPI) protocol.
|

|-
| FWH
| PC
| —
|
| bgcolor="red" | 0%
|
|

|-
| ISA
| PC
| —
|
| bgcolor="red" | 0%
|
|

|-
| PCI
| PC
| —
|
| bgcolor="red" | 0%
|
|

|-
| SMBus
| PC
| —
|
| bgcolor="red" | 0%
|
|

|-
| IDE
| PC
| —
|
| bgcolor="red" | 0%
|
|

|-
| SCSI
| PC
| —
|
| bgcolor="red" | 0%
|
|

|-
| [https://en.wikipedia.org/wiki/Platform_Environment_Control_Interface PECI]
| PC
| —
|
| bgcolor="red" | 0%
| Platform Environment Control Interface
|

|-
| [https://en.wikipedia.org/wiki/SVID SVID]
| PC
| —
|
| bgcolor="red" | 0%
| Serial Voltage Identification
|

|-
| [[Protocol_decoder:mfm|MFM]]
| PC
| —
|
| bgcolor="yellow" | 90%
| Floppy disk FM and [https://en.wikipedia.org/wiki/Modified_Frequency_Modulation MFM].
| Work in progress (David Wiens).

|-
| HD Audio
| Audio
| —
|
| bgcolor="red" | 0%
|
|

|-
| Nokia NRC17
| IR
| —
|
| bgcolor="red" | 0%
|
|

|-
| Philips RC-MM
| IR
| —
|
| bgcolor="red" | 0%
|
|

|-
| Philips RECS80
| IR
| —
|
| bgcolor="red" | 0%
|
|

|-
| [http://en.wikipedia.org/wiki/Infrared_Data_Association IrDA]
| Misc
| —
|
| bgcolor="red" | 0%
|
|

|-
| HD44780
| Displays
| —
|
| bgcolor="red" | 0%
| [http://en.wikipedia.org/wiki/HD44780_Character_LCD HD44780 character LCD] protocol
|

|-
| [[Protocol_decoder:Pcf8814|PCF8814]]
| Displays
| —
| pcf8814
| bgcolor="yellow" | 50%
| Philips PCF8814 65 x 96 pixels matrix LCD driver
| Work in progress (Uwe Hermann).

|-
| [[Protocol_decoder:Pcf8814_lcd|PCF8814 LCD]]
| Displays
| pcf8814
| pcf8814_lcd
| bgcolor="yellow" | 50%
| Philips PCF8814 65 x 96 pixels matrix LCD driver
| Work in progress (Uwe Hermann).

|-
| [https://en.wikipedia.org/wiki/RDM_%28lighting%29 RDM]
| Industrial Lighting
| —
| rdm
| bgcolor="red" | 0%
|
|

|-
| [https://en.wikipedia.org/wiki/NMEA_0183 NMEA 0183]
| GPS
| uart
| nmea0183
| bgcolor="red" | 0%
|
|

|-
| [[Protocol_decoder:Nmea2000|NMEA2000]]
| Marine
| can
| nmea2000
| bgcolor="red" | 0%
| [https://en.wikipedia.org/wiki/NMEA_2000 NMEA 2000 Wikipedia page]
|

|-
| [https://en.wikipedia.org/wiki/Digital_Command_Control DCC]
| Trains
| —
| dcc
| bgcolor="red" | 0%
|
|

|-
| [https://en.wikipedia.org/wiki/Train_Communication_Network MVB]
| Trains
| —
| mvb
| bgcolor="yellow" | 40%
| Multifunction Vehicle Bus
| Work in progress (Libor Tomsik).

|-
| [https://en.wikipedia.org/wiki/Train_Communication_Network WTB]
| Trains
| —
| wtb
| bgcolor="red" | 0%
| Wire Train Bus
|

|-
| [https://en.wikipedia.org/wiki/C-Bus_%28protocol%29 C-Bus]
| Home automation
| —
| cbus
| bgcolor="red" | 0%
|
|

|-
| [https://en.wikipedia.org/wiki/X10_%28industry_standard%29 X10]
| Home automation
| —
| x10
| bgcolor="red" | 0%
|
|

|-
| [https://en.wikipedia.org/wiki/LonWorks LonWorks]
| Home automation
| —
| lonworks
| bgcolor="red" | 0%
|
|

|-
| [https://en.wikipedia.org/wiki/Meter-Bus M-Bus]
| Automation
| —
| mbus
| bgcolor="red" | 0%
|
|

|-
| [https://en.wikipedia.org/wiki/Modbus Modbus ASCII]
| Automation
| uart
| modbus
| bgcolor="red" | 0%
|
|

|-
| [https://en.wikipedia.org/wiki/Modbus Modbus TCP]
| Automation
| ip
| modbus
| bgcolor="red" | 0%
|
|

|-
| [https://en.wikipedia.org/wiki/Highway_Addressable_Remote_Transducer_Protocol HART protocol]
| Automation
| —
| hart
| bgcolor="red" | 0%
|
|

|-
| [https://en.wikipedia.org/wiki/INTERBUS INTERBUS]
| Automation
| —
| interbus
| bgcolor="red" | 0%
|
|

|-
| [https://en.wikipedia.org/wiki/DirectNET_Protocol DirectNET]
| Automation
| uart
| directnet
| bgcolor="red" | 0%
|
|

|-
| [https://en.wikipedia.org/wiki/KNX_%28standard%29 KNX]
| Automation
| various
| knx
| bgcolor="red" | 0%
|
|

|-
| [https://en.wikipedia.org/wiki/Bacnet BACnet]
| Automation
|
| bacnet
| bgcolor="red" | 0%
|
|

|-
| [https://en.wikipedia.org/wiki/OpenTherm OpenTherm]
| Automation
| —
| opentherm
| bgcolor="red" | 0%
|
|

|-
| [https://en.wikipedia.org/wiki/EBUS_%28serial_buses%29 EBUS]
| Automation
| uart
| ebus
| bgcolor="red" | 0%
|
|

|-
| [https://en.wikipedia.org/wiki/Attachment_Unit_Interface AUI]
| Networking
| —
| aui
| bgcolor="red" | 0%
| Attachment Unit Interface
|

|-
| [https://en.wikipedia.org/wiki/Medium_Dependent_Interface MDI]
| Networking
| —
| mdi
| bgcolor="red" | 0%
| Medium Dependent Interface
|

|-
| [https://en.wikipedia.org/wiki/Media_Independent_Interface MII]
| Networking
| —
| mii
| bgcolor="red" | 0%
| Media Independent Interface
|

|-
| [https://en.wikipedia.org/wiki/Gigabit_Media_Independent_Interface#Gigabit_Media_Independent_Interface GMII]
| Networking
| —
| gmii
| bgcolor="red" | 0%
| Gigabit Media Independent Interface
|

|-
| [https://en.wikipedia.org/wiki/10_Gigabit_Media_Independent_Interface#10_Gigabit_Media_Independent_Interface XGMII]
| Networking
| —
| xgmii
| bgcolor="red" | 0%
| 10 Gigabit Media Independent Interface
|

|-
| [[Protocol_decoder:esp8266|ESP8266]]
| Wireless
| uart
| esp8266
| bgcolor="red" | 0%
| WiFi Serial Transceiver
|

|-
| [[Protocol Decoder:tmds|TMDS (HDMI / DVI Pixel Data)]]
| Display
| tmds
| —
| bgcolor="orange" | 1%
| https://github.com/mithro/tmds_encoding
| Work in progress ([[User:Mithro|mithro]])

|-
| [[Protocol Decoder:Easymatic|Easymatic]]
| Home automation
| uart
| easymatic
| bgcolor="red" | 10%
|
| Work in progress (Platypus)

|-
| [[Protocol Decoder:DDC/CI|DDC/CI]]
| PC
| i2c
| —
| bgcolor="red" | 0%
|
|

|-
| Kenwood VH
| Misc
| —
| —
| bgcolor="yellow" | 50%
| SYSTEM CONTROL protocol used by Kenwood's VH HiFi-system
| In progress: https://github.com/kripton/libsigrokdecode/compare/kenwood_vh

|-
| IEC 61131-9
| Industrial
| —
| —
| bgcolor="red" | 0%
| "Single-drop digital communication interface for small sensors and actuators (SDCI, marketed as IO-Link)" https://en.wikipedia.org/wiki/IEC_61131
|

|-
| NRZ encoding family
| —
| —
| —
| bgcolor="red" | 0%
| Non-Return-to-Zero and its [https://en.wikipedia.org/wiki/Non-return-to-zero#Variants variants]
| whoever wants it

|-
| Bi-Phase encoding family
| —
| —
| —
| bgcolor="red" | 0%
| [http://ckp.made-it.com/encodingschemes.html several variations] of codes, including [https://en.wikipedia.org/wiki/Manchester_code Manchester code]
| whoever wants it

|-
| Sony LANC
| —
| —
| —
| bgcolor="red" | 0%
| [http://www.boehmel.de/lanc.htm Sony LANC]
| whoever wants it, contact [[User:Alexdaniel|AlexDaniel]] for more info. You can already decode the raw data by using UART with 9600 baud and no parity, but it'd be better if pulseview displayed the meaning (as in what these commands do)

|-
| CCD (Chrysler's Collision Detection)
| —
| —
| —
| bgcolor="green" | 99%
| CCD (Chrysler's Collision Detection) is internal bus used on Chrysler cars produced about 1990-2000.
| It works, but decodes only subset of all possible CCD messages, mostly from Jeep ZJ '98. Need a little work to improve performance and better support of API 3. [https://github.com/majekw/sigrok-ccd-pd https://github.com/majekw/sigrok-ccd-pd]

|-
| Mate-trac
| —
| (bi-phase)
| —
| bgcolor="red" | 0%
| 20th century protocol for remote control of projectors, often stored on audio tapes; [https://www.aidtopia.com/mccarthy/aid/multi-image/matetrac.html described well by Adrian McCarthy]
| whoever wants it, possibly [[User:chrysn|chrysn]]

|-
| PN532 NFC reader communication protocol
| NFC
| uart / spi / i2c
| ISO14443
| bgcolor="yellow" | 80%
| PN532 is a 13.56 MHz NFC reader, supporting SPI, I2C or Serial UART
| WIP for Serial UART: [https://github.com/plaes/libsigrokdecode/tree/pn542-uart https://github.com/plaes/libsigrokdecode/tree/pn542-uart] based on [https://git.mittelab.org/wifasoi/sigrokdecode-pn532 code from this repository]

|-
| SAE J2716 SENT
| Automotive
| —
|
| bgcolor="red" | 0%
| SENT - Single Edge Nibble Transmission for Automotive Applications
|

|}

__FORCETOC__