diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..0a04128 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,165 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + + Each version is given a distinguishing version number. If the +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. diff --git a/MANIFEST.in b/MANIFEST.in index cae98b7..241fa68 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,2 +1,4 @@ global-exclude test/* global-exclude *.pyc +include LICENSE.txt +include README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..ff8151a --- /dev/null +++ b/README.md @@ -0,0 +1,89 @@ +# RevPiModIO + +### Python3 programming for RevolutionPi of Kunbus GmbH. + +The module provides all devices and IOs from the piCtory configuration in Python3. It allows direct +access to the values via their assigned name. Read and write actions on the process image are +managed by the module itself without the programmer having to worry about offsets and addresses. +For the gateway modules such as ModbusTCP or Profinet, own 'inputs' and 'outputs' can be defined +over a specific address range. These IOs can be accessed directly from the values using Python3. + +#### [RevolutionPi Hardware](https://revolution.kunbus.com) +The hardware configuration is done via a web page, which is located on the PiCore module. The +program is called “piCtory”. + +All inputs and outputs can be assigned symbolic names to facilitate their handling and programming. +If this configuration is created and activated, the data of the input, output and gateway modules +are exchanged via a 4096-byte process image. + +#### [Our RevPiModIO module](https://revpimodio.org/) + +If you use our module in Python3, it uses the piCtory configuration to create all the inputs and +outputs with their symbolic names as objects. The programmer can address these directly via the +symbolic names and access the values of the inputs and outputs – both reading and writing! + +``` +import revpimodio2 +rpi = revpimodio2.RevPiModIO(autorefresh=True) + +# If input t_on is high, set output h_on high +if rpi.io.t_on.value: + rpi.io.h_on.value = True + +# Clean up and sync process image +rpi.exit() +``` + +In addition, it provides the developer with many useful functions that can be used to develop +cyclic or event-based programs. + +If you know the .add_event_detect(...) function of the GPIO module from the Raspberry Pi, you +can also achieve this behavior with the Revolution Pi: + +``` +import revpimodio2 +rpi = revpimodio2.RevPiModIO(autorefresh=True) + +def event_detect(ioname, iovalue): + """Event function.""" + + # Set actual input value to output 'h_on' + rpi.io.h_on.value = iovalue + + print(ioname, iovalue) + +# Bind event function to input 't_on' +rpi.io.t_on.reg_event(event_detect) + +rpi.mainloop() +``` + +Even with hardware changes, but constant names of the inputs and outputs, the actual Python3 +source code does not need to be changed! + +#### How it works: + +``` + |-----------------------------------------------------| + | | + | Python program | + | | +-------------------- | ---------------- -------------------- | +| | | | | | | | +| RevPi hardware | <-----> | RevPiModIO | <----> | Your source code | | +| | | | | | | | +-------------------- | ---------------- -------------------- | + | | + |-----------------------------------------------------| +``` + +#### Summary + +With this module we want to spare all Python developers a lot of work. All communication with the +process image is optimally performed inside the module. Changes to the inputs and outputs are also +evaluated along with the additional functions of the module give the developer many tools along +the way. + +More examples: (https://revpimodio.org/en/blogs/examples/) + +Provided under the [LGPLv3](LICENSE.txt) license diff --git a/revpimodio2.e4p b/revpimodio2.e4p index 6e51a7f..fcc94de 100644 --- a/revpimodio2.e4p +++ b/revpimodio2.e4p @@ -1,7 +1,7 @@ - + en_US @@ -47,7 +47,9 @@ .hgignore + LICENSE.txt MANIFEST.in + README.md doc eric-revpimodio2.api