X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=decoders%2Fonewire_link%2F__init__.py;h=abd55671416df0ae9fb1985e0c89c8389b717da6;hp=5bd6c55e6cdfbd623aed50acbfeacde751531fd4;hb=HEAD;hpb=4c3b1846c9c307c1c35f86d259ddb968ed92718d diff --git a/decoders/onewire_link/__init__.py b/decoders/onewire_link/__init__.py index 5bd6c55..abd5567 100644 --- a/decoders/onewire_link/__init__.py +++ b/decoders/onewire_link/__init__.py @@ -2,6 +2,7 @@ ## This file is part of the libsigrokdecode project. ## ## Copyright (C) 2012 Uwe Hermann +## Copyright (C) 2017 Kevin Redon ## ## This program is free software; you can redistribute it and/or modify ## it under the terms of the GNU General Public License as published by @@ -14,8 +15,7 @@ ## 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 . ## ''' @@ -37,33 +37,20 @@ overdrive communication speed. The following minimal values should be used: - overdrive available: 2MHz minimum, 5MHz suggested - overdrive not available: 400kHz minimum, 1MHz suggested -Probes: +Channels: 1-Wire requires a single signal, but some master implementations might have a separate signal used to deliver power to the bus during temperature conversion -as an example. This power signal is currently not used. +as an example. - owr (1-Wire signal line) - - pwr (optional, dedicated power supply pin) Options: -1-Wire is an asynchronous protocol, so the decoder must know the samplerate. -The timing for sampling bits, presence, and reset is calculated by the decoder, -but in case the user wishes to use different values, it is possible to -configure the following timing values (number of samplerate periods): +1-Wire is an asynchronous protocol with fixed timing values, so the decoder +must know the samplerate. +Two speeds are available: normal and overdrive. The decoder detects when +switching speed, but the user can set which to start decoding with: - - overdrive (if active the decoder will be prepared for overdrive) - - cnt_normal_bit (time for normal mode sample bit) - - cnt_normal_slot (time for normal mode data slot) - - cnt_normal_presence (time for normal mode sample presence) - - cnt_normal_reset (time for normal mode reset) - - cnt_overdrive_bit (time for overdrive mode sample bit) - - cnt_overdrive_slot (time for overdrive mode data slot) - - cnt_overdrive_presence (time for overdrive mode sample presence) - - cnt_overdrive_reset (time for overdrive mode reset) - -These options should be configured only on very rare cases and the user should -read the decoder source code to understand them correctly. + - overdrive (to decode starting with overdrive speed) ''' -from .pd import * - +from .pd import Decoder