codeforkarlsruhe / opensense Goto Github PK

Weather widgets for the openSenseMap project

License: BSD 2-Clause "Simplified" License

Kotlin 100.00%

opensense's Introduction

Open Sense

An app with widgets for the great openSenseMap project. It's still work in progress and in an early stage of development.

The current version 0.6.0 is available in the Play Store.

Features

One Value Widget, which shows one sensor value of a senseBox
Plot Widget, which shows a plot of one sensor value

Development

The app is work in progress and in an early development stage. Any suggestions, feature requests, bug reports or pull requests are very much appreciated.

Open Sense uses the Gitflow workflow:

All pull requests should be branched from develop
The pull request is merged into develop
The develop branch is merged into master for the next release

To work correctly, Open Sense requires an API token from mapbox. Setup steps:

Register for the free mapbox account
Go to API access token and get your API access token
Define the mapboxApiToken variable with the acquired token in the gradle user home gradle.properties. For Linux and Mac this is usually ~/.gradle/gradle.properties

Example of the gradle.properties:

mapboxApiToken="API TOKEN"

License

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

opensense's People

Contributors

Stargazers

Watchers

Forkers

felixerdy silberzwiebel chrjsorg codeforberlin alfayedoficial

opensense's Issues

select last sensor box as default for new widget

so one does not have to zoom into the same area of the world every time one wants to add a new widget

Translate the widget texts into German

At the moment the app has only English language strings. On the other hand, the opensenseMap-API provides the Sensor#title in German. So opensense should at least provide a German translate.

Improve ProGuard rules and use them for release build

We should use ProGuard for shrinking, optimization and obfuscation. The main advantage for OpenSense will be a much smaller APK size.

Improve app build pipeline

Improvements for the 0.3.0 release:

Update versionName and versionCode
Update gradle build tools
Check and update the app dependencies

show history plots incl. mean values

Something similar to the graph tab of the opensensemap-widget to give an impression of the history of sensor values.

I think it would also be interesting to additionally plot the mean sensor value of the last 24 hours / weeks / years (configurable). Possibly even the mean value of nearby senseboxes?

Generally speaking, I would be interested in contributing an implementation of this idea to your project (I was thinking about android widgets before someone pointed me to your project). However, I'm not sure how much time I can spend on this in the near future.

Change a existing widget

The widget should provide a button to open the configuration activity and re-configure it.

Improve the design of the app

Improve the design because it is really necessary. 😁

For example

A beautiful app icon
Icons for the different sensor types in the widget
Improve the one value widget design
Prettier configuration screen

publish at F-Droid appstore

It would be a great addition for non-playstore users to have the app in F-Droid.
At a quick glance it seems that the app fulfills the inclusion policy.

see https://f-droid.org/docs/Submitting_to_F-Droid_Quick_Start_Guide/

Improve mapbox token handling

We should handle the required mapbox token introduced with #4 with an simple and well-documented solution.

Tasks

Move the mapbox token from strings.xml into the app/build.gradle and store the token in a buildConfigField. We could use a resource as well, but I prefer the (static) BuildConfig for configuration
Set the buildConfigField to a variable. This variable is provided when building the app. The easiest way for developer (local builds) is to set the variable is the user-specificy gradle properties file in the users home directory (for example ~/.gradle/gradle.properties)
Adjust the initialization of the mapbox view
Add some documentation to explain how to get a token and where to put it

Provide an Android App

Currently, Open Sense is just a widget and a configuration screen. To integrate more features provided by the openSenseMap-API the project should consist of a typical Android app.

This issue is intended as a collection of ideas and base-issue for the later implementation. Please feel free to post your ideas, input and toughs about this topic.

Some base features:

Info box to see the sensor data for my preferred senseBox in the app
Search and view the sensor data of every senseBox
Information about den openSenseMap project and links to the website
Show the history of sensor data (see #12)

Option to set the update interval

At the moment the widget is updates every hour. This information is provided by the widget info xml and the user can't change the interval in the configuration. The app configuration should provide a setting for the update interval. This setting triggers an alarm or a similar scheduling method as mentioned in the App Widgets documentation.