license: remove FSF postal address from boiler plate license text
[libsigrokdecode.git] / decoders / am230x / __init__.py
1 ##
2 ## This file is part of the libsigrokdecode project.
3 ##
4 ## Copyright (C) 2014 Johannes Roemer <jroemer@physik.uni-wuerzburg.de>
5 ##
6 ## This program is free software; you can redistribute it and/or modify
7 ## it under the terms of the GNU General Public License as published by
8 ## the Free Software Foundation; either version 2 of the License, or
9 ## (at your option) any later version.
10 ##
11 ## This program is distributed in the hope that it will be useful,
12 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 ## GNU General Public License for more details.
15 ##
16 ## You should have received a copy of the GNU General Public License
17 ## along with this program; if not, see <http://www.gnu.org/licenses/>.
18 ##
19
20 '''
21 This decoder handles the proprietary single wire communication protocol used
22 by the Aosong AM230x/DHTxx/RHTxx series of digital humidity and temperature
23 sensors.
24
25 Sample rate:
26 A sample rate of at least 200kHz is recommended to properly detect all the
27 elements of the protocol.
28
29 Options:
30 The AM230x and DHTxx/RHTxx digital humidity and temperature sensors use the
31 same single-wire protocol with different encoding of the measured values.
32 Therefore the option 'device' must be used to properly decode the
33 communication of the respective sensor.
34 '''
35
36 from .pd import Decoder