-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathsetup.py
executable file
·133 lines (106 loc) · 4.82 KB
/
setup.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
#!/usr/bin/env python3
#
# Copyright (c) 2016, Heinrich Schuchardt <[email protected]>
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# * Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
#
# * Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY
# DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
from distutils.core import setup
import setuptools
import icsectl
setup(
name='icsectl',
version='0.2',
description='Control the ICStation USB multi channel relay modules',
author='Heinrich Schuchardt',
author_email='[email protected]',
license = 'BSD',
url='https://github.com/xypron/icsectl',
packages=['icsectl'],
long_description =
"""
Summary
-------
IcseCtl is a library to control the ICStation USB multi channel relay
modules (ICSE012A, ICSE013A, ICSE014A).
Initialization
--------------
The initialization of the devices is handled by udev.
To set up udev::
sudo cp examples/icseudev.py /lib/udev
sudo cp examples/99-icsectl.rules /etc/udev/rules.d
sudo udevadm control --reload-rules
When a device is plugged in the relays are switched on by default.
After detection the icseudev.py script switches them off.
Symbolic links /dev/ttyICSE012A, /dev/ttyICSE013A, /devttyICSE014A are
created if a respective device is connected. If another PL2303 device
is connected a link /dev/ttyPL2303 is created.
Initialization is logged in the system log.
Permissions
-----------
Per default, only root is allowed to use devices directly.
On Debian and Ubuntu serial USB devices are assigned to group dialout.
To allow a user to use the device call::
adduser USER dialout
Usage
-----
The script examples/icsectl can be used to switch individual relays.
The status is kept in a file in the user's home directory.
If the file does not yet exist, it is assumed that all relays are switched off.
Links
-----
An overview of udev rules is provided at
http://www.reactivated.net/writing_udev_rules.html.
These are links to the devices on the vendor's site
* http://www.icstation.com/icstation-micro-control-channel-relay-module-p-4012.html
* http://www.icstation.com/icstation-micro-control-channel-relay-module-icse013a-p-4013.html
* http://www.icstation.com/icstation-channel-micro-relay-module-icse014a-p-5185.html
License
-------
Copyright (c) 2016, Heinrich Schuchardt <[email protected]>
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
""",
classifiers=[
'Development Status :: 4 - Beta',
'Intended Audience :: Developers',
'License :: OSI Approved :: BSD License',
'Operating System :: POSIX',
'Programming Language :: Python :: 3',
'Topic :: System :: Hardware :: Hardware Drivers'
]
)