├── LICENSE ├── README.md └── _config.yml /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Unwired LocationAPI Android Library 2 | =================================== 3 | 4 |   5 | 6 | Introduction 7 | ------------ 8 | 9 | The Unwired Labs' LocationAPI locates all sorts of devices based on cell towers, 10 | WiFi APs and IP addresses, anywhere in the world. LocationAPI works both indoors 11 | & outdoors, when GPS isn't available or preferred (high battery drain). 12 | 13 | The new Android library is a drop-in replacement to Google Play's Geolocation 14 | services and offers the following benefits: 15 | 16 | - **Offline location** - now you can ask for the device's location and get a 17 | location in milliseconds even if the device has no or slow internet access. 18 | 19 | - **Higher accuracy** - Unwired's Geolocation triangulation & trilateration 20 | algorithms are *far superior* to Google's 'nearest-cell' based locations. 21 | This means no more locations in the sea and also, locations that are much 22 | closer to the device's real location. 23 | 24 | - **One-time permission request** - Unlike the Play Service library, the 25 | Unwired library works even when location is off, so your app can locate 26 | during events / emergencies, improving User Experience while ensuring that 27 | your location logic does not break. *Note that you must ensure the end user 28 | is aware of this feature and consents to its usage.* 29 | 30 | - \ **HTTP callbacks to your server** - We can send the device's 31 | location along with some custom tags / data to your server straight from the 32 | library or our servers with end-to-end encryption. This saves you the 33 | trouble of having to build & maintain secure device \<\> server 34 | communications. 35 | 36 | - \ **Offline street addresses, Location updates, Geofencing, 37 | Context-data model** 38 | 39 | Using the LocationAPI Library 40 | ----------------------------- 41 | 42 | **tldr;** 43 | 44 | We've created an open-source demo application that uses the [LocationAPI Library 45 | here](https://github.com/unwiredlabs/location-library-demo). 46 | 47 | ### Requirements 48 | 49 | **Library file:** The library which you must include in your project is 50 | [available for download as a .aar file 51 | here.](https://github.com/unwiredlabs/location-library-docs/releases) 52 | 53 | **Developer token:** You will also need a free developer token, which you can 54 | get by [signing up here](https://unwiredlabs.com/trial). 55 | 56 | **Android requirement:** The library requires an Android device with a minimum 57 | API Level of 10 (Gingerbread 2.3.3). It has been tested to be working on devices 58 | from API Level 10 through API Level 23 (Marshmallow 6.0). 59 | 60 | ### Step-by-step Usage Instructions 61 | 62 | If you prefer step-by-step instructions, here's a quick getting started guide: 63 | 64 | - Include the '.aar' file in your app; Android Studio users can follow [this 65 | guide](http://stackoverflow.com/a/24894387/1094271). 66 | 67 | - Add import statements to your class 68 | 69 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 70 | import com.unwiredlabs.locationapi.Location.LocationAdapter; 71 | import com.unwiredlabs.locationapi.Location.UnwiredLocationListener; 72 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 73 | 74 | - To get an instant location, call the `LocationAdapter.getLastLocation()` by 75 | specifying the accuracy level of the location you'd like and voila, you have 76 | it! Be aware that this is function is designed to be called synchronously 77 | and works exactly like Google's `getLastLocation()` where it might not be 78 | the absolute latest location (recently cached, etc) or match the accuracy 79 | level you specified. However, it is easy to call and great for applications 80 | where the developer prefers speed *versus* accuracy. 81 | 82 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 83 | //1. Initialize LocationAdapter class with Context & your developer Token 84 | final LocationAdapter locationAdapter = new LocationAdapter(this,"your_api_token"); 85 | 86 | //2. Request for the last location 87 | lastLocation = LocationAdapter.getLastLocation(); 88 | if (lastLocation != null) { 89 | latitudeText.setText(String.valueOf(lastLocation.getLatitude())); 90 | longitudeText.setText(String.valueOf(lastLocation.getLongitude())); 91 | } 92 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 93 | 94 | - If you'd like to get a fresh location or need it returned asynchronously, 95 | you can call the (slightly more complex) `LocationAdapter.getLocation()`. 96 | 97 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 98 | //1. Initialize LocationAdapter class with Context & your developer Token 99 | final LocationAdapter locationAdapter = new LocationAdapter(this,"your_api_token"); 100 | 101 | //2. Set the desired PRIORITY / Accuracy level 102 | locationAdapter.setPriority(LocationAdapter.PRIORITY_BALANCED_POWER_ACCURACY); 103 | 104 | //3. Initialize the location listener 105 | UnwiredLocationListener unwiredLocationListener = new UnwiredLocationListener() { 106 | @Override 107 | public void onLocationChanged(Location location) { 108 | if (location != null) { 109 | latitudeText.setText(String.valueOf(location.getLatitude())); 110 | longitudeText.setText(String.valueOf(location.getLongitude())); 111 | } 112 | } 113 | 114 | }; 115 | 116 | //4. Request location update 117 | locationAdapter.getLocation(unwiredLocationListener); 118 | 119 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 120 | 121 | 122 | 123 | ### Types of Priorities / Accuracy levels 124 | 125 | `LocationAdapter.setPriority()` - This method sets the priority or desired 126 | accuracy level for all subsequent Location requests. The library will use this 127 | definition to decide which location sources to use. The default priority is 128 | `PRIORITY_BALANCED_POWER_ACCURACY` 129 | 130 | The following values are supported: 131 | 132 | `PRIORITY_BALANCED_POWER_ACCURACY` - Use this setting to request location 133 | precision to within a city block, which is an accuracy of approximately 50 134 | meters. This is considered a coarse level of accuracy, and is likely to consume 135 | less power. With this setting, the location services are likely to use WiFi and 136 | cell tower positioning. Note, however, that the choice of location provider 137 | depends on many other factors, such as which sources are available. 138 | 139 | `PRIORITY_HIGH_ACCURACY` - Use this setting to request the most precise location 140 | possible. With this setting, the location services are more likely to use GPS to 141 | determine the location. In the event that GPS isn't available (no satellite fix, 142 | no permissions, etc), a less accurate but immediately available source of 143 | location is used. 144 | 145 | `PRIORITY_LOW_POWER` - Use this setting to request locality-level precision, 146 | which is an accuracy of approximately 3 kilometres. This is considered a coarse 147 | level of accuracy, and is likely to consume less power. With this setting, the 148 | location services are likely to use just cell tower positioning. 149 | 150 | `PRIORITY_NO_POWER` - Use this setting if you need negligible impact on power 151 | consumption, but want to receive location updates when available. With this 152 | setting, offline location lookups - lookups that are powered by Unwired's 153 | Offline Location feature - and Android's passive locations updates - lookups 154 | triggered by other apps - will be returned. 155 | 156 | ### Permissions 157 | 158 | The accompanying .aar lists the permissions required by the library, which are 159 | the following: 160 | 161 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 162 | 163 | 164 | 165 | 166 | 167 | 168 | 169 | 170 | 171 | 172 | 173 | 174 | 175 | 176 | 177 | 178 | 179 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 180 | 181 | **Android 6.0 (Marshmallow) note:** 182 | 183 | The library fully supports the requirements specified by Android 6.0 and will 184 | show a popup when you first request the user's location. 185 | 186 | Further Help 187 | ------------ 188 | 189 | [Reach out to us](https://unwiredlabs.com/contact) for any further questions or 190 | comments. 191 | 192 | Documentation To-Dos 193 | -------------------- 194 | 195 | - Detailed method index 196 | 197 | - Return values & types 198 | -------------------------------------------------------------------------------- /_config.yml: -------------------------------------------------------------------------------- 1 | theme: jekyll-theme-slate --------------------------------------------------------------------------------