license: remove FSF postal address from boiler plate license text

[libsigrokdecode.git] / decoders / onewire_network / __init__.py

diff --git a/decoders/onewire_network/__init__.py b/decoders/onewire_network/__init__.py
index 56a5eb5e7299802a3e4bf3a9cc9a04db7261979e..60907efa0ecb768fad7f5684130e58c364a787bf 100644 (file)
--- a/decoders/onewire_network/__init__.py
+++ b/decoders/onewire_network/__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 <uwe@hermann-uwe.de>
 ##
@@ -14,40 +14,43 @@
 ## GNU General Public License for more details.
 ##
 ## You should have received a copy of the GNU General Public License
-## along with this program; if not, write to the Free Software
-## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
+## along with this program; if not, see <http://www.gnu.org/licenses/>.
 ##
 
 '''
-1-Wire 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 (transfer data between 1-Wire master and device)
-
-Network layer
-
-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 COMMAND val name
-  The requested ROM command is displayed as an 8bit HEX value and by name.
-- ROM val
-  The 64bit value of the addressed device is displayed:
-  family code (1B) + serial number (6B) + CRC (1B)
-- DATA val
-  Data intended for the transport layer is displayed as an 8bit HEX value.
+This decoder stacks on top of the 'onewire_link' PD and decodes the
+1-Wire protocol (network 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
+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)
+
+Network layer:
+
+The following 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 following network layer annotations are shown:
+
+ - ROM command <val> <name>
+   The requested ROM command is displayed as an 8bit hex value and by name.
+ - ROM <val>
+   The 64bit value of the addressed device is displayed:
+   Family code (1 byte) + serial number (6 bytes) + CRC (1 byte)
+ - Data <val>
+   Data intended for the transport layer is displayed as an 8bit hex value.
 
 TODO:
-- add CRC checks, to see if there were communication errors on the wire
-- add reporting original/complement address values from the search algorithm
+ - Add CRC checks, to see if there were communication errors on the wire.
+ - Add reporting original/complement address values from the search algorithm.
 '''
 
-from .onewire_network import *
+from .pd import Decoder