You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Fixes #[Add issue number here. Note: This will automatically closes the issue. If you do not solve the issue entirely, please change the message to e.g. "First steps for issues #IssueNumber]
1
+
**Fixes** #<!-- Add issue number here. This will automatically closes the issue. If you do not solve the issue entirely, please change the message to e.g. "First steps for issues #IssueNumber" -->
2
2
3
-
**Changes**: [Add here what changes were made in this issue and if possible provide links.]
3
+
**Changes**:
4
+
- <!-- Add here what changes were made in this issue and if possible provide links. -->
4
5
5
-
**Screenshot/s for the changes**: [Add screenshot/s of the layout where you made changes or a `*.gif` containing a demonstration]
6
+
**Screen shots for the changes**:
7
+
<!-- Add screen shots/screen recordings of the layout where you made changes or a `*.gif` containing a demonstration -->
6
8
7
-
**Checklist**: [Please tick following check boxes with `[x]` if the respective task is completed]
8
-
- [ ] I have used resources from `strings.xml`, `dimens.xml` and `colors.xml` without hard-coding them
9
-
- [ ] No modifications done at the end of resource files `strings.xml`, `dimens.xml` or `colors.xml`
10
-
- [ ] I have reformatted code in every file included in this PR [<kbd>CTRL</kbd>+<kbd>ALT</kbd>+<kbd>L</kbd>]
11
-
- [ ] My code does not contain any extra lines or extra spaces
12
-
- [ ] I have requested reviews from other members
13
-
14
-
**APK for testing**: [Compress the `app-debug.apk` file into a `<feature>.rar` or `<feature>.zip` file and upload it here]
9
+
**Checklist**: <!-- Please tick following check boxes with `[x]` if the respective task is completed -->
10
+
- [ ] I have used resources from `strings.xml`, `dimens.xml` and `colors.xml` without hard-coding any value.
11
+
- [ ] No modifications done at the end of resource files `strings.xml`, `dimens.xml` or `colors.xml`.
12
+
- [ ] I have reformatted code and fixed indentation in every file included in this pull request
13
+
- [ ] My code does not contain any extra lines or extra spaces.
*[Observing Sound Waveforms Using PSLab Device](https://www.youtube.com/watch?v=5bxDd1PiOMQ).
103
+
*[Real-time Sensor Data Logging Using Pocket Science Lab](https://www.youtube.com/watch?v=_A8h6o-UcNo).
104
+
*[Generating and Observing Waveforms Using Pocket Science Lab](https://www.youtube.com/watch?v=Ua9_OCR4p8Y).
100
105
101
106
## Features
102
107
|**Feature**|**Description**|**Status**|
@@ -133,31 +138,41 @@ There are 2 flavors (build variants) of PSLab Android application.
133
138
Before you begin, you should already have the Android Studio SDK downloaded and set up correctly. You can find a guide on how to do this here: [Setting up Android Studio](http://developer.android.com/sdk/installing/index.html?pkg=studio)
134
139
135
140
### Setting up the Android Project
141
+
For setting up the PSLab Android project you may follow any of the two methods listed below, that is, you may download the repository zip file or you may directly clone the repository to Android Studio.
136
142
137
-
1. Download the _pslab-android_ project source. You can do this either by forking and cloning the repository (recommended if you plan on pushing changes) or by downloading it as a ZIP file and extracting it.
143
+
### By downloading the zip file
138
144
139
-
2. Open Android Studio, you will see a **Welcome to Android** window. Under Quick Start, select _Import Project (Eclipse ADT, Gradle, etc.)_
145
+
1. Download the _pslab-android_ project source. You can do this either by forking and cloning the repository (recommended if you plan on pushing changes) or by downloading it as a ZIP file and extracting it.
140
146
141
-
3. Navigate to the directory where you saved the pslab-android project, select the "pslab-android" folder, and hit OK. Android Studio should now begin building the project with Gradle.
147
+
2. Open Android Studio, you will see a **Welcome to Android** window. Under Quick Start, select _Import Project (Eclipse ADT, Gradle, etc.)To debug over Wi-Fi follow the steps given in this [Blog](http://blog.fossasia.org/android-app-debugging-over-wifi-fo).
142
148
143
-
4. Once this process is complete and Android Studio opens, check the Console for any build errors.
149
+
***Note :**
150
+
If you built your own hardware, change VendorID and/or ProductID in [CommunicationHandler.java](blob/master/app/src/main/java/io/pslab/communication/CommunicationHandler.java).
144
151
145
-
-_Note:_ If you receive a Gradle sync error titled, "failed to find ...", you should click on the link below the error message (if available) that says _Install missing platform(s) and sync project_ and allow Android studio to fetch you what is missing.
152
+
### By direct cloning
146
153
147
-
5. Once all build errors have been resolved, you should be all set to build the app and test it.
154
+
1. Open Android Studio, you will see a **Welcome to Android** window. Under Quick Start, select "check out project from version control".
155
+
2. Select git from the drop down menu that appeared.
156
+
3. Go to the repository and click clone or download button.
157
+
4. From the dropdown that appeared, copy the link.
158
+
5. Paste the URL that you copied and press clone.
159
+
6. Android studio should now begin building the project with gradle.
160
+
7. Once this process is complete and Android Studio opens, check the Console for any build errors.
148
161
149
-
6. To Build the app, go to _Build>Make Project_ (or alternatively press the Make Project icon in the toolbar).
162
+
-_Note:_ If you receive a Gradle sync error titled, "failed to find ...", you should click on the link below the error message (if available) that says _Install missing platform(s) and sync project_ and allow Android studio to fetch you what is missing.
150
163
151
-
7. If the app was built successfully, you can test it by running it on either a real device or an emulated one by going to _Run>Run 'app'_ or pressing the Run icon in the toolbar.
164
+
8. Once all build errors have been resolved, you should be all set to build the app and test it.
165
+
9. To Build the app, go to _Build>Make Project_ (or alternatively press the Make Project icon in the toolbar).
166
+
10. If the app was built successfully, you can test it by running it on either a real device or an emulated one by going to _Run>Run 'app'_ or pressing the Run icon in the toolbar.
152
167
153
168
If you want build apk only, go to Build>Build apk and apk would be build and directory where apk is generated would be prompted by Android Studio.
154
169
155
170
You can't debug the usual way as PSLab device is connected to micro-USB port through OTG cable. So Android Device is not connected to PC through USB cable.
156
171
157
-
To debug over Wi-Fi: http://blog.fossasia.org/android-app-debugging-over-wifi-for-pslab/
172
+
To debug over Wi-Fi follow the steps given in this [Blog](http://blog.fossasia.org/android-app-debugging-over-wifi-for-pslab/).
158
173
159
-
Note :
160
-
1.If you built your own hardware, change VendorID and/or ProductID in [CommunicationHandler.java](https://github.com/fossasia/pslab-android/blob/master/app/src/main/java/io/pslab/communication/CommunicationHandler.java)
174
+
***Note :**
175
+
If you built your own hardware, change VendorID and/or ProductID in [CommunicationHandler.java](https://github.com/fossasia/pslab-android/blob/master/app/src/main/java/io/pslab/communication/CommunicationHandler.java).
161
176
162
177
### Permissions Required
163
178
@@ -175,11 +190,11 @@ To use PSLab device with Android, you simply need an OTG cable, an Android Devic
175
190
176
191
Please help us follow the best practice to make it easy for the reviewer as well as the contributor. We want to focus on the code quality more than on managing pull request ethics.
177
192
178
-
* Single commit per pull request
179
-
* Reference the issue numbers in the commit message. Follow the pattern ``` Fixes #<issue number> <commit message>```
180
-
* Follow uniform design practices. The design language must be consistent throughout the app.
181
-
* The pull request will not get merged until and unless the commits are squashed. In case there are multiple commits on the PR, the commit author needs to squash them and not the maintainers cherrypicking and merging squashes.
182
-
* If the PR is related to any front end change, please attach relevant screenshots in the pull request description.
193
+
* Single commit per pull request.
194
+
* Reference the issue numbers in the commit message. Follow the pattern ``` Fixes #<issue number> <commit message>```
195
+
* Follow uniform design practices. The design language must be consistent throughout the app.
196
+
* The pull request will not get merged until and unless the commits are squashed. In case there are multiple commits on the PR, the commit author needs to squash them and not the maintainers cherrypicking and merging squashes.
197
+
* If the PR is related to any front end change, please attach relevant screenshots in the pull request description.
183
198
184
199
#### How to `git squash`?
185
200
@@ -190,27 +205,27 @@ As a tip for new developers those who struggle with squashing commits into one,
190
205
191
206
Despite any reason, follow the steps given below to squash all commits into one adhering to our best practices.
192
207
193
-
* Setup remote to upstream branch if not set before;
208
+
* Setup remote to upstream branch if not set before
0 commit comments