srd: maxim_ds28ea00: Fix to only handle DS28EA00.
[libsigrokdecode.git] / decoders / maxim_ds28ea00 / __init__.py
index c6f063dae629741fcdda7828a0437306001337c9..590ee63be7fb21ab176bbe13a9a640904e32396b 100644 (file)
 ##
 
 '''
-1-Wire protocol decoder.
+Maxim DS28EA00 protocol decoder.
 
-The 1-Wire protocol enables bidirectional communication over a single wire (and
-ground) between a single master and one or multiple slaves. The protocol is
-layered.
-- Link layer (reset, presence detection, reading/writing bits)
-- Network layer (skip/search/match device ROM addresses)
-- Transport layer (transport data between 1-Wire master and device)
+The Maxim DS28EA00 is a 1-Wire digital thermometer with Sequence Detect
+and PIO functionality.
 
-Transport layer
-
-The transport layer is the largest and most complex part of the protocol, since
-it is very device specific. The decoder is parsing only a small part of the
-protocol.
-
-Annotations:
-The next link layer annotations are shown:
-- RESET/PRESENCE True/False
-  The event is marked from the signal negative edge to the end of the reset
-  high period. It is also reported if there are any devices attached to the
-  bus.
-The next network layer annotations are shown:
-- ROM val
-  The 64bit value of the addressed device is displayed:
-  family code (1B) + serial number (6B) + CRC (1B)
-- FUNCTION COMMAND val name
-  The requested FUNCTION command is displayed as an 8bit HEX value and by name.
-- DATA val
-  Data intended for the transport layer is displayed as an 8bit HEX value.
-
-TODO:
-- add CRC checks for transport layer
+Details:
+TODO
 '''
 
 from .maxim_ds28ea00 import *