sigrok - User contributions [en]

Protocol decoders

2019-03-24T19:35:42Z

Rohieb: /* Possible candidates for future protocol decoders */ cc1101 is practically nonexistent and I don't have a hardware anymore

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: '''98'''.

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

{{pd|ac97|AC '97|Audio Codec '97|Audio and modem control for PC systems.|Audio|—|ac97|supported}}
{{pd|ade77xx|ADE77xx|Analog Devices ADE77xx|Poly phase multifunction energy metering IC protocol.|Sensors|spi|ade77xx|supported}}
{{pd|adf435x|ADF435x|Analog Devices ADF4350/1|Wideband synthesizer with integrated VCO.|RF|spi|adf435x|supported}}
{{pd|adns5020|ADNS-5020|Avago ADNS-5020 optical mouse sensor|Bidirectional command and data over an SPI-like protocol.|Sensors|spi|adns5020|supported}}
{{pd|am230x|AM230x/DHTxx/RHTxx|Aosong AM230x/DHTxx|Aosong AM230x/DHTxx/RHTxx humidity/temperature sensor protocol.|Sensors|—|am230x|supported}}
{{pd|arm_etmv3|ARM ETMv3|ARM Embedded Trace Macroblock|Decode ETM instruction trace packets.|Flash/debug|uart|arm_etmv3|supported}}
{{pd|arm_itm|ARM ITM|ARM Instrumentation Trace Macroblock|Trace data from Cortex-M / ARMv7m ITM module.|Flash/debug|uart|arm_itm|supported}}
{{pd|arm_tpiu|ARM TPIU|ARM Trace Port Interface Unit|Filter TPIU formatted trace data into separate streams.|Flash/debug|uart|uart|supported}}
{{pd|atsha204a|ATSHA204A|Microchip ATSHA204A|Microchip ATSHA204A CryptoAuthentication device.|Memory|i2c|atsha204a|supported}}
{{pd|aud|AUD|Advanced User Debugger|Renesas/Hitachi Advanced User Debugger (AUD) protocol.|Flash/debug|—|aud|supported}}
{{pd|avr_isp|AVR ISP|AVR in-system programming|Protocol for in-system programming Atmel AVR MCUs.|Flash/debug|spi|avr_isp|supported}}
{{pd|avr_pdi|AVR PDI|Atmel Program and Debug Interface|Atmel proprietary interface for the ATxmega MCU.|Flash/debug|—|avr_pdi|supported}}
{{pd|can|CAN|Controller Area Network|Field bus protocol for distributed realtime control.|Automotive|—|can|supported}}
{{pd|cec|CEC|HDMI-CEC|HDMI Consumer Electronics Control (CEC) protocol.|PC|—|cec|supported}}
{{pd|cfp|CFP|100 Gigabit C form-factor pluggable|100 Gigabit C form-factor pluggable (CFP) protocol.|Networking|mdio|—|supported}}
{{pd|counter|Counter|Edge counter|Count number of edges.|Misc|—|—|supported}}
{{pd|dali|DALI|Digital Addressable Lighting Interface|DALI lighting control protocol.|Lighting|—|dali|supported}}
{{pd|dcf77|DCF77|DCF77 time protocol|European longwave time signal (77.5kHz carrier signal).|Time signal|—|dcf77|supported}}
{{pd|dmx512|DMX512|Digital MultipleX 512|Professional lighting control protocol.|Lighting|—|dmx512|supported}}
{{pd|ds1307|DS1307|Dallas DS1307|Realtime clock module protocol.|RTC|i2c|ds1307|supported}}
{{pd|ds243x|DS243x|Maxim DS2432/DS2433|Maxim DS243x series 1-Wire EEPROM protocol.|Memory|onewire_network|ds243x|supported}}
{{pd|dsi|DSI|Digital Serial Interface|DSI lighting control protocol.|Lighting|—|dsi|supported}}
{{pd|edid|EDID|Extended Display Identification Data|Data structure describing display device capabilities.|PC|i2c|edid|supported}}
{{pd|eeprom24xx|24xx EEPROM|24xx I²C EEPROM|24xx series I²C EEPROM protocol.|Memory|i2c|eeprom24xx|supported}}
{{pd|eeprom93cxx|93Cxx EEPROM|93Cxx Microwire EEPROM|93Cxx series Microwire EEPROM protocol.|Memory|microwire|eeprom93cxx|supported}}
{{pd|em4100|EM4100|RFID EM4100|EM4100 100-150kHz RFID protocol.|RFID|—|em4100|supported}}
{{pd|em4305|EM4305|RFID EM4205/EM4305|EM4205/EM4305 100-150kHz RFID protocol.|RFID|—|em4305|supported}}
{{pd|gpib|GPIB|General Purpose Interface Bus|IEEE-488 GPIB / HPIB protocol.|Other|—|gpib|supported}}
{{pd|graycode|Gray code|Gray code and rotary encoder|Accumulate rotary encoder increments, provide timing statistics.|Misc|—|graycode|supported}}
{{pd|guess_bitrate|Guess bitrate|Guess bitrate/baudrate|Guess the bitrate/baudrate of a UART (or other) protocol.|Other|—|guess_bitrate|supported}}
{{pd|i2c|I2C|Inter-Integrated Circuit|Two-wire, multi-master, serial bus.|Embedded|—|i2c|supported}}
{{pd|i2cdemux|I2C demux|I2C demultiplexer|Demux I2C packets into per-slave-address streams.|Embedded|i2c|''runtime decision''|supported}}
{{pd|i2cfilter|I2C filter|I2C filter|Filter out addresses/directions in an I2C stream.|Embedded|i2c|i2c|supported}}
{{pd|i2s|I2S|Integrated Interchip Sound|Serial bus for connecting digital audio devices.|Audio|—|i2s|supported}}
{{pd|iec|IEC|Commodore bus|Commodore serial IEEE-488 (IEC) bus protocol.|Other|—|gpib|supported}}
{{pd|ir_nec|IR NEC|IR NEC|NEC infrared remote control protocol.|IR|—|ir_nec|supported}}
{{pd|ir_rc5|IR RC-5|IR RC-5|RC-5 infrared remote control protocol.|IR|—|ir_rc5|supported}}
{{pd|jitter|Jitter|Timing jitter calculation|Retrieves the timing jitter between two digital signals.|Misc|—|jitter|supported}}
{{pd|jtag|JTAG|Joint Test Action Group (IEEE 1149.1)|Protocol for testing, debugging, and flashing ICs.|Flash/debug|—|jtag|supported}}
{{pd|jtag_stm32|JTAG / STM32|Joint Test Action Group / ST STM32|ST STM32-specific JTAG protocol.|Flash/debug|jtag|jtag_stm32|supported}}
{{pd|jtag_ejtag|JTAG / EJTAG (MIPS)|Joint Test Action Group / EJTAG (MIPS)|MIPS EJTAG protocol.|Flash/debug|jtag|jtag_ejtag|supported}}
{{pd|lin|LIN|Local Interconnect Network|Local Interconnect Network (LIN) protocol.|Automotive|uart|lin|supported}}
{{pd|lm75|LM75|National LM75|National LM75 (and compatibles) temperature sensor protocol.|Sensors|i2c|lm75|supported}}
{{pd|lpc|LPC|Low-Pin-Count|Protocol for low-bandwidth devices on PC mainboards.|PC|—|lpc|supported}}
{{pd|maple_bus|Maple bus|SEGA Maple bus|Maple bus peripheral protocol for SEGA Dreamcast.|Misc|—|maple_bus|supported}}
{{pd|max7219|MAX7219|Maxim MAX7219/MAX7221|8-digit LED display driver.|Display|spi|max7219|supported}}
{{pd|maxim_ds28ea00|DS28EA00|Maxim DS28EA00 1-Wire digital thermometer|1-Wire digital thermometer with Sequence Detect and PIO.|Sensors|onewire_network|maxim_ds28ea00|supported}}
{{pd|mcs48|MCS-48|Intel MCS-48|Intel MCS-48 external memory protocol.|CPU|—|mcs48|supported}}
{{pd|mdio|MDIO|Management Data Input/Output|Half-duplex sync serial bus for MII management between MAC and PHY.|Networking|—|mdio|supported}}
{{pd|microwire|Microwire|Microwire|3-wire, half-duplex, synchronous serial bus.|Embedded|—|microwire|supported}}
{{pd|midi|MIDI|Musical Instrument Digital Interface|Musical Instrument Digital Interface (MIDI) protocol.|Music|uart|midi|supported}}
{{pd|miller|Miller|Miller encoding|Miller encoding protocol.|Misc|—|miller|supported}}
{{pd|mlx90614|MLX90614|Melexis MLX90614|Infrared Thermometer protocol.|Sensors|i2c|mlx90614|supported}}
{{pd|modbus|Modbus|Modbus RTU over RS232/RS485|Modbus RTU protocol for industrial applications.|Misc|uart|modbus|supported}}
{{pd|morse|Morse|Morse code|Demodulated morse code protocol.|Misc|—|morse|supported}}
{{pd|mrf24j40|MRF24J40|Microchip MRF24J40|IEEE 802.15.4 2.4 GHz RF tranceiver chip.|RF|spi|mf24j40|supported}}
{{pd|mxc6225xu|MXC6225XU|MEMSIC MXC6225XU|Digital Thermal Orientation Sensor (DTOS) protocol.|Sensors|i2c|mxc6225xu|supported}}
{{pd|nrf24l01|nRF24L01(+)|Nordic Semiconductor nRF24L01/nRF24L01+|2.4GHz transceiver chip.|Wireless|spi|nrf24l01|supported}}
{{pd|nunchuk|Nunchuk|Nintendo Wii Nunchuk|Nintendo Wii Nunchuk controller protocol.|Other|i2c|nunchuk|supported}}
{{pd|onewire_link|1-Wire link layer|1-Wire serial communication bus (link layer)|Bidirectional, half-duplex, asynchronous serial bus.|Embedded|—|onewire_link|supported}}
{{pd|onewire_network|1-Wire network layer|1-Wire serial communication bus (network layer)|Bidirectional, half-duplex, asynchronous serial bus.|Embedded|onewire_link|onewire_network|supported}}
{{pd|ook|OOK|On-off keying|On-off keying protocol.|Misc|—|ook|supported}}
{{pd|ook_oregon|Oregon|Oregon Scientific|Oregon Scientific weather sensor protocol.|Misc|ook|—|supported}}
{{pd|ook_vis|OOK visualisation|On-off keying visualisation|OOK visualisation in various formats.|Misc|ook|ook|supported}}
{{pd|pan1321|PAN1321|Panasonic PAN1321|Bluetooth RF module with Serial Port Profile (SPP).|Bluetooth|uart|pan1321|supported}}
{{pd|parallel|Parallel|Parallel sync bus|Generic parallel synchronous bus.|Misc|—|parallel|supported}}
{{pd|ps2|PS/2|PS/2|PS/2 keyboard/mouse interface.|PC|—|ps2|supported}}
{{pd|pwm|PWM|Pulse-width modulation|Analog level encoded in duty cycle percentage.|Misc|—|pwm|supported}}
{{pd|qi|Qi|Qi charger protocol|Async serial protocol for Qi charger receivers.|Misc|—|qi|supported}}
{{pd|rc_encode|RC encode|Remote control encoder|PT2262/HX2262/SC5262 remote control encoder protocol.|Wireless|—|—|supported}}
{{pd|rfm12|RFM12|RFM12 control protocol|HopeRF RFM12 wireless transceivers control protocol.|Wireless|spi|rfm12|supported}}
{{pd|rgb_led_spi|RGB LED (SPI)|RGB LED string decoder (SPI)|RGB LED string protocol (RGB values clocked over SPI).|LED|spi|rgb_led_spi|supported}}
{{pd|rgb_led_ws281x|RGB LED (WS281x)|RGB LED string decoder (WS281x)|RGB LED string protocol (WS281x).|LED|—|rgb_led_ws281x|supported}}
{{pd|rtc8564|RTC-8564|Epson RTC-8564 JE/NB|Realtime clock module protocol.|RTC|i2c|rtc8564|supported}}
{{pd|sda2506|SDA2506|Siemens SDA 2506-5|Serial nonvolatile 1-Kbit EEPROM.|Memory|—|sda2506|supported}}
{{pd|sdcard_sd|SD card (SD mode)|Secure Digital card (SD mode)|Secure Digital card (SD mode) low-level protocol.|Memory|—|sdcard_sd|supported}}
{{pd|sdcard_spi|SD card (SPI mode)|Secure Digital card (SPI mode)|Secure Digital card (SPI mode) low-level protocol.|Memory|spi|sdcard_spi|supported}}
{{pd|spdif|S/PDIF|Sony/Philips Digital Interface Format|Serial bus for connecting digital audio devices.|Audio|—|spdif|supported}}
{{pd|spi|SPI|Serial Peripheral Interface|Full-duplex, synchronous, serial bus.|Embedded|—|spi|supported}}
{{pd|spiflash|SPI flash|SPI flash chips|xx25 series SPI (NOR) flash chip protocol.|SPI flash|spi|spiflash|supported}}
{{pd|ssi32|SSI32|Synchronous Serial Interface (32bit)|Synchronous Serial Interface (32bit) protocol.|Misc|spi|ssi32|supported}}
{{pd|st7735|ST7735|Sitronix ST7735|Sitronix ST7735 TFT controller protocol.|Display|—|st7735|supported}}
{{pd|stepper_motor|Stepper motor|Stepper motor position / speed|Absolute position and movement speed from step/dir.|Motors|—|stepper_motor|supported}}
{{pd|swd|SWD|Serial Wire Debug|Two-wire protocol for debug access to ARM CPUs.|Flash/debug|—|swd|supported}}
{{pd|swim|SWIM|STM8 SWIM bus|STM8 Single Wire Interface Module (SWIM) protocol.|Flash/debug|—|swim|supported}}
{{pd|t55xx|T55xx|RFID T5xx|T55xx 100-150kHz RFID protocol.|RFID|—|t55xx|supported}}
{{pd|tca6408a|TI TCA6408A|Texas Instruments TCA6408A|Texas Instruments TCA6408A 8-bit I²C I/O expander.|I/O expander|i2c|tca6408a|supported}}
{{pd|timing|Timing|Timing calculation|Calculate time between edges.|Misc|—|timing|supported}}
{{pd|tlc5620|TI TLC5620|Texas Instruments TLC5620|Texas Instruments TLC5620 8-bit quad DAC.|DAC|—|tlc5620|supported}}
{{pd|uart|UART|Universal Asynchronous Receiver/Transmitter|Asynchronous, serial bus.|Embedded|—|uart|supported}}
{{pd|usb_packet|USB packet|Universal Serial Bus (LS/FS) packet|USB (low-speed and full-speed) packet protocol.|USB|usb_signalling|usb_packet|supported}}
{{pd|usb_power_delivery|USB PD|USB Power Delivery|USB Power Delivery protocol.|USB|—|usb_pd|supported}}
{{pd|usb_request|USB request|Universal Serial Bus (LS/FS) transaction/request|USB (low-speed and full-speed) transaction/request protocol.|USB|usb_packet|usb_request|supported}}
{{pd|usb_signalling|USB signalling|Universal Serial Bus (LS/FS) signalling|USB (low-speed and full-speed) signalling protocol.|USB|—|usb_signalling|supported}}
{{pd|wiegand|Wiegand|Wiegand interface|Wiegand interface for electronic entry systems.|RFID|—|wiegand|supported}}
{{pd|x2444m|X2444M/P|Xicor X2444M/P|Xicor X2444M/P nonvolatile static RAM protocol.|Memory|spi|x2444m|supported}}
{{pd|xfp|XFP|10 Gigabit Small Form Factor Pluggable Module (XFP)|Data structure describing device capabilities.|Networking|i2c|xfp|supported}}
{{pd|z80|Z80|Zilog Z80 CPU|Zilog Z80 microprocessor disassembly.|CPU|—|z80|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).

|-
| 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%
|
|

|-
| FlexRay
| Automotive
| —
|
| bgcolor="yellow" | 70%
| [http://en.wikipedia.org/wiki/Flexray FlexRay] is an automotive network communications protocol.
| Work in progress ([[User:Stephan_Thiele|Stephan Thiele]]).

|-
| 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%
|
|

|-
| Sony SIRC
| IR
| —
|
| bgcolor="red" | 0%
|
|

|-
| Philips RC-6
| 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
|

|-
| 7-segment display
| Displays
| —
|
| bgcolor="red" | 0%
|
|

|-
| [[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="red" | 0%
| Multifunction Vehicle Bus
|

|-
| [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/S-Bus S-Bus]
| Home automation
| —
| sbus
| 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

|-
| Manchester encoding
| —
| —
| —
| bgcolor="red" | 0%
| [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)

|-
| CAN-FD
| Automotive
| —
| can
| bgcolor="yellow" | 60%
| Controller Area Network with Flexible Data Rate
| Work in progress ([[User:Stephan_Thiele|Stephan Thiele]]).

|}

__FORCETOC__

Protocol decoder HOWTO

2015-10-05T06:54:36Z

Rohieb: /* Random notes, tips and tricks */ shiny new ~/.local/share/libsigrokdecode/decoders

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 = 2
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 start(self):
self.out_ann = self.register(srd.OUTPUT_ANN)

def decode(self, ss, es, data):
for self.samplenum, (scl, sda) in data:
# Decode the samples.
</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 = (
('bit', 'Bit'),
('agc-pulse', 'AGC pulse'),
('longpause', 'Long pause'),
('shortpause', 'Short pause'),
('stop-bit', 'Stop bit'),
('leader-code', 'Leader code'),
('addr', 'Address'),
('addr-inv', 'Address#'),
('cmd', 'Command'),
('cmd-inv', 'Command#'),
('repeat-code', 'Repeat code'),
('remote', 'Remote'),
('warnings', 'Warnings'),
)
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]]

== 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).
* A simple way to check whether an optional PD channel was supplied (by the frontend/user) in this run is:
<source lang="python">
if pin in (0, 1):
do_stuff()
</source>
* 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>
* 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>
* <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.

