X-Git-Url: http://sigrok.org/gitweb/?a=blobdiff_plain;f=decoders%2Fonewire_link%2F__init__.py;h=5bd6c55e6cdfbd623aed50acbfeacde751531fd4;hb=5bb61a25d31c4c32f5109c38d7fd31c9e0d2c441;hp=cb0347170958b385212fa5960d13bda3f844d234;hpb=e7720d6c73eb981e57753c9028fa3e9019676c50;p=libsigrokdecode.git diff --git a/decoders/onewire_link/__init__.py b/decoders/onewire_link/__init__.py index cb03471..5bd6c55 100644 --- a/decoders/onewire_link/__init__.py +++ b/decoders/onewire_link/__init__.py @@ -1,5 +1,5 @@ ## -## This file is part of the sigrok project. +## This file is part of the libsigrokdecode project. ## ## Copyright (C) 2012 Uwe Hermann ## @@ -19,7 +19,7 @@ ## ''' -1-Wire protocol decoder (link layer). +This protocol decoder handles the 1-Wire link layer. The 1-Wire protocol enables bidirectional communication over a single wire (and ground) between a single master and one or multiple slaves. The protocol @@ -29,8 +29,6 @@ is layered: - Network layer (skip/search/match device ROM addresses) - Transport layer (transport data between 1-Wire master and device) -Link layer protocol details: - Sample rate: A sufficiently high samplerate is required to properly detect all the elements of the protocol. A lower samplerate can be used if the master does not use @@ -65,27 +63,7 @@ configure the following timing values (number of samplerate periods): These options should be configured only on very rare cases and the user should read the decoder source code to understand them correctly. - -Protocol output format: -TODO. - -Annotations: - -Link layer annotations show the following events: - - - NOTE/WARNING/ERROR - Possible samplerate related timing issues are reported. - - Reset/presence true/false - The event is marked from the signal negative edge to the end of the reset - high period. It's also reported if there are any devices attached to the bus. - - Bit 0/1 - The event is marked from the signal negative edge to the end of the data - slot. The value of each received bit is also provided. - -TODO: -- Check for protocol correctness, if events are timed inside prescribed limits. -- Maybe add support for interrupts, check if this feature is deprecated. ''' -from .onewire_link import * +from .pd import *