├── udevrules
└── 99-co2mon.rules
├── graph
├── rrd
│ ├── update_graph.sh
│ ├── update_data.sh
│ ├── index.html
│ └── Makefile
├── collectd
│ ├── co2mon.conf.example
│ └── co2mon.py
└── munin
│ └── co2mon
├── .travis.yml
├── .gitignore
├── CMakeLists.txt
├── co2mond
├── CMakeLists.txt
└── src
│ └── main.c
├── libco2mon
├── include
│ ├── config.h.in
│ └── co2mon.h
├── CMakeLists.txt
└── src
│ └── co2mon.c
├── README.md
└── LICENSE
/udevrules/99-co2mon.rules:
--------------------------------------------------------------------------------
1 | SUBSYSTEM=="usb", ATTR{idVendor}=="04d9", ATTR{idProduct}=="a052", MODE="0666"
2 |
--------------------------------------------------------------------------------
/graph/rrd/update_graph.sh:
--------------------------------------------------------------------------------
1 | #!/bin/bash
2 | while true; do
3 | make graph-all-1d.png
4 | for i in {1..12}; do
5 | make graph-all-1h.png
6 | sleep 5
7 | done
8 | done
9 |
--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
1 | language: c
2 | dist: trusty
3 | compiler:
4 | - clang
5 | - gcc
6 | addons:
7 | apt:
8 | packages:
9 | - cmake
10 | - libhidapi-dev
11 | script: mkdir build && cd build && cmake .. && cmake --build .
12 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | /build
2 | /graph/graph-56-1d.png
3 | /graph/graph-56-1h.png
4 | /graph/graph-6d-1d.png
5 | /graph/graph-6d-1h.png
6 | /graph/graph-co2-1d.png
7 | /graph/graph-co2-1h.png
8 | /graph/graph-temp-1d.png
9 | /graph/graph-temp-1h.png
10 | /graph/graph.rrd
11 |
12 |
--------------------------------------------------------------------------------
/graph/collectd/co2mon.conf.example:
--------------------------------------------------------------------------------
1 | # Don't forget to 'LoadPlugin python' or 'AutoLoadPlugin true'
2 |
3 |
4 | ModulePath "/etc/collectd_python_plugins"
5 | LogTraces true
6 | Interactive false
7 | Import "co2mon"
8 |
9 | #
10 | # #This is default value
11 | # datadir "/var/lib/co2mon/"
12 | #
13 |
14 |
15 |
--------------------------------------------------------------------------------
/graph/rrd/update_data.sh:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 | last_co2=U
3 | last_temp=U
4 |
5 | update_rrd() {
6 | rrdtool update graph.rrd --template CO2:TEMP -- N:$last_co2:$last_temp
7 | }
8 |
9 | ../../build/co2mond/co2mond | while read -r name value; do
10 | echo "$name $value"
11 | if [ "$name" = "CntR" ]; then
12 | last_co2=$value
13 | update_rrd
14 | elif [ "$name" = "Tamb" ]; then
15 | last_temp=$value
16 | update_rrd
17 | fi
18 | done
19 |
--------------------------------------------------------------------------------
/CMakeLists.txt:
--------------------------------------------------------------------------------
1 | project(co2mon)
2 | cmake_minimum_required(VERSION 2.8)
3 |
4 | # Known configuration points:
5 | #
6 | # -DBUILD_SHARED_LIBS=OFF
7 | # -DCMAKE_INSTALL_BINDIR=bin
8 | # -DCMAKE_INSTALL_LIBDIR=lib
9 | #
10 | # More variables you may find at https://cmake.org/Wiki/CMake_Useful_Variables
11 |
12 | include(GNUInstallDirs)
13 |
14 | set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -std=c99")
15 | set(CMAKE_C_FLAGS_DEBUG "${CMAKE_C_FLAGS_DEBUG} -Wall -Wextra")
16 |
17 | add_subdirectory(libco2mon)
18 | add_subdirectory(co2mond)
19 |
--------------------------------------------------------------------------------
/graph/rrd/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 | 1h
10 |
11 |
12 |
13 |
14 | 1d
15 | 
16 | 
17 | 
18 | 
19 |
20 |
21 |
22 |
--------------------------------------------------------------------------------
/co2mond/CMakeLists.txt:
--------------------------------------------------------------------------------
1 | project(co2mond)
2 | cmake_minimum_required(VERSION 2.8)
3 |
4 | find_package(PkgConfig)
5 | pkg_search_module(HIDAPI REQUIRED hidapi-libusb hidapi)
6 |
7 | include_directories(
8 | ../libco2mon/include
9 | ${HIDAPI_INCLUDE_DIRS})
10 |
11 | link_directories(${HIDAPI_LIBRARY_DIRS})
12 |
13 | aux_source_directory(src SRC_LIST)
14 | add_executable(co2mond ${SRC_LIST})
15 | target_link_libraries(co2mond
16 | co2mon
17 | pthread
18 | ${HIDAPI_LIBRARIES})
19 |
20 | install(TARGETS co2mond
21 | RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR})
22 |
--------------------------------------------------------------------------------
/libco2mon/include/config.h.in:
--------------------------------------------------------------------------------
1 | /*
2 | * co2mon - programming interface to CO2 sensor.
3 | * Copyright (C) 2015 Oleg Bulatov
4 | *
5 | * This program is free software: you can redistribute it and/or modify
6 | * it under the terms of the GNU General Public License as published by
7 | * the Free Software Foundation, either version 3 of the License, or
8 | * (at your option) any later version.
9 | *
10 | * This program is distributed in the hope that it will be useful,
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 | * GNU General Public License for more details.
14 | *
15 | * You should have received a copy of the GNU General Public License
16 | * along with this program. If not, see .
17 | */
18 | #ifndef CO2_MON_CONFIG_H_INCLUDED_
19 | #define CO2_MON_CONFIG_H_INCLUDED_
20 |
21 | #cmakedefine HAVE_LIBUSB_STRERROR 1
22 |
23 | #endif
24 |
--------------------------------------------------------------------------------
/graph/collectd/co2mon.py:
--------------------------------------------------------------------------------
1 | import collectd
2 | import os
3 |
4 | CO2MOND_DATADIR = '/var/lib/co2mon/'
5 | vl = collectd.Values(plugin='co2mon')
6 |
7 | def read_metric(name):
8 | v = open(os.path.join(CO2MOND_DATADIR, name)).read()
9 | try:
10 | return int(v)
11 | except ValueError:
12 | return float(v)
13 |
14 |
15 | def read_callback(data=None):
16 | global vl
17 | try:
18 | heartbeat = read_metric('heartbeat')
19 | except:
20 | heartbeat = None
21 | if heartbeat:
22 | if heartbeat > vl.time:
23 | vl.time = heartbeat
24 | else:
25 | return
26 | co2 = [read_metric('CntR')]
27 | temp = [read_metric('Tamb')]
28 | vl.dispatch(values=co2, type='gauge', type_instance='co2_ppm')
29 | vl.dispatch(values=temp, type='temperature')
30 |
31 |
32 | def configure_callback(conf):
33 | global CO2MOND_DATADIR
34 | for c in conf.children:
35 | if c.key == 'datadir':
36 | CO2MOND_DATADIR = c.values[0]
37 |
38 |
39 | collectd.register_read(read_callback)
40 | collectd.register_config(configure_callback)
41 |
--------------------------------------------------------------------------------
/libco2mon/CMakeLists.txt:
--------------------------------------------------------------------------------
1 | project(libco2mon)
2 | cmake_minimum_required(VERSION 2.8)
3 |
4 | find_package(PkgConfig)
5 | # hidapi-libusb - Ubuntu 14.04 (trusty)
6 | # hidapi - homebrew on OS X 10.10 (Yosemite)
7 | pkg_search_module(HIDAPI REQUIRED hidapi-libusb hidapi)
8 |
9 | include_directories(
10 | include
11 | ${CMAKE_CURRENT_BINARY_DIR}/include
12 | ${HIDAPI_INCLUDE_DIRS})
13 |
14 | link_directories(
15 | ${HIDAPI_LIBRARY_DIRS})
16 |
17 | include(CheckSymbolExists)
18 | set(CMAKE_REQUIRED_INCLUDES ${HIDAPI_INCLUDE_DIRS})
19 | set(CMAKE_REQUIRED_LIBRARIES ${HIDAPI_LIBRARIES})
20 | check_symbol_exists(libusb_strerror "libusb.h" HAVE_HIDAPI_STRERROR)
21 | set(CMAKE_REQUIRED_INCLUDES)
22 | set(CMAKE_REQUIRED_LIBRARIES)
23 |
24 | configure_file(
25 | ${CMAKE_CURRENT_SOURCE_DIR}/include/config.h.in
26 | ${CMAKE_CURRENT_BINARY_DIR}/include/config.h)
27 |
28 | aux_source_directory(src SRC_LIST)
29 | add_library(co2mon ${SRC_LIST})
30 | target_link_libraries(co2mon
31 | ${HIDAPI_LIBRARIES})
32 | set_target_properties(co2mon PROPERTIES
33 | SOVERSION 1)
34 |
35 | install(TARGETS co2mon
36 | LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
37 | ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR})
38 | install(FILES include/co2mon.h
39 | DESTINATION ${CMAKE_INSTALL_INCLUDEDIR})
40 |
41 |
--------------------------------------------------------------------------------
/libco2mon/include/co2mon.h:
--------------------------------------------------------------------------------
1 | /*
2 | * co2mon - programming interface to CO2 sensor.
3 | * Copyright (C) 2015 Oleg Bulatov
4 | *
5 | * This program is free software: you can redistribute it and/or modify
6 | * it under the terms of the GNU General Public License as published by
7 | * the Free Software Foundation, either version 3 of the License, or
8 | * (at your option) any later version.
9 | *
10 | * This program is distributed in the hope that it will be useful,
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 | * GNU General Public License for more details.
14 | *
15 | * You should have received a copy of the GNU General Public License
16 | * along with this program. If not, see .
17 | */
18 | #ifndef CO2MON_H_INCLUDED_
19 | #define CO2MON_H_INCLUDED_
20 |
21 | #include
22 |
23 | typedef hid_device *co2mon_device;
24 |
25 | typedef unsigned char co2mon_data_t[8];
26 |
27 | extern int
28 | co2mon_init(int);
29 |
30 | extern void
31 | co2mon_exit();
32 |
33 | extern co2mon_device
34 | co2mon_open_device();
35 |
36 | extern co2mon_device
37 | co2mon_open_device_path(const char *path);
38 |
39 | extern void
40 | co2mon_close_device(co2mon_device dev);
41 |
42 | extern int
43 | co2mon_device_path(co2mon_device dev, char *str, size_t maxlen);
44 |
45 | extern int
46 | co2mon_send_magic_table(co2mon_device dev, co2mon_data_t magic_table);
47 |
48 | extern int
49 | co2mon_read_data(co2mon_device dev, co2mon_data_t magic_table, co2mon_data_t result);
50 |
51 | #endif
52 |
--------------------------------------------------------------------------------
/graph/rrd/Makefile:
--------------------------------------------------------------------------------
1 | graph.rrd:
2 | # 17280 = 24*60*60/5
3 | # 12 = 60/5
4 | # 43200 = 30*24*60*60/60
5 | rrdtool create $@ --step 5 \
6 | \
7 | DS:CO2:GAUGE:60:0:3000 \
8 | DS:TEMP:GAUGE:60:0:40 \
9 | DS:x6d:GAUGE:60:0:3000 \
10 | DS:x56:GAUGE:60:8000:10000 \
11 | \
12 | RRA:AVERAGE:0:1:17280 \
13 | RRA:AVERAGE:0.5:12:43200
14 |
15 | graph-all-1h.png: graph.rrd
16 | rrdtool graph graph-co2-1h.png --start end-1h --end now --width 600 --height 300 --alt-autoscale --alt-y-grid \
17 | DEF:co2=$^:CO2:AVERAGE \
18 | 'LINE:co2#0000ff:co2 line'
19 | rrdtool graph graph-temp-1h.png --start end-1h --end now --width 600 --height 300 --alt-autoscale --alt-y-grid \
20 | DEF:temp=$^:TEMP:AVERAGE \
21 | 'LINE:temp#00ff00:temp line'
22 | rrdtool graph graph-6d-1h.png --start end-1h --end now --width 600 --height 300 --alt-autoscale --alt-y-grid \
23 | DEF:x6d=$^:x6d:AVERAGE \
24 | 'LINE:x6d#ff0000:x6d line'
25 | rrdtool graph graph-56-1h.png --start end-1h --end now --width 600 --height 300 --alt-autoscale --alt-y-grid \
26 | DEF:x56=$^:x56:AVERAGE \
27 | 'LINE:x56#00ffff:x56 line'
28 |
29 | graph-all-1d.png: graph.rrd
30 | rrdtool graph graph-co2-1d.png --start end-1d --end now --width 1200 --height 400 --alt-autoscale --alt-y-grid \
31 | DEF:co2=$^:CO2:AVERAGE \
32 | 'LINE:co2#0000ff:co2 line'
33 | rrdtool graph graph-temp-1d.png --start end-1d --end now --width 1200 --height 400 --alt-autoscale --alt-y-grid \
34 | DEF:temp=$^:TEMP:AVERAGE \
35 | 'LINE:temp#00ff00:temp line'
36 | rrdtool graph graph-6d-1d.png --start end-1d --end now --width 1200 --height 400 --alt-autoscale --alt-y-grid \
37 | DEF:x6d=$^:x6d:AVERAGE \
38 | 'LINE:x6d#ff0000:x6d line'
39 | rrdtool graph graph-56-1d.png --start end-1d --end now --width 1200 --height 400 --alt-autoscale --alt-y-grid \
40 | DEF:x56=$^:x56:AVERAGE \
41 | 'LINE:x56#00ffff:x56 line'
42 |
--------------------------------------------------------------------------------
/graph/munin/co2mon:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 | # -*- sh -*-
3 |
4 | : << =cut
5 |
6 | =head1 NAME
7 |
8 | co2mon - Plugin to monitor MT8057 (RAD-0301) CO2 ppm and temperature values.
9 |
10 | =head1 NOTES
11 |
12 |
13 | =head1 CONFIGURATION
14 |
15 | The following environment variables are used by this plugin:
16 |
17 | co2_warning - Warning CO2 ppm (Default: 800)
18 | co2_critical - Critical CO2 ppm (Default: 1200)
19 | temp_warning - Warning temp (Default: 30)
20 | temp_critical - Critical temp (Default: 35)
21 |
22 | =head1 MAGIC MARKERS:
23 |
24 | #%# family=auto
25 | #%# capabilities=autoconf
26 |
27 | =cut
28 |
29 | . $MUNIN_LIBDIR/plugins/plugin.sh
30 | is_multigraph
31 |
32 | DATADIR='/var/lib/co2mon'
33 | CO2_FILE="$DATADIR/CntR"
34 | TEMP_FILE="$DATADIR/Tamb"
35 | HEARTBEAT_FILE="$DATADIR/heartbeat"
36 |
37 | print_values() {
38 | read co2 < "$CO2_FILE"
39 | read temp < "$TEMP_FILE"
40 | read heartbeat_sec < "$HEARTBEAT_FILE"
41 |
42 | echo 'multigraph co2mon'
43 | echo "co2.value ${heartbeat_sec:+$heartbeat_sec:}${co2:-U}"
44 | echo 'multigraph co2mon_temp'
45 | echo "temp.value ${heartbeat_sec:+$heartbeat_sec:}${temp:-U}"
46 | }
47 |
48 | if [ "$1" = "autoconf" ]; then
49 | if [ -s "$CO2_FILE" -o -s "$TEMP_FILE" ] ; then
50 | echo yes
51 | else
52 | echo no
53 | fi
54 | exit 0
55 | fi
56 |
57 | if [ "$1" = "config" ]; then
58 | echo 'multigraph co2mon'
59 | echo "graph_title CO2 ppm"
60 | # echo 'graph_args --upper-limit 3000 -l 0'
61 | echo 'graph_vlabel ppm'
62 | # echo 'graph_scale no'
63 | echo 'graph_category sensors'
64 | echo "co2.label CO2 ppm"
65 | co2_warning=${co2_warning:-800}
66 | co2_critical=${co2_critical:-1200}
67 | print_thresholds 'co2'
68 |
69 | echo 'multigraph co2mon_temp'
70 | echo "graph_title Temperature"
71 | # echo 'graph_args --upper-limit 100 -l -10'
72 | echo 'graph_vlabel Degreess Celsius'
73 | # echo 'graph_scale no'
74 | echo 'graph_category sensors'
75 | echo "temp.label temp"
76 | temp_warning=${temp_warning:-30}
77 | temp_critical=${temp_critical:-35}
78 | print_thresholds 'temp'
79 |
80 | exit 0
81 | fi
82 |
83 | print_values
84 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Software for CO2 Monitor
2 |
3 | ## Compatible Devices
4 |
5 | This software supports compact USB-powered CO2 meters that identify as:
6 |
7 | ```
8 | idVendor 0x04d9 Holtek Semiconductor, Inc.
9 | idProduct 0xa052 USB-zyTemp
10 | ```
11 |
12 | A of 2023, there are two revisions of these product on the
13 | market, that can be distinguished by its serial and release
14 | numbers:
15 |
16 | ```
17 | ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
18 | old new
19 | ――――――――――――――――――――――――――――――――――
20 | serial_number 1.40 2.00
21 | release_number 0x0100 0x0200
22 | ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
23 | ```
24 |
25 | (where serial_number == iSerial and release_number == bcdDevice)
26 |
27 | The co2mon software tries to auto-detect them, but its also possible to
28 | override the detection (cf. the `-N` and `-n` options).
29 |
30 | Note that these devices are rebranded by vendors such as TFA and
31 | thus are available online under different product names (e.g.
32 | sold by Amazon, as of 2023). Even if one user reported success
33 | with a certain product, the vendor might have silently switched
34 | to a completely different and unsupported hardware without
35 | changing the product name, at any time.
36 |
37 | List of user reported devices that worked in the past:
38 |
39 | - TFA AIRCO2NTROL MINI CO2 Monitor (EAN 4009816027351), via
40 | Amazon.de, 2023
41 |
42 |
43 | ## Installation
44 |
45 | ### Arch Linux
46 | [There is PKGBUILD in AUR](https://aur.archlinux.org/packages/co2mon-git/). The simplest way to [install](https://wiki.archlinux.org/index.php/Arch_User_Repository#Installing_packages) is using yaourt:
47 |
48 | `yaourt -S co2mon-git`
49 |
50 | ### Fedora GNU/Linux and RHEL/CentOS/Scientific Linux
51 | co2mon packages can be installed from official repo:
52 |
53 | `dnf install co2mon`
54 |
55 | ### From Source
56 |
57 | # macOS
58 | brew install cmake pkg-config hidapi
59 |
60 | # Ubuntu
61 | apt-get install cmake g++ pkg-config libhidapi-dev
62 |
63 | mkdir build
64 | cd build
65 | cmake ..
66 | make
67 | ./co2mond/co2mond
68 |
69 | ## See also
70 |
71 | * [ZyAura ZG01C Module Manual](http://www.zyaura.com/support/manual/pdf/ZyAura_CO2_Monitor_ZG01C_Module_ApplicationNote_141120.pdf)
72 | * [RevSpace CO2 Meter Hacking](https://revspace.nl/CO2MeterHacking)
73 | * [Photos of the device and the circuit board](http://habrahabr.ru/company/masterkit/blog/248403/)
74 |
--------------------------------------------------------------------------------
/libco2mon/src/co2mon.c:
--------------------------------------------------------------------------------
1 | /*
2 | * co2mon - programming interface to CO2 sensor.
3 | * Copyright (C) 2015 Oleg Bulatov
4 | *
5 | * This program is free software: you can redistribute it and/or modify
6 | * it under the terms of the GNU General Public License as published by
7 | * the Free Software Foundation, either version 3 of the License, or
8 | * (at your option) any later version.
9 | *
10 | * This program is distributed in the hope that it will be useful,
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 | * GNU General Public License for more details.
14 | *
15 | * You should have received a copy of the GNU General Public License
16 | * along with this program. If not, see .
17 | */
18 |
19 | #include
20 | #include
21 | #include
22 |
23 | #include "co2mon.h"
24 |
25 | static int decode_data = -1;
26 |
27 | int
28 | co2mon_init(int decode)
29 | {
30 | int r = hid_init();
31 | if (r < 0)
32 | {
33 | fprintf(stderr, "hid_init: error\n");
34 | }
35 | decode_data = decode;
36 | return r;
37 | }
38 |
39 | void
40 | co2mon_exit()
41 | {
42 | int r = hid_exit();
43 | if (r < 0)
44 | {
45 | fprintf(stderr, "hid_exit: error\n");
46 | }
47 | }
48 |
49 | hid_device *
50 | co2mon_open_device()
51 | {
52 | hid_device *dev = hid_open(0x04d9, 0xa052, NULL);
53 | if (!dev)
54 | {
55 | fprintf(stderr, "hid_open: error\n");
56 | }
57 | else if (decode_data == -1)
58 | {
59 | struct hid_device_info *hdi = hid_get_device_info(dev);
60 | if (hdi && hdi->release_number > 0x0100) {
61 | decode_data = 0;
62 | } else {
63 | decode_data = 1;
64 | }
65 | }
66 | return dev;
67 | }
68 |
69 | hid_device *
70 | co2mon_open_device_path(const char *path)
71 | {
72 | hid_device *dev = hid_open_path(path);
73 | if (!dev)
74 | {
75 | fprintf(stderr, "hid_open_path: error\n");
76 | }
77 | return dev;
78 | }
79 |
80 | void
81 | co2mon_close_device(hid_device *dev)
82 | {
83 | hid_close(dev);
84 | }
85 |
86 | int
87 | co2mon_device_path(hid_device *dev, char *str, size_t maxlen)
88 | {
89 | str[0] = '\0';
90 | return 1;
91 | }
92 |
93 | int
94 | co2mon_send_magic_table(hid_device *dev, co2mon_data_t magic_table)
95 | {
96 | int r = hid_send_feature_report(dev, magic_table, sizeof(co2mon_data_t));
97 | if (r < 0 || r != sizeof(co2mon_data_t))
98 | {
99 | fprintf(stderr, "hid_send_feature_report: error\n");
100 | return 0;
101 | }
102 | return 1;
103 | }
104 |
105 | static void
106 | swap_char(unsigned char *a, unsigned char *b)
107 | {
108 | unsigned char tmp = *a;
109 | *a = *b;
110 | *b = tmp;
111 | }
112 |
113 | static void
114 | decode_buf(co2mon_data_t result, co2mon_data_t buf, co2mon_data_t magic_table)
115 | {
116 | if (decode_data) {
117 | swap_char(&buf[0], &buf[2]);
118 | swap_char(&buf[1], &buf[4]);
119 | swap_char(&buf[3], &buf[7]);
120 | swap_char(&buf[5], &buf[6]);
121 |
122 | for (int i = 0; i < 8; ++i)
123 | {
124 | buf[i] ^= magic_table[i];
125 | }
126 |
127 | unsigned char tmp = (buf[7] << 5);
128 | result[7] = (buf[6] << 5) | (buf[7] >> 3);
129 | result[6] = (buf[5] << 5) | (buf[6] >> 3);
130 | result[5] = (buf[4] << 5) | (buf[5] >> 3);
131 | result[4] = (buf[3] << 5) | (buf[4] >> 3);
132 | result[3] = (buf[2] << 5) | (buf[3] >> 3);
133 | result[2] = (buf[1] << 5) | (buf[2] >> 3);
134 | result[1] = (buf[0] << 5) | (buf[1] >> 3);
135 | result[0] = tmp | (buf[0] >> 3);
136 |
137 | const unsigned char magic_word[8] = "Htemp99e";
138 | for (int i = 0; i < 8; ++i)
139 | {
140 | result[i] -= (magic_word[i] << 4) | (magic_word[i] >> 4);
141 | }
142 | } else memcpy(result, buf, 8);
143 | }
144 |
145 | int
146 | co2mon_read_data(hid_device *dev, co2mon_data_t magic_table, co2mon_data_t result)
147 | {
148 | co2mon_data_t data = { 0 };
149 | int actual_length = hid_read_timeout(dev, data, sizeof(co2mon_data_t), 5000 /* milliseconds */);
150 | if (actual_length < 0)
151 | {
152 | fprintf(stderr, "hid_read_timeout: error\n");
153 | return actual_length;
154 | }
155 | if (actual_length != sizeof(co2mon_data_t))
156 | {
157 | fprintf(stderr, "hid_read_timeout: transferred %d bytes, expected %lu bytes\n", actual_length, (unsigned long)sizeof(co2mon_data_t));
158 | return 0;
159 | }
160 |
161 | decode_buf(result, data, magic_table);
162 | return actual_length;
163 | }
164 |
--------------------------------------------------------------------------------
/co2mond/src/main.c:
--------------------------------------------------------------------------------
1 | /*
2 | * co2mon - programming interface to CO2 sensor.
3 | * Copyright (C) 2015 Oleg Bulatov
4 | *
5 | * This program is free software: you can redistribute it and/or modify
6 | * it under the terms of the GNU General Public License as published by
7 | * the Free Software Foundation, either version 3 of the License, or
8 | * (at your option) any later version.
9 | *
10 | * This program is distributed in the hope that it will be useful,
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 | * GNU General Public License for more details.
14 | *
15 | * You should have received a copy of the GNU General Public License
16 | * along with this program. If not, see .
17 | */
18 |
19 | #define _XOPEN_SOURCE 700 /* strnlen */
20 | #define _BSD_SOURCE /* daemon() in glibc before 2.19 */
21 | #define _DEFAULT_SOURCE /* _BSD_SOURCE is deprecated in glibc 2.19+ */
22 | #define _DARWIN_C_SOURCE /* daemon() on macOS */
23 |
24 | #include
25 | #include
26 | #include
27 | #include
28 | #include
29 | #include
30 | #include
31 | #include
32 | #include
33 | #include
34 | #include
35 | #include
36 | #include
37 | #include
38 |
39 | #include "co2mon.h"
40 |
41 | #define CODE_TAMB 0x42 /* Ambient Temperature */
42 | #define CODE_CNTR 0x50 /* Relative Concentration of CO2 */
43 |
44 | #define PATH_MAX 4096
45 | #define VALUE_MAX 20
46 |
47 | int daemonize = 0;
48 | int print_unknown = 0;
49 | static int decode_data = -1; /* -1 == auto-detect old/new release devices */
50 | const char *devicefile = NULL;
51 | char *datadir;
52 |
53 | struct co2mon_state {
54 | uint16_t data[256];
55 | uint8_t seen[32];
56 | time_t heatbeat;
57 | unsigned int deverr;
58 | };
59 |
60 | pthread_mutex_t state_mutex = PTHREAD_MUTEX_INITIALIZER;
61 | struct co2mon_state co2mon;
62 |
63 | static int
64 | bitarr_isset(uint8_t* bitarr, unsigned int ndx)
65 | {
66 | return bitarr[ndx >> 3] & (1u << (ndx & 0x07u)) ? 1 : 0;
67 | }
68 |
69 | static void
70 | bitarr_set(uint8_t* bitarr, unsigned int ndx)
71 | {
72 | bitarr[ndx >> 3] |= 1u << (ndx & 0x07u);
73 | }
74 |
75 | static void
76 | state_lock()
77 | {
78 | if (pthread_mutex_lock(&state_mutex) != 0)
79 | {
80 | err(EXIT_FAILURE, "pthread_mutex_lock");
81 | }
82 | }
83 |
84 | static void
85 | state_unlock()
86 | {
87 | if (pthread_mutex_unlock(&state_mutex) != 0)
88 | {
89 | err(EXIT_FAILURE, "pthread_mutex_unlock");
90 | }
91 | }
92 |
93 | static int
94 | lock(int fd, short int type)
95 | {
96 | struct flock lock;
97 | lock.l_start = 0;
98 | lock.l_len = 0;
99 | lock.l_whence = SEEK_SET;
100 | lock.l_type = type;
101 | return fcntl(fd, F_SETLKW, &lock);
102 | }
103 |
104 | static double
105 | decode_temperature(uint16_t w)
106 | {
107 | return (double)w * 0.0625 - 273.15;
108 | }
109 |
110 | static int
111 | write_data(int fd, const char *value)
112 | {
113 | char data[VALUE_MAX + 1];
114 | snprintf(data, VALUE_MAX + 1, "%s\n", value);
115 |
116 | if (lock(fd, F_WRLCK) != 0)
117 | {
118 | perror("lock");
119 | return 0;
120 | }
121 |
122 | if (ftruncate(fd, 0) != 0)
123 | {
124 | perror("ftruncate");
125 | return 0;
126 | }
127 |
128 | ssize_t len = strnlen(data, VALUE_MAX + 1);
129 | if (write(fd, data, len) != len)
130 | {
131 | perror("write");
132 | return 0;
133 | }
134 |
135 | if (lock(fd, F_UNLCK) != 0)
136 | {
137 | perror("unlock");
138 | return 0;
139 | }
140 |
141 | return 1;
142 | }
143 |
144 | static int
145 | write_value(const char *name, const char *value)
146 | {
147 | if (!datadir)
148 | {
149 | return 1;
150 | }
151 |
152 | char filename[PATH_MAX];
153 | snprintf(filename, PATH_MAX, "%s/%s", datadir, name);
154 |
155 | int fd = open(filename, O_CREAT | O_WRONLY, 0666);
156 | if (fd == -1)
157 | {
158 | perror(filename);
159 | return 0;
160 | }
161 |
162 | int result = write_data(fd, value);
163 | close(fd);
164 | return result;
165 | }
166 |
167 | static void
168 | write_heartbeat()
169 | {
170 | char buf[VALUE_MAX];
171 | const time_t now = time(0);
172 | snprintf(buf, VALUE_MAX, "%lld", (long long)now);
173 | write_value("heartbeat", buf);
174 | state_lock();
175 | co2mon.heatbeat = now;
176 | state_unlock();
177 | }
178 |
179 | static int
180 | read_match_path(FILE* fd)
181 | {
182 | // Prefix has no \r\n to support HTTP/1.0 requests with no headers.
183 | const char *prefix = "GET /metrics HTTP/1.";
184 | const int len = strlen(prefix);
185 | for (int i = 0; i < len; ++i)
186 | {
187 | int next = fgetc(fd);
188 | if (next == EOF || next != prefix[i]) // EOF or mismatch
189 | {
190 | return -1;
191 | }
192 | }
193 | return 0;
194 | }
195 |
196 | static int
197 | read_find_crlfcrlf(FILE* fd)
198 | {
199 | const char *substring = "\x0d\x0a\x0d\x0a";
200 | const int len = strlen(substring);
201 | // automata is tivial as `substring` has no repeated chars
202 | for (int i = 0; i < len; ++i)
203 | {
204 | assert(i >= 0);
205 | int next = fgetc(fd);
206 | if (next == EOF)
207 | {
208 | return -1;
209 | }
210 | if (next != substring[i])
211 | {
212 | if (next == substring[0])
213 | {
214 | i = 0;
215 | }
216 | else
217 | {
218 | i = -1;
219 | }
220 | }
221 | }
222 | return 0;
223 | }
224 |
225 | static void*
226 | prometheus_thread(void *arg)
227 | {
228 | const int listen_fd = (ssize_t)arg;
229 | while (1) {
230 | const int client_fd = accept(listen_fd, NULL, NULL);
231 | const struct timeval maxdelay = { 5, 0 }; // 5 seconds, just like co2mon_read_data()
232 | struct co2mon_state copy;
233 | FILE* out = NULL;
234 |
235 | if (client_fd == -1)
236 | {
237 | perror("accept");
238 | continue;
239 | }
240 |
241 | if (setsockopt(client_fd, SOL_SOCKET, SO_RCVTIMEO, &maxdelay, sizeof(maxdelay)) != 0 ||
242 | setsockopt(client_fd, SOL_SOCKET, SO_SNDTIMEO, &maxdelay, sizeof(maxdelay)) != 0)
243 | {
244 | perror("setsockopt");
245 | goto cleanup;
246 | }
247 |
248 | out = fdopen(client_fd, "a+b");
249 | if (!out)
250 | {
251 | perror("fdopen");
252 | goto cleanup;
253 | }
254 |
255 | if (read_match_path(out) != 0 || read_find_crlfcrlf(out) != 0)
256 | {
257 | fprintf(out,
258 | "HTTP/1.0 400 Bad Request\r\n"
259 | "Server: co2mond\r\n"
260 | "Connection: close\r\n"
261 | "\r\n"
262 | "goto /metrics;\r\n"
263 | );
264 | goto flush;
265 | }
266 |
267 | state_lock();
268 | memcpy(©, &co2mon, sizeof(copy));
269 | state_unlock();
270 |
271 | if (!bitarr_isset(copy.seen, CODE_TAMB) || !bitarr_isset(copy.seen, CODE_CNTR))
272 | {
273 | fprintf(out,
274 | "HTTP/1.0 503 Service Unavailable\r\n"
275 | "Server: co2mond\r\n"
276 | "Connection: close\r\n"
277 | "\r\n"
278 | "Device not ready.\r\n"
279 | );
280 | goto flush;
281 | }
282 |
283 | fprintf(out,
284 | "HTTP/1.0 200 OK\r\n"
285 | "Content-Type: text/plain; charset=utf-8\r\n"
286 | "Server: co2mond\r\n"
287 | "Connection: close\r\n"
288 | "\r\n"
289 | );
290 |
291 | // Note, HTTP has \r\n and Prometheus uses \n as line separator.
292 |
293 | if (print_unknown)
294 | {
295 | int has_unknown = 0;
296 | for (int i = 0; i < sizeof(copy.data) / sizeof(copy.data[0]); ++i)
297 | {
298 | if (bitarr_isset(copy.seen, i) && i != CODE_TAMB && i != CODE_CNTR)
299 | {
300 | has_unknown = 1;
301 | break;
302 | }
303 | }
304 | if (has_unknown)
305 | {
306 | fprintf(out,
307 | "# HELP co2mon_unknown Unknown value.\n"
308 | "# TYPE co2mon_unknown gauge\n"
309 | );
310 | for (int i = 0; i < sizeof(copy.data) / sizeof(copy.data[0]); ++i)
311 | {
312 | if (bitarr_isset(copy.seen, i) && i != CODE_TAMB && i != CODE_CNTR)
313 | {
314 | fprintf(out, "co2mon_unknown{key=\"x%02x\"} %d\n", i, copy.data[i]);
315 | }
316 | }
317 | }
318 | }
319 | fprintf(out,
320 | "# HELP co2mon_temp_celsius Ambient temperature.\n"
321 | "# TYPE co2mon_temp_celsius gauge\n"
322 | "co2mon_temp_celsius %.4f\n"
323 | "# HELP co2mon_co2_ppm Concentration of CO2, parts per million.\n"
324 | "# TYPE co2mon_co2_ppm gauge\n"
325 | "co2mon_co2_ppm %d\n"
326 | "# HELP co2mon_device_errors_total CO2 monitor device error counter.\n"
327 | "# TYPE co2mon_device_errors_total counter\n"
328 | "co2mon_device_errors_total %d\n"
329 | "# HELP co2mon_heartbeat_time_seconds CO2 monitor heartbeat timestamp.\n"
330 | "# TYPE co2mon_heartbeat_time_seconds gauge\n"
331 | "co2mon_heartbeat_time_seconds %lld\n",
332 | decode_temperature(copy.data[CODE_TAMB]),
333 | copy.data[CODE_CNTR],
334 | copy.deverr,
335 | (long long)copy.heatbeat
336 | );
337 | flush:
338 | fflush(out);
339 | if (shutdown(client_fd, SHUT_WR) != 0)
340 | {
341 | perror("shutdown");
342 | goto cleanup;
343 | }
344 | fgetc(out); // wait till EOF (or timeout) before calling close()
345 | cleanup:
346 | if (out)
347 | {
348 | fclose(out);
349 | }
350 | else
351 | {
352 | close(client_fd);
353 | }
354 |
355 | }
356 | }
357 |
358 | static void
359 | device_loop(co2mon_device dev)
360 | {
361 | co2mon_data_t magic_table = { 0 };
362 | co2mon_data_t result;
363 | uint16_t written_tamb = 0;
364 | uint16_t written_cntr = 0;
365 |
366 | if (!co2mon_send_magic_table(dev, magic_table))
367 | {
368 | state_lock();
369 | co2mon.deverr++;
370 | state_unlock();
371 | fprintf(stderr, "Unable to send magic table to CO2 device\n");
372 | return;
373 | }
374 |
375 | state_lock();
376 | memset(co2mon.seen, 0, sizeof(co2mon.seen));
377 | state_unlock();
378 |
379 | while (1)
380 | {
381 | int r = co2mon_read_data(dev, magic_table, result);
382 | if (r <= 0)
383 | {
384 | state_lock();
385 | co2mon.deverr++;
386 | state_unlock();
387 | fprintf(stderr, "Error while reading data from device\n");
388 | break;
389 | }
390 |
391 | if (result[4] != 0x0d)
392 | {
393 | state_lock();
394 | co2mon.deverr++;
395 | state_unlock();
396 | fprintf(stderr, "Unexpected data from device (data[4] = %02hhx, want 0x0d)\n", result[4]);
397 | continue;
398 | }
399 |
400 | unsigned char r0, r1, r2, r3, checksum;
401 | r0 = result[0];
402 | r1 = result[1];
403 | r2 = result[2];
404 | r3 = result[3];
405 | checksum = r0 + r1 + r2;
406 | if (checksum != r3)
407 | {
408 | state_lock();
409 | co2mon.deverr++;
410 | state_unlock();
411 | fprintf(stderr, "checksum error (%02hhx, await %02hhx)\n", checksum, r3);
412 | continue;
413 | }
414 |
415 | char buf[VALUE_MAX];
416 | uint16_t w = (result[1] << 8) + result[2];
417 |
418 | switch (r0)
419 | {
420 | case CODE_TAMB:
421 | snprintf(buf, VALUE_MAX, "%.4f", decode_temperature(w));
422 |
423 | if (!daemonize)
424 | {
425 | printf("Tamb\t%s\n", buf);
426 | fflush(stdout);
427 | }
428 |
429 | if (written_tamb != w)
430 | {
431 | if (write_value("Tamb", buf))
432 | {
433 | written_tamb = w;
434 | }
435 | }
436 |
437 | write_heartbeat();
438 |
439 | break;
440 | case CODE_CNTR:
441 | if ((unsigned)w > 3000) {
442 | // Avoid reading spurious (uninitialized?) data
443 | break;
444 | }
445 | snprintf(buf, VALUE_MAX, "%d", (int)w);
446 |
447 | if (!daemonize)
448 | {
449 | printf("CntR\t%s\n", buf);
450 | fflush(stdout);
451 | }
452 |
453 | if (written_cntr != w)
454 | {
455 | if (write_value("CntR", buf))
456 | {
457 | written_cntr = w;
458 | }
459 | }
460 |
461 | write_heartbeat();
462 |
463 | break;
464 | default:
465 | if (print_unknown && !daemonize)
466 | {
467 | printf("0x%02hhx\t%d\n", r0, (int)w);
468 | fflush(stdout);
469 | }
470 | }
471 |
472 | state_lock();
473 | co2mon.data[r0] = w;
474 | bitarr_set(co2mon.seen, r0);
475 | state_unlock();
476 | }
477 | }
478 |
479 | static co2mon_device
480 | open_device()
481 | {
482 | if (devicefile)
483 | {
484 | return co2mon_open_device_path(devicefile);
485 | }
486 | return co2mon_open_device();
487 | }
488 |
489 | static void
490 | main_loop()
491 | {
492 | int error_shown = 0;
493 | while (1)
494 | {
495 | co2mon_device dev = open_device();
496 | if (dev == NULL)
497 | {
498 | if (!error_shown)
499 | {
500 | fprintf(stderr, "Unable to open CO2 device\n");
501 | error_shown = 1;
502 | }
503 | sleep(1);
504 | continue;
505 | }
506 | else
507 | {
508 | error_shown = 0;
509 | }
510 |
511 | device_loop(dev);
512 |
513 | co2mon_close_device(dev);
514 | }
515 | }
516 |
517 | int main(int argc, char *argv[])
518 | {
519 | char *reldatadir = 0;
520 | char *promaddr = 0;
521 | char *pidfile = 0;
522 | char *logfile = 0;
523 |
524 | int c;
525 | int opterr = 0;
526 | int show_help = 0;
527 | while ((c = getopt(argc, argv, ":dnNhuD:P:f:l:p:")) != -1)
528 | {
529 | switch (c)
530 | {
531 | case 'd':
532 | daemonize = 1;
533 | break;
534 | case 'h':
535 | show_help = 1;
536 | break;
537 | case 'u':
538 | print_unknown = 1;
539 | break;
540 | case 'n':
541 | decode_data = 0;
542 | break;
543 | case 'N':
544 | decode_data = 1;
545 | break;
546 | case 'D':
547 | reldatadir = optarg;
548 | break;
549 | case 'P':
550 | promaddr = optarg;
551 | break;
552 | case 'f':
553 | devicefile = optarg;
554 | break;
555 | case 'l':
556 | logfile = optarg;
557 | break;
558 | case 'p':
559 | pidfile = optarg;
560 | break;
561 | case ':':
562 | fprintf(stderr, "Option -%c requires an operand\n", optopt);
563 | opterr++;
564 | break;
565 | case '?':
566 | fprintf(stderr, "Unrecognized option: -%c\n", optopt);
567 | opterr++;
568 | }
569 | }
570 | if (show_help || opterr || optind != argc)
571 | {
572 | fprintf(stderr, "usage: co2mond [-dhun] [-D datadir] [-f device] [-p pidfle] [-l logfile]\n");
573 | if (show_help)
574 | {
575 | fprintf(stderr, "\n");
576 | fprintf(stderr, " -d run as a daemon\n");
577 | fprintf(stderr, " -h show this help message\n");
578 | fprintf(stderr, " -u print values for unknown items\n");
579 | fprintf(stderr, " -n use payload as-is, as delivered by 2nd release devices (overrides auto-detection)\n");
580 | fprintf(stderr, " -N decode payload that is scrambled by 1st release devices (overrides auto-detection)\n");
581 | fprintf(stderr, " -D datadir\n");
582 | fprintf(stderr, " store values from the sensor in datadir\n");
583 | fprintf(stderr, " -P host:port\n");
584 | fprintf(stderr, " address on which to expose metrics\n");
585 | fprintf(stderr, " -f devicefile\n");
586 | #ifdef __linux__
587 | fprintf(stderr, " path to a device (e.g., /dev/hidraw0)\n");
588 | #else
589 | fprintf(stderr, " path to a device\n");
590 | #endif
591 | fprintf(stderr, " -p pidfile\n");
592 | fprintf(stderr, " write PID to a file named pidfile\n");
593 | fprintf(stderr, " -l logfile\n");
594 | fprintf(stderr, " write diagnostic information to a file named logfile\n");
595 | fprintf(stderr, "\n");
596 | }
597 | exit(1);
598 | }
599 | if (daemonize && !reldatadir && !promaddr)
600 | {
601 | fprintf(stderr, "co2mond: it is useless to use -d without -D or -P.\n");
602 | exit(1);
603 | }
604 |
605 | if (reldatadir)
606 | {
607 | datadir = realpath(reldatadir, NULL);
608 | if (datadir == NULL)
609 | {
610 | perror(reldatadir);
611 | exit(1);
612 | }
613 | }
614 |
615 | int pidfd = -1;
616 | if (pidfile)
617 | {
618 | pidfd = open(pidfile, O_CREAT | O_WRONLY | O_TRUNC, 0666);
619 | if (pidfd == -1)
620 | {
621 | perror(pidfile);
622 | exit(1);
623 | }
624 | }
625 |
626 | int logfd = -1;
627 | if (logfile)
628 | {
629 | logfd = open(logfile, O_CREAT | O_WRONLY | O_APPEND, 0666);
630 | if (logfd == -1)
631 | {
632 | perror(logfile);
633 | exit(1);
634 | }
635 | }
636 |
637 | int listen_fd = -1;
638 | if (promaddr)
639 | {
640 | char *copy = strdup(promaddr);
641 | char *colon = strrchr(copy, ':');
642 | char *port = colon ? colon + 1 : copy;
643 | if (colon)
644 | {
645 | *colon = '\0';
646 | }
647 | char *host =
648 | (!colon || copy[0] == '\0') ? NULL :
649 | (copy[0] == '[') ? copy + 1 :
650 | copy;
651 | if (host)
652 | {
653 | size_t hlen = strlen(host);
654 | if (copy[0] == '[' && hlen > 0 && host[hlen - 1] == ']')
655 | {
656 | host[hlen - 1] = '\0';
657 | }
658 | }
659 |
660 | struct addrinfo hints, *res;
661 | memset(&hints, 0, sizeof(hints));
662 | hints.ai_family = AF_UNSPEC;
663 | hints.ai_socktype = SOCK_STREAM;
664 | hints.ai_flags = AI_NUMERICHOST | AI_PASSIVE | AI_NUMERICSERV;
665 |
666 | int gai_errno = getaddrinfo(host, port, &hints, &res);
667 | if (gai_errno != 0)
668 | {
669 | errx(EXIT_FAILURE, "getaddrinfo(%s): %s", promaddr, gai_strerror(gai_errno));
670 | }
671 |
672 | listen_fd = socket(res->ai_family, res->ai_socktype, res->ai_protocol);
673 | if (listen_fd == -1)
674 | {
675 | err(EXIT_FAILURE, "socket");
676 | }
677 |
678 | int on = 1;
679 | if (setsockopt(listen_fd, SOL_SOCKET, SO_REUSEADDR, &on, sizeof(on)) != 0)
680 | {
681 | err(EXIT_FAILURE, "setsockopt(SO_REUSEADDR)");
682 | }
683 |
684 | if (bind(listen_fd, res->ai_addr, res->ai_addrlen) != 0)
685 | {
686 | err(EXIT_FAILURE, "bind");
687 | }
688 |
689 | if (listen(listen_fd, 128) != 0)
690 | {
691 | err(EXIT_FAILURE, "listen");
692 | }
693 |
694 | if (signal(SIGPIPE, SIG_IGN) != 0)
695 | {
696 | err(EXIT_FAILURE, "signal(SIGPIPE, SIG_IGN)");
697 | }
698 |
699 | free(copy);
700 | freeaddrinfo(res);
701 | }
702 |
703 | if (daemonize)
704 | {
705 | if (daemon(0, 0) == -1)
706 | {
707 | perror("daemon");
708 | exit(1);
709 | }
710 | }
711 |
712 | if (pidfd != -1)
713 | {
714 | char pid[VALUE_MAX];
715 | snprintf(pid, VALUE_MAX, "%lld", (long long)getpid());
716 | if (!write_data(pidfd, pid))
717 | {
718 | exit(1);
719 | }
720 | }
721 |
722 | if (listen_fd != -1)
723 | {
724 | pthread_t tid;
725 | if (pthread_create(&tid, NULL, prometheus_thread, (void*)((size_t)listen_fd)) != 0)
726 | {
727 | err(EXIT_FAILURE, "pthread_create");
728 | }
729 |
730 | if (pthread_detach(tid) != 0)
731 | {
732 | err(EXIT_FAILURE, "pthread_detach");
733 | }
734 | }
735 |
736 | if (logfd != -1)
737 | {
738 | dup2(logfd, fileno(stderr));
739 | close(logfd);
740 | }
741 |
742 | int r = co2mon_init(decode_data);
743 | if (r < 0)
744 | {
745 | return r;
746 | }
747 |
748 | main_loop();
749 |
750 | co2mon_exit();
751 |
752 | if (datadir)
753 | {
754 | free(datadir);
755 | }
756 | return 1;
757 | }
758 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------