* adding first files (API draft)
authorDariusz Wiechecki <stranger@hp-laptop.(none)>
Thu, 21 Jan 2010 19:32:36 +0000 (21:32 +0200)
committerDariusz Wiechecki <stranger@hp-laptop.(none)>
Thu, 21 Jan 2010 19:32:36 +0000 (21:32 +0200)
* not copileable probably - just a design of simplest API
* adding LICENSE file

LICENSE [new file with mode: 0644]
include/accel.h [new file with mode: 0644]
src/accel_p.c [new file with mode: 0644]
src/global_p.c [new file with mode: 0644]
src/global_p.h [new file with mode: 0644]
src/library.c [new file with mode: 0644]
src/template.hc [new file with mode: 0644]

diff --git a/LICENSE b/LICENSE
new file mode 100644 (file)
index 0000000..3462706
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,165 @@
+                  GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ 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.
\ No newline at end of file
diff --git a/include/accel.h b/include/accel.h
new file mode 100644 (file)
index 0000000..9863530
--- /dev/null
@@ -0,0 +1,41 @@
+/* ============================================================================
+    Copyright (C) 2010 nomrasco
+    Nom Rasco <nomrasco@gmail.com>
+
+    This file is part of libnomaccel.
+
+    libnomaccel is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Lesser General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    libnomaccel is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public License
+    along with libnomaccel.  If not, see <http://www.gnu.org/licenses/>.
+============================================================================ */
+#ifndef _NOM_ACCELEROMETER_H_
+#define _NOM_ACCELEROMETER_H_
+
+typedef int   value;
+typedef float angle;
+
+/* simplest retrieving functions: x,y,z,pitch,roll */
+value nom_accel_get_x ();
+value nom_accel_get_y ();
+value nom_accel_get_z ();
+void  nom_accel_get_xyz (value* x, value* y, value* z);
+
+angle nom_accel_get_pitch ();
+angle nom_accel_get_roll  ();
+void  nom_accel_get_pitch_roll (angle* pitch, angle* roll);
+
+void  nom_accel_get_all ( value* x, value* y, value* z,
+                          angle* pitch, angle* roll     );
+
+
+
+#endif
diff --git a/src/accel_p.c b/src/accel_p.c
new file mode 100644 (file)
index 0000000..467757e
--- /dev/null
@@ -0,0 +1,82 @@
+/* ============================================================================
+    Copyright (C) 2010 nomrasco
+    Nom Rasco <nomrasco@gmail.com>
+
+    This file is part of libnomaccel.
+
+    libnomaccel is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Lesser General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    libnomaccel is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public License
+    along with libnomaccel.  If not, see <http://www.gnu.org/licenses/>.
+============================================================================ */
+#include "../include/accel.h"
+#include "global_p.h"
+
+value
+nom_accel_get_x () {
+       _accel_read_real_values ();
+       return _accel_proxy.x;
+}
+
+value
+nom_accel_get_y () {
+       _accel_read_real_values ();
+       return _accel_proxy.y;
+}
+
+value
+nom_accel_get_z () {
+       _accel_read_real_values ();
+       return _accel_proxy.z;
+}
+
+void
+nom_accel_get_xyz (value* x, value* y, value* z) {
+       _accel_read_real_values ();
+       *x = _accel_proxy.x;
+       *y = _accel_proxy.y;
+       *z = _accel_proxy.z;
+}
+
+angle
+nom_accel_get_pitch () {
+       _accel_read_real_values ();
+       _accel_recalculate_pitch ();
+       return _accel_proxy.pitch;
+}
+
+angle
+nom_accel_get_roll  () {
+       _accel_read_real_values ();
+       _accel_recalculate_roll ();
+       return _accel_proxy.roll;
+}
+
+void
+nom_accel_get_pitch_roll (angle* pitch, angle* roll) {
+       _accel_read_real_values ();
+       _accel_recalculate_pitch_roll ();
+       *pitch = _accel_proxy.pitch;
+        *roll = _accel_proxy.roll;
+}
+
+void
+nom_accel_get_all (value* x, value* y, value* z,
+                   angle* pitch, angle* roll)
+{
+       _accel_read_real_values ();
+       _accel_recalculate_pitch_roll ();
+       *pitch = _accel_proxy.pitch;
+        *roll = _accel_proxy.roll;
+           *x = _accel_proxy.x;
+           *y = _accel_proxy.y;
+           *z = _accel_proxy.z;
+}
\ No newline at end of file
diff --git a/src/global_p.c b/src/global_p.c
new file mode 100644 (file)
index 0000000..14d5289
--- /dev/null
@@ -0,0 +1,62 @@
+/* ============================================================================
+    Copyright (C) 2010 nomrasco
+    Nom Rasco <nomrasco@gmail.com>
+
+    This file is part of libnomaccel.
+
+    libnomaccel is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Lesser General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    libnomaccel is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public License
+    along with libnomaccel.  If not, see <http://www.gnu.org/licenses/>.
+============================================================================ */
+#include "global_p.h"
+#include <stdlib.h>
+
+void
+_nom_accel_proxy_init ()
+{
+       _accel_proxy.x = 0;
+       _accel_proxy.y = 0;
+       _accel_proxy.z = 0;
+       _accel_proxy.pitch = 0.0;
+       _accel_proxy.roll = 0.0;
+}
+
+void
+_accel_proxy_finit ()
+{
+       /* nothing to do yet */
+}
+
+void
+_accel_read_real_values ()
+{
+       FILE* fd;
+       fd = fopen(_accel_device_file_name, "r");
+       if(0 == fd) return;
+       fscanf ( fd, "%i %i %i",
+                &_accel_proxy.x,
+                &_accel_proxy.y,
+                &_accel_proxy.z );
+       fclose(fd);
+}
+
+void
+_accel_recalculate_pitch () {
+       _accel_proxy.pitch = YZ_TO_PITCH(_accel_proxy.y, _accel_proxy.z);
+}
+
+void
+_accel_recalculate_roll () {
+       _accel_proxy.roll  =  XY_TO_ROLL(_accel_proxy.x, _accel_proxy.y);
+}
+
+
diff --git a/src/global_p.h b/src/global_p.h
new file mode 100644 (file)
index 0000000..4841845
--- /dev/null
@@ -0,0 +1,48 @@
+/* ============================================================================
+    Copyright (C) 2010 nomrasco
+    Nom Rasco <nomrasco@gmail.com>
+
+    This file is part of libnomaccel.
+
+    libnomaccel is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Lesser General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    libnomaccel is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public License
+    along with libnomaccel.  If not, see <http://www.gnu.org/licenses/>.
+============================================================================ */
+#ifndef _NOM_GLOBAL_H_
+#define _NOM_GLOBAL_H_
+#include <math.h>
+
+#define YZ_TO_PITCH(y,z) atan2((y),(-z))
+#define XY_TO_ROLL(x,y)  atan2((x),(-y))
+#define XYZ_TO_PITCH(x,y,z) YZ_TO_PITCH(y,z)
+#define XYZ_TO_ROLL(x,y,z)  XY_TO_ROLL(x,y)
+
+typedef struct _NomAccelProxy NomAccelProxy;
+struct _NomAccelProxy {
+       value x;
+       value y;
+       value z;
+       angle pitch;
+       angle roll;
+};
+
+void _accel_proxy_init ();
+void _accel_proxy_finit ();
+void _accel_read_real_values ();
+void _accel_recalculate_pitch ();
+void _accel_recalculate_roll ();
+#define _accel_recalculate_pitch_roll() _accel_recalculate_pitch(); _accel_recalculate_roll()
+
+const char* const _accel_device_file_name = "/sys/class/i2c-adapter/i2c-3/3-001d/coord";
+NomAccelProxy     _accel_proxy = {0};
+
+#endif
diff --git a/src/library.c b/src/library.c
new file mode 100644 (file)
index 0000000..7af6f60
--- /dev/null
@@ -0,0 +1,31 @@
+/* ============================================================================
+    Copyright (C) 2010 nomrasco
+    Nom Rasco <nomrasco@gmail.com>
+
+    This file is part of libnomaccel.
+
+    libnomaccel is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Lesser General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    libnomaccel is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public License
+    along with libnomaccel.  If not, see <http://www.gnu.org/licenses/>.
+============================================================================ */
+#include "../include/accel.h"
+#include "global_p.h"
+
+void __attribute__ ((constructor)) _nom_accel_library_init(void)
+{
+       _accel_proxy_init ();
+}
+
+void __attribute__ ((destructor)) _nom_accel_library_finalize(void)
+{
+       _accel_proxy_finit ();
+}
diff --git a/src/template.hc b/src/template.hc
new file mode 100644 (file)
index 0000000..fceabf1
--- /dev/null
@@ -0,0 +1,26 @@
+/* ============================================================================
+    Copyright (C) 2010 nomrasco
+    Nom Rasco <nomrasco@gmail.com>
+
+    This file is part of libnomaccel.
+
+    libnomaccel is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Lesser General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    libnomaccel is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public License
+    along with libnomaccel.  If not, see <http://www.gnu.org/licenses/>.
+============================================================================ */
+#ifndef _NOM_TEMPLATE_H_
+#define _NOM_TEMPLATE_H_
+#include "template.h"
+
+   USE THIS FILE AS A TEMPLATE FOR A NEW FILES: HEADERS AND IMPLEMENTATIONS
+
+#endif