== 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).

* Send the decoder (preferrably as a patch against the current git HEAD of [[libsigrokdecode]]) to the [https://lists.sourceforge.net/lists/listinfo/sigrok-devel sigrok-devel] mailing list, and/or tell us the location of your git repository containing the decoder (on the '''#sigrok''' IRC channel on FreeNode).
* Please also send us a few example data files (*.sr) and a small README to go with your decoder. We'll need these in order to properly review and test your decoder. Preferrably these files should also come as patches against the latest git HEAD of the [http://sigrok.org/gitweb/?p=sigrok-dumps.git;a=tree sigrok-dumps] repository. See [[Example dumps]] for details.
* 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

2015-10-04T20:11:28Z

Rohieb: /* Possible candidates for future protocol decoders */ +Texas Instruments CC1101 wireless controller, work in progress

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: '''56'''.

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

{{pd|adns5020|ADNS-5020|Avago ADNS-5020 optical mouse sensor|Bidirectional command and data over an SPI-like protocol.|Sensors|spi|adns5020|supported}}
{{pd|am230x|AM230x/DHTxx/RHTxx|Aosong AM230x/DHTxx|Aosong AM230x/DHTxx/RHTxx humidity/temperature sensor protocol.|Sensors|—|am230x|supported}}
{{pd|arm_etmv3|ARM ETMv3|ARM Embedded Trace Macroblock|Decode ETM instruction trace packets.|Flash/debug|uart|arm_etmv3|supported}}
{{pd|arm_itm|ARM ITM|ARM Instrumentation Trace Macroblock|Trace data from Cortex-M / ARMv7m ITM module.|Flash/debug|uart|arm_itm|supported}}
{{pd|arm_tpiu|ARM TPIU|ARM Trace Port Interface Unit|Filter TPIU formatted trace data into separate streams.|Flash/debug|uart|uart|supported}}
{{pd|avr_isp|AVR ISP|AVR in-system programming|Protocol for in-system programming Atmel AVR MCUs.|Flash/debug|spi|avr_isp|supported}}
{{pd|can|CAN|Controller Area Network|Field bus protocol for distributed realtime control.|Automotive|—|can|supported}}
{{pd|dcf77|DCF77|DCF77 time protocol|European longwave time signal (77.5kHz carrier signal).|Time signal|—|dcf77|supported}}
{{pd|ds1307|DS1307|Dallas DS1307|Realtime clock module protocol.|RTC|i2c|ds1307|supported}}
{{pd|edid|EDID|Extended Display Identification Data|Data structure describing display device capabilities.|PC|i2c|edid|supported}}
{{pd|eeprom24xx|24xx EEPROM|24xx I²C EEPROM|24xx series I²C EEPROM protocol.|Memory|i2c|eeprom24xx|supported}}
{{pd|guess_bitrate|Guess bitrate|Guess bitrate/baudrate|Guess the bitrate/baudrate of a UART (or other) protocol.|Other|—|guess_bitrate|supported}}
{{pd|i2c|I2C|Inter-Integrated Circuit|Two-wire, multi-master, serial bus.|Embedded|—|i2c|supported}}
{{pd|i2cdemux|I2C demux|I2C demultiplexer|Demux I2C packets into per-slave-address streams.|Embedded|i2c|''runtime decision''|supported}}
{{pd|i2cfilter|I2C filter|I2C filter|Filter out addresses/directions in an I2C stream.|Embedded|i2c|i2c|supported}}
{{pd|i2s|I2S|Integrated Interchip Sound|Serial bus for connecting digital audio devices.|Audio|—|i2s|supported}}
{{pd|ir_nec|IR NEC|IR NEC|NEC infrared remote control protocol.|IR|—|ir_nec|supported}}
{{pd|ir_rc5|IR RC-5|IR RC-5|RC-5 infrared remote control protocol.|IR|—|ir_rc5|supported}}
{{pd|jitter|Jitter|Timing jitter calculation|Retrieves the timing jitter between two digital signals.|Misc|—|jitter|supported}}
{{pd|jtag|JTAG|Joint Test Action Group (IEEE 1149.1)|Protocol for testing, debugging, and flashing ICs.|Flash/debug|—|jtag|supported}}
{{pd|jtag_stm32|JTAG / STM32|Joint Test Action Group / ST STM32|ST STM32-specific JTAG protocol.|Flash/debug|jtag|jtag_stm32|supported}}
{{pd|lm75|LM75|National LM75|National LM75 (and compatibles) temperature sensor protocol.|Sensors|i2c|lm75|supported}}
{{pd|lpc|LPC|Low-Pin-Count|Protocol for low-bandwidth devices on PC mainboards.|PC|—|lpc|supported}}
{{pd|maxim_ds28ea00|DS28EA00|Maxim DS28EA00 1-Wire digital thermometer|1-Wire digital thermometer with Sequence Detect and PIO.|Sensors|onewire_network|maxim_ds28ea00|supported}}
{{pd|mdio|MDIO|Management Data Input/Output|Half-duplex sync serial bus for MII management between MAC and PHY.|Networking|—|mdio|supported}}
{{pd|midi|MIDI|Musical Instrument Digital Interface|Musical Instrument Digital Interface (MIDI) protocol.|Music|uart|midi|supported}}
{{pd|mlx90614|MLX90614|Melexis MLX90614|Infrared Thermometer protocol.|Sensors|i2c|mlx90614|supported}}
{{pd|modbus|Modbus|Modbus RTU over RS232/RS485|Modbus RTU protocol for industrial applications.|Misc|uart|modbus|supported}}
{{pd|mrf24j40|MRF24J40|Microchip MRF24J40|IEEE 802.15.4 2.4 GHz RF tranceiver chip.|RF|spi|mf24j40|supported}}
{{pd|mxc6225xu|MXC6225XU|MEMSIC MXC6225XU|Digital Thermal Orientation Sensor (DTOS) protocol.|Sensors|i2c|mxc6225xu|supported}}
{{pd|nrf24l01|nRF24L01(+)|Nordic Semiconductor nRF24L01/nRF24L01+|2.4GHz transceiver chip.|Wireless|spi|nrf24l01|supported}}
{{pd|nunchuk|Nunchuk|Nintendo Wii Nunchuk|Nintendo Wii Nunchuk controller protocol.|Other|i2c|nunchuk|supported}}
{{pd|onewire_link|1-Wire link layer|1-Wire serial communication bus (link layer)|Bidirectional, half-duplex, asynchronous serial bus.|Embedded|—|onewire_link|supported}}
{{pd|onewire_network|1-Wire network layer|1-Wire serial communication bus (network layer)|Bidirectional, half-duplex, asynchronous serial bus.|Embedded|onewire_link|onewire_network|supported}}
{{pd|pan1321|PAN1321|Panasonic PAN1321|Bluetooth RF module with Serial Port Profile (SPP).|Bluetooth|uart|pan1321|supported}}
{{pd|parallel|Parallel|Parallel sync bus|Generic parallel synchronous bus.|Misc|—|parallel|supported}}
{{pd|pwm|PWM|Pulse-width modulation|Analog level encoded in duty cycle percentage.|Misc|—|pwm|supported}}
{{pd|qi|Qi|Qi charger protocol|Async serial protocol for Qi charger receivers.|Misc|—|qi|supported}}
{{pd|rfm12|RFM12|RFM12 control protocol|HopeRF RFM12 wireless transceivers control protocol.|Wireless|spi|rfm12|supported}}
{{pd|rgb_led_spi|RGB LED (SPI)|RGB LED string decoder (SPI)|RGB LED string protocol (RGB values clocked over SPI).|LED|spi|rgb_led_spi|supported}}
{{pd|rtc8564|RTC-8564|Epson RTC-8564 JE/NB|Realtime clock module protocol.|RTC|i2c|rtc8564|supported}}
{{pd|sdcard_sd|SD card (SD mode)|Secure Digital card (SD mode)|Secure Digital card (SD mode) low-level protocol.|Memory|—|sdcard_sd|supported}}
{{pd|sdcard_spi|SD card (SPI mode)|Secure Digital card (SPI mode)|Secure Digital card (SPI mode) low-level protocol.|Memory|spi|sdcard_spi|supported}}
{{pd|spdif|S/PDIF|Sony/Philips Digital Interface Format|Serial bus for connecting digital audio devices.|Audio|—|spdif|supported}}
{{pd|spi|SPI|Serial Peripheral Interface|Full-duplex, synchronous, serial bus.|Embedded|—|spi|supported}}
{{pd|spiflash|SPI flash|SPI flash chips|xx25 series SPI (NOR) flash chip protocol.|SPI flash|spi|spiflash|supported}}
{{pd|stepper_motor|Stepper motor|Stepper motor position / speed|Absolute position and movement speed from step/dir.|Motors|—|stepper_motor|supported}}
{{pd|swd|SWD|Serial Wire Debug|Two-wire protocol for debug access to ARM CPUs.|Flash/debug|—|swd|supported}}
{{pd|tca6408a|TI TCA6408A|Texas Instruments TCA6408A|Texas Instruments TCA6408A 8-bit I²C I/O expander.|I/O expander|i2c|tca6408a|supported}}
{{pd|timing|Timing|Timing calculation|Calculate time between edges.|Misc|—|timing|supported}}
{{pd|tlc5620|TI TLC5620|Texas Instruments TLC5620|Texas Instruments TLC5620 8-bit quad DAC.|DAC|—|tlc5620|supported}}
{{pd|uart|UART|Universal Asynchronous Receiver/Transmitter|Asynchronous, serial bus.|Embedded|—|uart|supported}}
{{pd|usb_packet|USB packet|Universal Serial Bus (LS/FS) packet|USB (low-speed and full-speed) packet protocol.|USB|usb_signalling|usb_packet|supported}}
{{pd|usb_signalling|USB signalling|Universal Serial Bus (LS/FS) signalling|USB (low-speed and full-speed) signalling protocol.|USB|—|usb_signalling|supported}}
{{pd|xfp|XFP|10 Gigabit Small Form Factor Pluggable Module (XFP)|Data structure describing device capabilities.|Networking|i2c|xfp|supported}}
{{pd|z80|Z80|Zilog Z80 CPU|Zilog Z80 microprocessor disassembly.|CPU|—|z80|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).

|-
| 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 transaction
| USB
| usb_packet
| usb_transaction
| bgcolor="yellow" | 30%
|
| Work in progress (Uwe Hermann).

|-
| USB transfer
| USB
| usb_transaction
| usb_transfer
| bgcolor="yellow" | 10%
|
| Work in progress (Uwe Hermann).

|-
| 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).

|-
| Microwire
| Embedded
| —
|
| bgcolor="red" | 0%
|
|

|-
| 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%
|
|

|-
| FlexRay
| Automotive
| —
|
| bgcolor="red" | 0%
| [http://en.wikipedia.org/wiki/Flexray FlexRay] is an automotive network communications protocol.
|

|-
| LIN
| Automotive
| —
|
| bgcolor="red" | 0%
| [http://en.wikipedia.org/wiki/Local_Interconnect_Network LIN] (Local Interconnect Network) is an automotive bus standard.
|

|-
| AVR PDI
| Flash/debug
| —
|
| bgcolor="red" | 0%
| Atmel Program and Debug Interface (PDI) protocol.
|

|-
| 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%
|
|

|-
| PS/2
| PC
| —
|
| bgcolor="orange" | 0%
|
| Planned (Uwe Hermann).

|-
| [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
|

|-
| AC'97
| Audio
| —
|
| bgcolor="orange" | 0%
|
| Planned (Uwe Hermann).

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

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

|-
| Sony SIRC
| IR
| —
|
| bgcolor="red" | 0%
|
|

|-
| Philips RC-6
| 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%
|
|

|-
| AT93C46
| EEPROM
| —
|
| bgcolor="red" | 0%
| Atmel AT93C46 serial EEPROM protocol
|

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

|-
| 7-segment display
| Displays
| —
|
| bgcolor="red" | 0%
|
|

|-
| [[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).

|-
| GPIB
| Other
| —
| gpib
| bgcolor="orange" | 0%
| [https://en.wikipedia.org/wiki/IEEE-488 General purpose interface bus] (GPIB), a.k.a. IEEE-488.1.
| Planned (Uwe Hermann).

|-
| [https://en.wikipedia.org/wiki/DMX512 DMX512]
| Industrial Lighting
| —
| dmx512
| bgcolor="yellow" | 20%
| Digital MultipleX 512
| Work in progress (Uwe Hermann).

|-
| [https://en.wikipedia.org/wiki/Digital_Signal_Interface DSI]
| Industrial Lighting
| —
| dsi
| bgcolor="red" | 0%
| Digital Serial Interface
|

|-
| [http://en.wikipedia.org/wiki/Digital_Addressable_Lighting_Interface DALI]
| Industrial Lighting
| —
| dali
| bgcolor="red" | 0%
|
|

|-
| [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="red" | 0%
| Multifunction Vehicle Bus
|

|-
| [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/S-Bus S-Bus]
| Home automation
| —
| sbus
| 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
|

|-
| [https://en.wikipedia.org/wiki/Wiegand_interface Wiegand]
| RFID
| —
| wiegand
| bgcolor="red" | 0%
| Wiegand interface
|

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

|-
| [[Protocol Decoder:cc1101|TI CC1101]]
| Wireless
| spi
| cc1101
| bgcolor="orange" | 1%
| SPI-attached wireless controller for 315/433/868/915 MHz ISM bands. [http://www.ti.com/lit/ds/symlink/cc1101.pdf Datasheet]
| Work in progress ([[User:Rohieb|rohieb]])
|}

__FORCETOC__

User:Rohieb

2015-10-04T20:01:11Z

Rohieb: Created page with "Hey hey! You can reach me via my discussion page, or [mailto:rohieb+sigrokwiki.Wah8doox@rohieb.name e-mail]."

Hey hey!

You can reach me via my [[{{TALKPAGENAME}}|discussion page]], or [mailto:rohieb+sigrokwiki.Wah8doox@rohieb.name e-mail].