columns)
85 | {
86 | this.columns = new ArrayList<>(columns);
87 | this.columnInstances = new HashMap<>(this.columns.size());
88 | for (String key: this.columns) {
89 | this.columnInstances.put(key, key);
90 | }
91 | hasNewColumns = false;
92 | }
93 |
94 | /**
95 | * Changes this column key to be using this value
96 | *
97 | * @param key The name of the column
98 | * @param value The value to store in this column
99 | */
100 | public void setData(String key, String value)
101 | {
102 | String previousKey = columnInstances.get(key);
103 | if (previousKey == null)
104 | {
105 | columns.add(key);
106 | columnInstances.put(key, key);
107 | previousKey = key;
108 | hasNewColumns = true;
109 | }
110 |
111 | latestValues.put(previousKey, value);
112 | }
113 |
114 | /**
115 | * Commits the current latestValues to a new timestamped row in the CSV file
116 | *
117 | * Future optimization: drop intermediate identical rows
118 | */
119 | public void saveRow()
120 | {
121 | long timestamp = System.currentTimeMillis();
122 | Map row = new HashMap<>(latestValues);
123 | rows.put(timestamp, row);
124 | }
125 |
126 | /**
127 | * @return the epoch timestamp (in UTC) of the first row, or the current time if empty
128 | */
129 | public long getStartTime()
130 | {
131 | if (rows.isEmpty())
132 | {
133 | return System.currentTimeMillis();
134 | }
135 |
136 | Long[] timestamps = rows.keySet().toArray(new Long[0]);
137 | Arrays.sort(timestamps);
138 | return timestamps[0];
139 | }
140 |
141 | /**
142 | * @return the epoch timestamp (in UTC) of the last row, or the current time if empty
143 | */
144 | public long getEndTime()
145 | {
146 | if (rows.isEmpty())
147 | {
148 | return System.currentTimeMillis();
149 | }
150 |
151 | Long[] timestamps = rows.keySet().toArray(new Long[0]);
152 | Arrays.sort(timestamps);
153 | return timestamps[timestamps.length - 1];
154 | }
155 |
156 | /**
157 | * @return the number of saved rows
158 | */
159 | public int size()
160 | {
161 | return rows.size();
162 | }
163 |
164 | /**
165 | * @return whether any new columns have been added since the creation of this table
166 | */
167 | public boolean hasNewColumns()
168 | {
169 | return hasNewColumns;
170 | }
171 |
172 | /**
173 | * @return whether any new data has been set since the last saveRow call
174 | */
175 | public boolean hasPendingData()
176 | {
177 | return hasPendingData;
178 | }
179 |
180 | /**
181 | * Writes the data table to the given writer, optionally with headers
182 | * Always writes out the entire table for each call, intending to be discarded afterward
183 | *
184 | * @param writer The output writer to save the row to
185 | * @param includeHeader Whether to include a first row of headers with the field names
186 | */
187 | public void writeOutput(OutputStreamWriter writer, boolean includeHeader) throws IOException
188 | {
189 | if (includeHeader)
190 | {
191 | StringBuilder row = new StringBuilder();
192 | row.append("timestamp");
193 | for (String column: columns)
194 | {
195 | row.append(',');
196 | row.append(quoteCell(column));
197 | }
198 | row.append("\r\n");
199 | writer.write(row.toString());
200 | }
201 |
202 | Long[] timestamps = rows.keySet().toArray(new Long[0]);
203 | Arrays.sort(timestamps);
204 | for (Long timestamp: timestamps)
205 | {
206 | Map rowData = rows.get(timestamp);
207 | StringBuilder row = new StringBuilder();
208 | row.append(timestamp);
209 | for (String column: columns)
210 | {
211 | row.append(',');
212 | String cellData = rowData.get(column);
213 | if (cellData == null)
214 | {
215 | cellData = "";
216 | }
217 | row.append(quoteCell(cellData));
218 | }
219 | row.append("\r\n");
220 | writer.write(row.toString());
221 | }
222 | }
223 |
224 | private String quoteCell(String cell)
225 | {
226 | if (cell.contains("\"") || cell.contains(",") || cell.contains("\n"))
227 | {
228 | return "\"" + cell.replaceAll("\"", "\"\"") + "\n";
229 | }
230 | // no quoting needed
231 | return cell;
232 | }
233 | }
234 |
--------------------------------------------------------------------------------
/gradlew:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 |
3 | #
4 | # Copyright © 2015-2021 the original authors.
5 | #
6 | # Licensed under the Apache License, Version 2.0 (the "License");
7 | # you may not use this file except in compliance with the License.
8 | # You may obtain a copy of the License at
9 | #
10 | # https://www.apache.org/licenses/LICENSE-2.0
11 | #
12 | # Unless required by applicable law or agreed to in writing, software
13 | # distributed under the License is distributed on an "AS IS" BASIS,
14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 | # See the License for the specific language governing permissions and
16 | # limitations under the License.
17 | #
18 |
19 | ##############################################################################
20 | #
21 | # Gradle start up script for POSIX generated by Gradle.
22 | #
23 | # Important for running:
24 | #
25 | # (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
26 | # noncompliant, but you have some other compliant shell such as ksh or
27 | # bash, then to run this script, type that shell name before the whole
28 | # command line, like:
29 | #
30 | # ksh Gradle
31 | #
32 | # Busybox and similar reduced shells will NOT work, because this script
33 | # requires all of these POSIX shell features:
34 | # * functions;
35 | # * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
36 | # «${var#prefix}», «${var%suffix}», and «$( cmd )»;
37 | # * compound commands having a testable exit status, especially «case»;
38 | # * various built-in commands including «command», «set», and «ulimit».
39 | #
40 | # Important for patching:
41 | #
42 | # (2) This script targets any POSIX shell, so it avoids extensions provided
43 | # by Bash, Ksh, etc; in particular arrays are avoided.
44 | #
45 | # The "traditional" practice of packing multiple parameters into a
46 | # space-separated string is a well documented source of bugs and security
47 | # problems, so this is (mostly) avoided, by progressively accumulating
48 | # options in "$@", and eventually passing that to Java.
49 | #
50 | # Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
51 | # and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
52 | # see the in-line comments for details.
53 | #
54 | # There are tweaks for specific operating systems such as AIX, CygWin,
55 | # Darwin, MinGW, and NonStop.
56 | #
57 | # (3) This script is generated from the Groovy template
58 | # https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
59 | # within the Gradle project.
60 | #
61 | # You can find Gradle at https://github.com/gradle/gradle/.
62 | #
63 | ##############################################################################
64 |
65 | # Attempt to set APP_HOME
66 |
67 | # Resolve links: $0 may be a link
68 | app_path=$0
69 |
70 | # Need this for daisy-chained symlinks.
71 | while
72 | APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path
73 | [ -h "$app_path" ]
74 | do
75 | ls=$( ls -ld "$app_path" )
76 | link=${ls#*' -> '}
77 | case $link in #(
78 | /*) app_path=$link ;; #(
79 | *) app_path=$APP_HOME$link ;;
80 | esac
81 | done
82 |
83 | APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
84 |
85 | APP_NAME="Gradle"
86 | APP_BASE_NAME=${0##*/}
87 |
88 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
89 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
90 |
91 | # Use the maximum available, or set MAX_FD != -1 to use that value.
92 | MAX_FD=maximum
93 |
94 | warn () {
95 | echo "$*"
96 | } >&2
97 |
98 | die () {
99 | echo
100 | echo "$*"
101 | echo
102 | exit 1
103 | } >&2
104 |
105 | # OS specific support (must be 'true' or 'false').
106 | cygwin=false
107 | msys=false
108 | darwin=false
109 | nonstop=false
110 | case "$( uname )" in #(
111 | CYGWIN* ) cygwin=true ;; #(
112 | Darwin* ) darwin=true ;; #(
113 | MSYS* | MINGW* ) msys=true ;; #(
114 | NONSTOP* ) nonstop=true ;;
115 | esac
116 |
117 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
118 |
119 |
120 | # Determine the Java command to use to start the JVM.
121 | if [ -n "$JAVA_HOME" ] ; then
122 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
123 | # IBM's JDK on AIX uses strange locations for the executables
124 | JAVACMD=$JAVA_HOME/jre/sh/java
125 | else
126 | JAVACMD=$JAVA_HOME/bin/java
127 | fi
128 | if [ ! -x "$JAVACMD" ] ; then
129 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
130 |
131 | Please set the JAVA_HOME variable in your environment to match the
132 | location of your Java installation."
133 | fi
134 | else
135 | JAVACMD=java
136 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
137 |
138 | Please set the JAVA_HOME variable in your environment to match the
139 | location of your Java installation."
140 | fi
141 |
142 | # Increase the maximum file descriptors if we can.
143 | if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
144 | case $MAX_FD in #(
145 | max*)
146 | MAX_FD=$( ulimit -H -n ) ||
147 | warn "Could not query maximum file descriptor limit"
148 | esac
149 | case $MAX_FD in #(
150 | '' | soft) :;; #(
151 | *)
152 | ulimit -n "$MAX_FD" ||
153 | warn "Could not set maximum file descriptor limit to $MAX_FD"
154 | esac
155 | fi
156 |
157 | # Collect all arguments for the java command, stacking in reverse order:
158 | # * args from the command line
159 | # * the main class name
160 | # * -classpath
161 | # * -D...appname settings
162 | # * --module-path (only if needed)
163 | # * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.
164 |
165 | # For Cygwin or MSYS, switch paths to Windows format before running java
166 | if "$cygwin" || "$msys" ; then
167 | APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
168 | CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )
169 |
170 | JAVACMD=$( cygpath --unix "$JAVACMD" )
171 |
172 | # Now convert the arguments - kludge to limit ourselves to /bin/sh
173 | for arg do
174 | if
175 | case $arg in #(
176 | -*) false ;; # don't mess with options #(
177 | /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath
178 | [ -e "$t" ] ;; #(
179 | *) false ;;
180 | esac
181 | then
182 | arg=$( cygpath --path --ignore --mixed "$arg" )
183 | fi
184 | # Roll the args list around exactly as many times as the number of
185 | # args, so each arg winds up back in the position where it started, but
186 | # possibly modified.
187 | #
188 | # NB: a `for` loop captures its iteration list before it begins, so
189 | # changing the positional parameters here affects neither the number of
190 | # iterations, nor the values presented in `arg`.
191 | shift # remove old arg
192 | set -- "$@" "$arg" # push replacement arg
193 | done
194 | fi
195 |
196 | # Collect all arguments for the java command;
197 | # * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
198 | # shell script including quotes and variable substitutions, so put them in
199 | # double quotes to make sure that they get re-expanded; and
200 | # * put everything else in single quotes, so that it's not re-expanded.
201 |
202 | set -- \
203 | "-Dorg.gradle.appname=$APP_BASE_NAME" \
204 | -classpath "$CLASSPATH" \
205 | org.gradle.wrapper.GradleWrapperMain \
206 | "$@"
207 |
208 | # Use "xargs" to parse quoted args.
209 | #
210 | # With -n1 it outputs one arg per line, with the quotes and backslashes removed.
211 | #
212 | # In Bash we could simply go:
213 | #
214 | # readarray ARGS < <( xargs -n1 <<<"$var" ) &&
215 | # set -- "${ARGS[@]}" "$@"
216 | #
217 | # but POSIX shell has neither arrays nor command substitution, so instead we
218 | # post-process each arg (as a line of input to sed) to backslash-escape any
219 | # character that might be a shell metacharacter, then use eval to reverse
220 | # that process (while maintaining the separation between arguments), and wrap
221 | # the whole thing up as a single "set" statement.
222 | #
223 | # This will of course break if any of these variables contains a newline or
224 | # an unmatched quote.
225 | #
226 |
227 | eval "set -- $(
228 | printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
229 | xargs -n1 |
230 | sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
231 | tr '\n' ' '
232 | )" '"$@"'
233 |
234 | exec "$JAVACMD" "$@"
235 |
--------------------------------------------------------------------------------
/MqttPublisher/src/main/java/com/fr3ts0n/androbd/plugin/mqtt/MqttPlugin.java:
--------------------------------------------------------------------------------
1 | package com.fr3ts0n.androbd.plugin.mqtt;
2 |
3 | import android.content.Intent;
4 | import android.content.SharedPreferences;
5 | import android.preference.PreferenceManager;
6 | import android.util.Log;
7 |
8 | import com.fr3ts0n.androbd.plugin.Plugin;
9 | import com.fr3ts0n.androbd.plugin.PluginInfo;
10 |
11 | import org.eclipse.paho.client.mqttv3.MqttClient;
12 | import org.eclipse.paho.client.mqttv3.MqttConnectOptions;
13 | import org.eclipse.paho.client.mqttv3.MqttException;
14 | import org.eclipse.paho.client.mqttv3.persist.MemoryPersistence;
15 |
16 | import java.util.HashMap;
17 | import java.util.HashSet;
18 | import java.util.Map;
19 |
20 | /**
21 | * AndrOBD MQTT publishing plugin
22 | *
23 | * Publish AndrOBD measurements to MQTT broker
24 | */
25 |
26 | public class MqttPlugin
27 | extends Plugin
28 | implements Plugin.ConfigurationHandler,
29 | Plugin.ActionHandler,
30 | Plugin.DataReceiver,
31 | SharedPreferences.OnSharedPreferenceChangeListener
32 | {
33 | static final PluginInfo myInfo = new PluginInfo("MqttPublisher",
34 | MqttPlugin.class,
35 | "MQTT publish AndrOBD measurements",
36 | "Copyright (C) 2017 by fr3ts0n",
37 | "GPLV3+",
38 | "https://github.com/fr3ts0n/AndrOBD"
39 | );
40 |
41 | /**
42 | * Preference keys
43 | */
44 | static final String MQTT_PREFIX = "mqtt_prefix";
45 | static final String UPDATE_PERIOD = "update_period";
46 | static final String MQTT_PROTOCOL = "mqtt_protocol";
47 | static final String MQTT_HOSTNAME = "mqtt_hostname";
48 | static final String MQTT_PORT = "mqtt_port";
49 | static final String MQTT_USERNAME = "mqtt_username";
50 | static final String MQTT_PASSWORD = "mqtt_password";
51 | static final String MQTT_CLIENTID = "mqtt_clientid";
52 | static final String MQTT_RETAIN = "mqtt_retain";
53 | static final String MQTT_QOS = "mqtt_qos";
54 | static final String ITEMS_SELECTED = "data_items";
55 | static final String ITEMS_KNOWN = "known_items";
56 |
57 | /**
58 | * The data collection
59 | */
60 | static final HashMap valueMap = new HashMap<>();
61 |
62 | SharedPreferences prefs;
63 | String mqtt_prefix = "";
64 |
65 | /*
66 | MQTT communication parameter
67 | */
68 |
69 | /**
70 | * MQTT protocol ( tcp:// | ssl:// )
71 | */
72 | String brokerProtocol;
73 | /**
74 | * MQTT host name / IP address
75 | */
76 | String brokerHostName;
77 | /**
78 | * MQTT broker port number
79 | */
80 | int brokerPortNumber;
81 | /**
82 | * MQTT login name
83 | */
84 | String mUsername;
85 | /**
86 | * MQTT login password
87 | */
88 | String mPassword;
89 | /**
90 | * Retain preselection value
91 | */
92 | boolean mRetain = true;
93 | /**
94 | * QOS preselection value
95 | */
96 | int mQos = 0;
97 | /**
98 | * set of items which are known to the plugin
99 | */
100 | protected static HashSet mKnownItems = new HashSet<>();
101 | /**
102 | * set of items to be published
103 | */
104 | HashSet mSelectedItems = new HashSet<>();
105 | /**
106 | * MQTT client id
107 | */
108 | String mClientId = null;
109 | /**
110 | * Period between publishing updates
111 | */
112 | int update_period = 30;
113 |
114 | /**
115 | * Get preference int value
116 | *
117 | * @param key preference key name
118 | * @param defaultValue numeric default value
119 | * @return preference int value
120 | */
121 | public static int getPrefsInt(SharedPreferences prefs, String key, int defaultValue)
122 | {
123 | int result = defaultValue;
124 |
125 | try
126 | {
127 | result = Integer.valueOf(prefs.getString(key, String.valueOf(defaultValue)));
128 | }
129 | catch (Exception ex)
130 | {
131 | // log error message
132 | Log.e("Prefs", String.format("Preference '%s'(%d): %s", key, result, ex.toString()));
133 | }
134 | return result;
135 | }
136 |
137 | /**
138 | * Working thread for cyclic publishing updates
139 | */
140 | Thread updateThread = new Thread()
141 | {
142 | public void run()
143 | {
144 | Log.i("Thread", "started");
145 | try
146 | {
147 | while (!interrupted())
148 | {
149 | sleep(update_period * 1000);
150 | Log.i("Thread", "Publish data");
151 | performAction();
152 | }
153 | }
154 | catch (InterruptedException ignored)
155 | {
156 | }
157 | Log.i("Thread", "finished");
158 | }
159 | };
160 |
161 | @Override
162 | public void onCreate()
163 | {
164 | super.onCreate();
165 |
166 | // get preferences
167 | prefs = PreferenceManager.getDefaultSharedPreferences(getApplicationContext());
168 | prefs.registerOnSharedPreferenceChangeListener(this);
169 | // get all shared preference values
170 | onSharedPreferenceChanged(prefs, null);
171 |
172 | // set a proper client id if we have none
173 | if (mClientId == null || mClientId.trim().equals(""))
174 | {
175 | mClientId = MqttClient.generateClientId();
176 | // update preferences with generated client ID
177 | prefs.edit().putString(MQTT_CLIENTID, mClientId).apply();
178 | }
179 | updateThread.start();
180 | }
181 |
182 | @Override
183 | public void onDestroy()
184 | {
185 | // interrupt cyclic thread
186 | updateThread.interrupt();
187 |
188 | // forget about settings changes
189 | prefs.unregisterOnSharedPreferenceChangeListener(this);
190 |
191 | super.onDestroy();
192 | }
193 |
194 | /**
195 | * Called when a shared preference is changed, added, or removed. This
196 | * may be called even if a preference is set to its existing value.
197 | *
198 | *
This callback will be run on your main thread.
199 | *
200 | * @param sharedPreferences The {@link SharedPreferences} that received
201 | * the change.
202 | * @param key The key of the preference that was changed, added, or
203 | */
204 | @Override
205 | public void onSharedPreferenceChanged(SharedPreferences sharedPreferences, String key)
206 | {
207 | if (key == null || MQTT_PREFIX.equals(key))
208 | { mqtt_prefix = sharedPreferences.getString(MQTT_PREFIX, "AndrOBD/"); }
209 |
210 | if (key == null || UPDATE_PERIOD.equals(key))
211 | { update_period = getPrefsInt(sharedPreferences, UPDATE_PERIOD, 30); }
212 |
213 | if (key == null || MQTT_PROTOCOL.equals(key))
214 | { brokerProtocol = sharedPreferences.getString(MQTT_PROTOCOL, getString(R.string.mqtt_prot_tcp)); }
215 |
216 | if (key == null || MQTT_HOSTNAME.equals(key))
217 | { brokerHostName = sharedPreferences.getString(MQTT_HOSTNAME, "localhost"); }
218 |
219 | if (key == null || MQTT_PORT.equals(key))
220 | { brokerPortNumber = getPrefsInt(sharedPreferences, MQTT_PORT, 1883); }
221 |
222 | if (key == null || MQTT_USERNAME.equals(key))
223 | { mUsername = sharedPreferences.getString(MQTT_USERNAME, "guest"); }
224 |
225 | if (key == null || MQTT_PASSWORD.equals(key))
226 | { mPassword = sharedPreferences.getString(MQTT_PASSWORD, "guest"); }
227 |
228 | if (key == null || MQTT_CLIENTID.equals(key))
229 | { mClientId = sharedPreferences.getString(MQTT_CLIENTID, getString(R.string.app_name))
230 | .replaceAll("\\s+","-"); }
231 |
232 | if (key == null || MQTT_QOS.equals(key))
233 | { mQos = getPrefsInt(sharedPreferences, MQTT_QOS, 0); }
234 |
235 | if (key == null || MQTT_RETAIN.equals(key))
236 | { mRetain = sharedPreferences.getBoolean(MQTT_RETAIN, true); }
237 |
238 | if (key == null || ITEMS_SELECTED.equals(key))
239 | {
240 | mSelectedItems =
241 | (HashSet) sharedPreferences.getStringSet(ITEMS_SELECTED, mSelectedItems);
242 | }
243 |
244 | if (key == null || ITEMS_KNOWN.equals(key))
245 | {
246 | mKnownItems =
247 | (HashSet) sharedPreferences.getStringSet(ITEMS_KNOWN, mKnownItems);
248 | }
249 | }
250 |
251 | /**
252 | * get own plugin info
253 | */
254 | @Override
255 | public PluginInfo getPluginInfo()
256 | {
257 | return myInfo;
258 | }
259 |
260 | /**
261 | * Perform intended action of the plugin
262 | */
263 | @Override
264 | public void performAction()
265 | {
266 | MqttClient client;
267 |
268 | // Nothing to be sent - finished!
269 | if (valueMap.isEmpty()) { return; }
270 |
271 | // set URL
272 | final String BROKER_URL = brokerProtocol + brokerHostName + ":" + brokerPortNumber;
273 |
274 | try
275 | {
276 | Log.i("MQTT", "Connect: " + BROKER_URL);
277 |
278 | client = new MqttClient(BROKER_URL, mClientId, new MemoryPersistence());
279 | final MqttConnectOptions options = new MqttConnectOptions();
280 | if (mUsername != null && !mUsername.trim().equals(""))
281 | {
282 | options.setUserName(mUsername);
283 | options.setPassword(mPassword.toCharArray());
284 | }
285 | client.connect(options);
286 |
287 |
288 | synchronized (valueMap)
289 | {
290 | // loop through data items
291 | for (Map.Entry entry : valueMap.entrySet())
292 | {
293 | // get topic and value
294 | String topic = mqtt_prefix + entry.getKey();
295 | String value = entry.getValue();
296 | // publish topic
297 | client.publish(topic, value.getBytes(), mQos, mRetain);
298 | // Log message
299 | Log.d("MQTT", "Published data. Topic: " + topic + " Message: " + value);
300 | }
301 | }
302 |
303 | // disconnect client
304 | client.disconnect();
305 | }
306 | catch (MqttException e)
307 | {
308 | Log.e("MQTT", "Publish", e);
309 | }
310 |
311 | }
312 |
313 | /**
314 | * Handle configuration request.
315 | * Perform plugin configuration
316 | */
317 | @Override
318 | public void performConfigure()
319 | {
320 | Intent cfgIntent = new Intent(getApplicationContext(), SettingsActivity.class);
321 | cfgIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
322 | startActivity(cfgIntent);
323 | }
324 |
325 | /**
326 | * Handle data list update.
327 | *
328 | * @param csvString CSV data string in format key;value
329 | */
330 | @Override
331 | public void onDataListUpdate(String csvString)
332 | {
333 | // append unknown items to list of known items
334 | //noinspection SynchronizeOnNonFinalField
335 | synchronized (mKnownItems)
336 | {
337 | for (String csvLine : csvString.split("\n"))
338 | {
339 | String[] fields = csvLine.split(";");
340 | if (fields.length > 0)
341 | {
342 | mKnownItems.add(fields[0]);
343 | }
344 | }
345 | // store known items as preference
346 | prefs.edit().putStringSet(ITEMS_KNOWN, mKnownItems).apply();
347 | }
348 | // clear the map of received values
349 | synchronized (valueMap)
350 | {
351 | valueMap.clear();
352 | }
353 | }
354 |
355 | /**
356 | * Handle data update.
357 | *
358 | * @param key Key of data change
359 | * @param value New value of data change
360 | */
361 | @Override
362 | public void onDataUpdate(String key, String value)
363 | {
364 | synchronized (valueMap)
365 | {
366 | // add value if it is to be published ...
367 | if (mSelectedItems.size() == 0 || mSelectedItems.contains(key))
368 | {
369 | valueMap.put(key, value);
370 | }
371 | }
372 | }
373 | }
374 |
--------------------------------------------------------------------------------
/CsvLogger/src/main/java/com/fr3ts0n/androbd/plugin/csv/CsvDataLogger.java:
--------------------------------------------------------------------------------
1 | package com.fr3ts0n.androbd.plugin.csv;
2 |
3 | import android.app.Notification;
4 | import android.app.NotificationManager;
5 | import android.app.PendingIntent;
6 | import android.content.ComponentName;
7 | import android.content.Context;
8 | import android.content.Intent;
9 | import android.content.pm.ResolveInfo;
10 | import android.net.Uri;
11 | import android.os.Build;
12 | import android.os.Handler;
13 | import android.util.Log;
14 | import android.widget.Toast;
15 |
16 | import com.fr3ts0n.androbd.plugin.Plugin;
17 | import com.fr3ts0n.androbd.plugin.PluginInfo;
18 |
19 | import java.util.ArrayList;
20 | import java.util.List;
21 |
22 | /**
23 | * AndrOBD CSV data logger
24 | *
25 | * A plugin to log all measured OBD data into CSV file
26 | */
27 | public class CsvDataLogger
28 | extends Plugin
29 | implements Plugin.ConfigurationHandler,
30 | Plugin.ActionHandler,
31 | Plugin.DataReceiver
32 | {
33 |
34 | static final String TAG = "CsvDataLogger";
35 | static final int MIN_ROW_TIMEOUT = 100; // minimum time between rows of data
36 | static final int MAX_SEGMENT_TIMEOUT = 10000; // maximum time before flushing a segment
37 | static final int AUTOMATIC_PAUSE = 60000; // stop recording after this length of time since the last data point
38 |
39 | private static final int NOTIFICATION_ID = 3433; // Notification ID to update and clear it
40 | public static final String HOST_PACKAGE = "com.fr3ts0n.ecu.gui.androbd";
41 |
42 | static final PluginInfo myInfo = new PluginInfo( "CsvDataLogger",
43 | CsvDataLogger.class,
44 | "Log all measurements to CSV file",
45 | "Copyright (C) 2021 by hufman",
46 | "GPLV3+",
47 | "https://github.com/fr3ts0n/AndrOBD"
48 | );
49 |
50 | private Handler handler;
51 | private CsvWriterThread writer;
52 | private CsvData segment;
53 | private long lastSaved;
54 | private long lastWritten;
55 |
56 | private final Runnable automaticTimer = new Runnable()
57 | {
58 | @Override
59 | public void run()
60 | {
61 | // check if we need to flush the segment after a timeout
62 | if (lastWritten + MAX_SEGMENT_TIMEOUT < System.currentTimeMillis())
63 | {
64 | writeSegment();
65 | }
66 |
67 | showNotification();
68 |
69 | if (lastWritten + AUTOMATIC_PAUSE < System.currentTimeMillis())
70 | {
71 | stopRecording();
72 | }
73 |
74 | if (writer != null)
75 | {
76 | handler.postDelayed(automaticTimer, 1000);
77 | }
78 | }
79 | };
80 |
81 | /**
82 | * Default constructor
83 | */
84 | public CsvDataLogger()
85 | {
86 | super();
87 | segment = new CsvData();
88 | }
89 |
90 | @Override
91 | public void onCreate() {
92 | super.onCreate();
93 | handler = new Handler();
94 | }
95 |
96 | /**
97 | * get own plugin info
98 | */
99 | @Override
100 | public final PluginInfo getPluginInfo()
101 | {
102 | return myInfo;
103 | }
104 |
105 | /**
106 | * Perform intended action of the plugin
107 | */
108 | @Override
109 | public void performAction()
110 | {
111 | if (writer == null)
112 | {
113 | startRecording();
114 | } else
115 | {
116 | stopRecording();
117 | }
118 | }
119 |
120 | /**
121 | * Handle configuration request.
122 | * Perform plugin configuration
123 | */
124 | @Override
125 | public void performConfigure()
126 | {
127 | Intent intent = new Intent(getApplicationContext(), SettingsActivity.class);
128 | intent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
129 | startActivity(intent);
130 | }
131 |
132 | private void startRecording()
133 | {
134 | Log.i(TAG, "Starting recording");
135 | writer = new CsvWriterThread(getApplicationContext().getExternalFilesDir(null));
136 | writer.start();
137 | lastSaved = System.currentTimeMillis();
138 | lastWritten = System.currentTimeMillis();
139 |
140 | showNotification();
141 |
142 | ViewModel.isRecording = true;
143 | ViewModel.countDataPoints = 0;
144 | ViewModel.countDataRows = 0;
145 | handler.postDelayed(automaticTimer, 1000);
146 |
147 | Toast.makeText(getApplicationContext(), R.string.btn_start_recording, Toast.LENGTH_SHORT).show();
148 | }
149 |
150 | private void showNotification()
151 | {
152 | if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
153 | NotificationChannelManager.createNotificationChannel(getApplicationContext());
154 | }
155 |
156 | if (!ViewModel.isRecording)
157 | {
158 | return;
159 | }
160 |
161 | Notification.Builder notificationBuilder = new Notification.Builder(this)
162 | .setOngoing(true)
163 | .setContentTitle(getText(R.string.lbl_notification_title))
164 | .setContentText(getString(R.string.lbl_notification_text, ViewModel.countDataPoints, ViewModel.countDataRows))
165 | .setSmallIcon(R.drawable.ic_notify)
166 | .setPriority(Notification.PRIORITY_DEFAULT);
167 |
168 | Intent pendingIntent = new Intent(Intent.ACTION_MAIN)
169 | .addCategory(Intent.CATEGORY_LAUNCHER)
170 | .setPackage(HOST_PACKAGE)
171 | .addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
172 | List results = getPackageManager().queryIntentActivities(pendingIntent, 0);
173 | if (results.size() > 0)
174 | {
175 | ResolveInfo result = results.get(0);
176 | PendingIntent pendingClickIntent = PendingIntent.getActivity(getApplicationContext(),
177 | 15,
178 | pendingIntent.setComponent(new ComponentName(result.activityInfo.packageName, result.activityInfo.name)),
179 | PendingIntent.FLAG_UPDATE_CURRENT);
180 | notificationBuilder.setContentIntent(pendingClickIntent);
181 | }
182 |
183 | PendingIntent pauseIntent = PendingIntent.getService(getApplicationContext(),
184 | 20,
185 | new Intent(ACTION)
186 | .setComponent(new ComponentName(getApplicationContext(), CsvDataLogger.class))
187 | .putExtra("CLASS", this.getClass().getCanonicalName()),
188 | PendingIntent.FLAG_UPDATE_CURRENT);
189 | notificationBuilder.addAction(R.drawable.ic_notify,
190 | getText(R.string.btn_stop_recording),
191 | pauseIntent);
192 |
193 | Notification notification = notificationBuilder.build();
194 | ((NotificationManager)getApplicationContext().getSystemService(Context.NOTIFICATION_SERVICE)).notify(NOTIFICATION_ID, notification);
195 | }
196 |
197 | private void showFinishedNotification(String name)
198 | {
199 | Notification.Builder notificationBuilder = new Notification.Builder(this)
200 | .setContentTitle(getText(R.string.lbl_notification_title))
201 | .setContentText(getString(R.string.lbl_notification_finished))
202 | .setSmallIcon(com.fr3ts0n.androbd.plugin.R.drawable.ic_coin)
203 | .setPriority(Notification.PRIORITY_DEFAULT);
204 |
205 | PendingIntent pendingClickIntent = PendingIntent.getActivity(getApplicationContext(),
206 | 15,
207 | new Intent(Intent.ACTION_MAIN)
208 | .setComponent(new ComponentName(getApplicationContext(), SettingsActivity.class))
209 | .addFlags(Intent.FLAG_ACTIVITY_NEW_TASK),
210 | PendingIntent.FLAG_UPDATE_CURRENT);
211 | notificationBuilder.setContentIntent(pendingClickIntent);
212 |
213 | Uri uri = Uri.parse("content://" + getPackageName() + ".provider/" + name);
214 | Intent shareIntent = new Intent(Intent.ACTION_SEND)
215 | .putExtra(Intent.EXTRA_STREAM, uri)
216 | .setType("text/plain")
217 | .addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);
218 | PendingIntent shareActionIntent = PendingIntent.getActivity(getApplicationContext(),
219 | 20,
220 | Intent.createChooser(shareIntent, getString(R.string.lbl_share)),
221 | PendingIntent.FLAG_UPDATE_CURRENT);
222 | notificationBuilder.addAction(R.drawable.ic_notify,
223 | getText(R.string.btn_share_recording),
224 | shareActionIntent);
225 |
226 | Notification notification = notificationBuilder.build();
227 | ((NotificationManager)getApplicationContext().getSystemService(Context.NOTIFICATION_SERVICE)).notify(NOTIFICATION_ID, notification);
228 | }
229 |
230 | private void hideNotification()
231 | {
232 | ((NotificationManager)getApplicationContext().getSystemService(Context.NOTIFICATION_SERVICE)).cancel(NOTIFICATION_ID);
233 | }
234 |
235 | private void stopRecording()
236 | {
237 | Log.i(TAG, "Stopping recording");
238 | hideNotification();
239 |
240 | if (writer != null)
241 | {
242 | String name = writer.getFilename();
243 | writer.close();
244 | writer.quitSafely();
245 | writer = null;
246 |
247 | if (name != null)
248 | {
249 | showFinishedNotification(name);
250 | }
251 | }
252 |
253 | ViewModel.isRecording = false;
254 |
255 | Toast.makeText(getApplicationContext(), R.string.btn_stop_recording, Toast.LENGTH_SHORT).show();
256 | }
257 |
258 | /**
259 | * Handle data list update.
260 | * If this happens while paused, changes the CsvData's columns to use the new layout
261 | *
262 | * @param csvString
263 | * CSV data string in format key;description;min;max;units.
264 | * One line per data item
265 | */
266 | @Override
267 | public void onDataListUpdate(String csvString)
268 | {
269 | // replace the column order if we haven't yet written the first segment
270 | if (writer == null || !writer.isOpen())
271 | {
272 | String[] dataListRows = csvString.split("\n");
273 | List columns = new ArrayList<>(dataListRows.length);
274 | for (String dataListRow: dataListRows)
275 | {
276 | String[] fields = dataListRow.split(";");
277 | if (fields.length > 3) {
278 | columns.add(fields[0]);
279 | }
280 | }
281 | segment.setColumns(columns);
282 | }
283 | }
284 |
285 | /**
286 | * Handle data update.
287 | * @param key Key of data change
288 | * @param value New value of data change
289 | */
290 | @Override
291 | public void onDataUpdate(String key, String value)
292 | {
293 | segment.setData(key, value);
294 | ViewModel.countDataPoints += 1;
295 |
296 | if (writer != null)
297 | {
298 | if (lastSaved + MIN_ROW_TIMEOUT < System.currentTimeMillis())
299 | {
300 | segment.saveRow();
301 | lastSaved = System.currentTimeMillis();
302 | ViewModel.countDataRows += 1;
303 | }
304 |
305 | if (segment.size() > 1000)
306 | {
307 | writeSegment();
308 | }
309 | }
310 | }
311 |
312 | private void writeSegment()
313 | {
314 | if (writer != null && segment.size() > 0)
315 | {
316 | CsvData previous = segment;
317 | segment = new CsvData(previous);
318 | writer.write(previous);
319 | lastWritten = System.currentTimeMillis();
320 | }
321 | }
322 |
323 | @Override
324 | public void onDestroy()
325 | {
326 | super.onDestroy();
327 |
328 | if (writer != null && segment.size() > 0)
329 | {
330 | CsvData previous = segment;
331 | segment = new CsvData(); // forget the previous columns, we are shutting down
332 | writer.write(previous);
333 | }
334 |
335 | stopRecording();
336 | }
337 | }
338 |
--------------------------------------------------------------------------------
/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 |
--------------------------------------------------------------------------------
