]> sigrok.org Git - libsigrokdecode.git/blobdiff - decoders/onewire_link/__init__.py
license: remove FSF postal address from boiler plate license text
[libsigrokdecode.git] / decoders / onewire_link / __init__.py
index f55b998aaadeb2b313c31bf216b23c3df2471f64..28b0194bb324796e6534d531659d255f4339d36a 100644 (file)
 ## GNU General Public License for more details.
 ##
 ## You should have received a copy of the GNU General Public License
 ## 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 (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
 
 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 +28,6 @@ is layered:
  - Network layer (skip/search/match device ROM addresses)
  - Transport layer (transport data between 1-Wire master and device)
 
  - Network layer (skip/search/match device ROM addresses)
  - Transport layer (transport data between 1-Wire master and device)
 
-This protocol decoder handles the 1-Wire link layer.
-
 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
 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
@@ -39,7 +36,7 @@ overdrive communication speed. The following minimal values should be used:
  - overdrive available: 2MHz minimum, 5MHz suggested
  - overdrive not available: 400kHz minimum, 1MHz suggested
 
  - 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.
 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.
@@ -67,5 +64,4 @@ These options should be configured only on very rare cases and the user should
 read the decoder source code to understand them correctly.
 '''
 
 read the decoder source code to understand them correctly.
 '''
 
-from .pd import *
-
+from .pd import Decoder