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

##
## This file is part of the libsigrokdecode project.
##
## Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.de>
## Copyright (C) 2017 Kevin Redon <kingkevin@cuvoodoo.info>
##
## 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
## the Free Software Foundation; either version 2 of the License, or
## (at your option) any later version.
##
## This program is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
## 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, see <http://www.gnu.org/licenses/>.
##

'''
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
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)

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
overdrive communication speed. The following minimal values should be used:

 - overdrive available: 2MHz minimum, 5MHz suggested
 - overdrive not available: 400kHz minimum, 1MHz suggested

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.

 - owr (1-Wire signal line)

Options:
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 from one to another but the user can set which to start decoding with:

 - overdrive (to decode starting with overdrive speed)
'''

from .pd import Decoder
Commit	Line	Data
	1	##
	2	## This file is part of the libsigrokdecode project.
	3	##
	4	## Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.de>
	5	## Copyright (C) 2017 Kevin Redon <kingkevin@cuvoodoo.info>
	6	##
	7	## This program is free software; you can redistribute it and/or modify
	8	## it under the terms of the GNU General Public License as published by
	9	## the Free Software Foundation; either version 2 of the License, or
	10	## (at your option) any later version.
	11	##
	12	## This program is distributed in the hope that it will be useful,
	13	## but WITHOUT ANY WARRANTY; without even the implied warranty of
	14	## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	15	## GNU General Public License for more details.
	16	##
	17	## You should have received a copy of the GNU General Public License
	18	## along with this program; if not, see <http://www.gnu.org/licenses/>.
	19	##
	20
	21	'''
	22	This protocol decoder handles the 1-Wire link layer.
	23
	24	The 1-Wire protocol enables bidirectional communication over a single wire
	25	(and ground) between a single master and one or multiple slaves. The protocol
	26	is layered:
	27
	28	- Link layer (reset, presence detection, reading/writing bits)
	29	- Network layer (skip/search/match device ROM addresses)
	30	- Transport layer (transport data between 1-Wire master and device)
	31
	32	Sample rate:
	33	A sufficiently high samplerate is required to properly detect all the elements
	34	of the protocol. A lower samplerate can be used if the master does not use
	35	overdrive communication speed. The following minimal values should be used:
	36
	37	- overdrive available: 2MHz minimum, 5MHz suggested
	38	- overdrive not available: 400kHz minimum, 1MHz suggested
	39
	40	Channels:
	41	1-Wire requires a single signal, but some master implementations might have a
	42	separate signal used to deliver power to the bus during temperature conversion
	43	as an example.
	44
	45	- owr (1-Wire signal line)
	46
	47	Options:
	48	1-Wire is an asynchronous protocol with fixed timing values, so the decoder must
	49	know the samplerate.
	50	Two speeds are available: normal and overdrive. The decoder detects when
	51	switching from one to another but the user can set which to start decoding with:
	52
	53	- overdrive (to decode starting with overdrive speed)
	54	'''
	55
	56	from .pd import Decoder