Skip to content

Commit

Permalink
Merge pull request #1 from electricimp/feature/apn-override
Browse files Browse the repository at this point in the history
SDK Version 6.5.0
  • Loading branch information
muhnihch authored Nov 9, 2024
2 parents e555d3e + 874ad4f commit bcbe5e5
Show file tree
Hide file tree
Showing 209 changed files with 2,730 additions and 3,502 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# The Electric Imp BlinkUp SDK for Android 6.4.5 #
# The Electric Imp BlinkUp SDK for Android 6.5.0 #

This repo contains the Electric Imp BlinkUp™ SDK for Android as it is made available to Electric Imp customers. It mirrors the downloadable files hosted by the [Dev Center](https://developer.electricimp.com/manufacturing/sdkdocs), but in a form that allows developers to add the SDK to their app project repos as a sub-module. This will allow them to pull in SDK changes manually at build time, or automatically through their build scripts.

Expand Down
21 changes: 8 additions & 13 deletions sdk/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Electric Imp Android BlinkUp SDK 6.4.5 #
# Electric Imp Android BlinkUp SDK 6.5.0 #

- [Introduction](#introduction)
- [Installation](#installation)
Expand All @@ -15,7 +15,7 @@ Electric Imp's BlinkUp™ technology is used to activate and configure devices b

#### Notice ####

The Electric Imp Android BlinkUp SDK is licensed solely for the provision of BlinkUp services within mobile apps developed by or on behalf of Electric Imp customers. All rights reserved. The Android BlinkUp SDK is copyright Twilio, Inc. 2021.
The Electric Imp Android BlinkUp SDK is licensed solely for the provision of BlinkUp services within mobile apps developed by or on behalf of Electric Imp customers. All rights reserved. The Android BlinkUp SDK is copyright KORE Wireless, Inc. 2023.

## Installation ##

Expand All @@ -29,10 +29,8 @@ After you have compiled a sample project successfully, you can integrate the Bli
1. Open your project in Android Studio. Copy the directory `repo` into `app/repo` in the project list.
2. Add the following code to `app/build.gradle`:
```java
repositories {
maven {
url "$projectDir/repo"
}
dependencies {
implementation fileTree(dir: 'repo', include: ['*.aar', '*.jar'], exclude: [])
}
```

Expand Down Expand Up @@ -85,7 +83,7 @@ blinkup = new BlinkupController();
blinkup.setPlanID(retrievedPlanID);
```

You can now call one of the SDK's *setupDevice(...)* functions according to whether your imp-enabled device connects by Ethernet, cellular or WiFi. Whichever of these calls you use, the SDK will retrieve a new setup token, bundle it with the previously set plan ID and send them to the device using BlinkUp.
You can now call one of the SDK's setupDevice(...) functions based on your imp-enabled device's connection type—Ethernet, cellular, or WiFi. If your device connects by cellular and requires a custom APN, you can use setupDeviceWithCustomApn(...). Whichever of these calls you use, the SDK will retrieve a new setup token, bundle it with the previously set plan ID, and send them to the device using BlinkUp

**Note** If you do not call *setPlanID()*, then the SDK will acquire a new plan ID for you.

Expand Down Expand Up @@ -122,13 +120,10 @@ For information on licensing, please see the file `licensing/README.md`.

## Release Notes ##

### 6.4.5 ###
### 6.5.0 ###

- Under Android 11 on devices running a 90Hz or 120Hz display refresh rate, switch display to 60Hz during BlinkUp for greater stability.
- introduces a new option allowing users to set a custom APN for cellular connections, with the flexibility to leave it blank if the default APN is preferred.

### 6.4.4 ###

- Support 120Hz frame rate on Samsung Galaxy S20 (and possibly other devices running refresh rates >60Hz).

### 6.4.3 ###

Expand Down Expand Up @@ -238,4 +233,4 @@ The SDK is packaged as a maven repo instead of just a .aar file. Please replace
- **BREAKING CHANGE** BlinkupController interfaces has been moved:
- BlinkupController.ServerErrorHandler -> ServerErrorHandler
- BlinkupController.TokenAcquireCallback -> TokenAcquireCallback
- BlinkupController.TokenStatusCallback -> TokenStatusCallback
- BlinkupController.TokenStatusCallback -> TokenStatusCallback
2,532 changes: 1,163 additions & 1,369 deletions sdk/javadoc/BlinkupController.html

Large diffs are not rendered by default.

332 changes: 145 additions & 187 deletions sdk/javadoc/Proxy.Error.html

Large diffs are not rendered by default.

408 changes: 173 additions & 235 deletions sdk/javadoc/Proxy.html

Large diffs are not rendered by default.

133 changes: 61 additions & 72 deletions sdk/javadoc/ServerErrorHandler.html
Original file line number Diff line number Diff line change
@@ -1,97 +1,86 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>ServerErrorHandler (blinkup 6.4.5 API)</title>
<!-- Generated by javadoc (17) -->
<title>ServerErrorHandler (blinkup 6.5.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="declaration: package: com.electricimp.blinkup, interface: ServerErrorHandler">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
<script type="text/javascript" src="../../../script-dir/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="../../../script-dir/jquery-ui.min.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ServerErrorHandler (blinkup 6.4.5 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<body class="class-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.electricimp.blinkup</div>
<h2 title="Interface ServerErrorHandler" class="title">Interface ServerErrorHandler</h2>
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">com.electricimp.blinkup</a></div>
<h1 title="Interface ServerErrorHandler" class="title">Interface ServerErrorHandler</h1>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<section class="class-description" id="class-description">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">ServerErrorHandler</span></pre>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">ServerErrorHandler</span></div>
<div class="block">Interface to handle api key errors.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
</section>
<section class="summary">
<ul class="summary-list">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="ServerErrorHandler.html#onError-java.lang.String-">onError</a></span>(<a href="http://d.android.com/reference/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;errorMsg)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0">
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#onError(java.lang.String)" class="member-name-link">onError</a><wbr>(<a href="http://d.android.com/reference/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;errorMsg)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="onError-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>onError</h4>
<pre>void&nbsp;onError(<a href="http://d.android.com/reference/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;errorMsg)</pre>
</div>
</div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="onError(java.lang.String)">
<h3>onError</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">onError</span><wbr><span class="parameters">(<a href="http://d.android.com/reference/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;errorMsg)</span></div>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
</body>
</html>
Loading

0 comments on commit bcbe5e5

Please sign in to comment.