Skip to content

Commit

Permalink
Version 5.0.1
Browse files Browse the repository at this point in the history
  • Loading branch information
@minixT
minixT committed Apr 10, 2018
1 parent 5d668bd commit 2bcf52f
Show file tree
Hide file tree
Showing 56 changed files with 1,237 additions and 779 deletions.
2 changes: 1 addition & 1 deletion .jazzy.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ github_url: https://github.com/Polidea/RxBluetoothKit
module: RxBluetoothKit
author_url: https://polidea.com
author: Polidea
swift_version: 4.0.3
swift_version: 4.1.0
clean: true
output: docs
root-url: https://polidea.github.io/RxBluetoothKit/
Expand Down
9 changes: 9 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
# 5.0.1
- Added method to observe notyfing state change for the characteristic (#229)
- Aligned the API for `establishConnection` with the rest of the implementation
- Made restore state api public (#224)
- Enabled getting an `Observable<Peripheral>` from already connected peripheral provided by the system (#238)
- Fixed writting without response on older systems (#241)
- Added queues for discovery requests (fixed #235)
- Added support for XCode 9.3 and swift 4.1

# 5.0
- Changed `BluetoothManager` to `CentralManager`
- Reimplemented connection and notification API's
Expand Down
2 changes: 1 addition & 1 deletion RxBluetoothKit.podspec
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Pod::Spec.new do |s|
s.name = "RxBluetoothKit"
s.version = "5.0.0"
s.version = "5.0.1"
s.summary = "Bluetooth library for RxSwift"

s.description = <<-DESC
Expand Down
16 changes: 8 additions & 8 deletions docs/Classes.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ <h4>Declaration</h4>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/Polidea/RxBluetoothKit/tree/5.0.0/Source/CentralManager.swift#L25-L288">Show on GitHub</a>
<a href="https://github.com/Polidea/RxBluetoothKit/tree/5.0.1/Source/CentralManager.swift#L25-L288">Show on GitHub</a>
</div>
</section>
</div>
Expand Down Expand Up @@ -222,7 +222,7 @@ <h4>Declaration</h4>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/Polidea/RxBluetoothKit/tree/5.0.0/Source/Characteristic.swift#L8-L105">Show on GitHub</a>
<a href="https://github.com/Polidea/RxBluetoothKit/tree/5.0.1/Source/Characteristic.swift#L8-L112">Show on GitHub</a>
</div>
</section>
</div>
Expand Down Expand Up @@ -259,7 +259,7 @@ <h4>Declaration</h4>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/Polidea/RxBluetoothKit/tree/5.0.0/Source/Descriptor.swift#L8-L64">Show on GitHub</a>
<a href="https://github.com/Polidea/RxBluetoothKit/tree/5.0.1/Source/Descriptor.swift#L8-L64">Show on GitHub</a>
</div>
</section>
</div>
Expand Down Expand Up @@ -294,7 +294,7 @@ <h4>Declaration</h4>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/Polidea/RxBluetoothKit/tree/5.0.0/Source/Logging.swift#L6-L95">Show on GitHub</a>
<a href="https://github.com/Polidea/RxBluetoothKit/tree/5.0.1/Source/Logging.swift#L6-L95">Show on GitHub</a>
</div>
</section>
</div>
Expand Down Expand Up @@ -330,7 +330,7 @@ <h4>Declaration</h4>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/Polidea/RxBluetoothKit/tree/5.0.0/Source/Peripheral.swift#L9-L558">Show on GitHub</a>
<a href="https://github.com/Polidea/RxBluetoothKit/tree/5.0.1/Source/Peripheral.swift#L10-L665">Show on GitHub</a>
</div>
</section>
</div>
Expand Down Expand Up @@ -366,7 +366,7 @@ <h4>Declaration</h4>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/Polidea/RxBluetoothKit/tree/5.0.0/Source/ScannedPeripheral.swift#L6-L22">Show on GitHub</a>
<a href="https://github.com/Polidea/RxBluetoothKit/tree/5.0.1/Source/ScannedPeripheral.swift#L6-L22">Show on GitHub</a>
</div>
</section>
</div>
Expand Down Expand Up @@ -401,7 +401,7 @@ <h4>Declaration</h4>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/Polidea/RxBluetoothKit/tree/5.0.0/Source/Service.swift#L7-L62">Show on GitHub</a>
<a href="https://github.com/Polidea/RxBluetoothKit/tree/5.0.1/Source/Service.swift#L7-L62">Show on GitHub</a>
</div>
</section>
</div>
Expand All @@ -411,7 +411,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="https://polidea.com" target="_blank" rel="external">Polidea</a>. All rights reserved. (Last updated: 2018-03-14)</p>
<p>&copy; 2018 <a class="link" href="https://polidea.com" target="_blank" rel="external">Polidea</a>. All rights reserved. (Last updated: 2018-04-10)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
133 changes: 116 additions & 17 deletions docs/Classes/CentralManager.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -171,9 +171,9 @@ <h1>CentralManager</h1>
<li class="item">
<div>
<code>
<a name="/s:14RxBluetoothKit14CentralManagerC07centralE0So09CBCentralE0Cv"></a>
<a name="/s:14RxBluetoothKit14CentralManagerC07centralE0So09CBCentralE0Cvp"></a>
<a name="//apple_ref/swift/Property/centralManager" class="dashAnchor"></a>
<a class="token" href="#/s:14RxBluetoothKit14CentralManagerC07centralE0So09CBCentralE0Cv">centralManager</a>
<a class="token" href="#/s:14RxBluetoothKit14CentralManagerC07centralE0So09CBCentralE0Cvp">centralManager</a>
</code>
</div>
<div class="height-container">
Expand All @@ -193,7 +193,7 @@ <h4>Declaration</h4>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/Polidea/RxBluetoothKit/tree/5.0.0/Source/CentralManager.swift#L28">Show on GitHub</a>
<a href="https://github.com/Polidea/RxBluetoothKit/tree/5.0.1/Source/CentralManager.swift#L28">Show on GitHub</a>
</div>
</section>
</div>
Expand Down Expand Up @@ -272,7 +272,7 @@ <h4>Parameters</h4>
</table>
</div>
<div class="slightly-smaller">
<a href="https://github.com/Polidea/RxBluetoothKit/tree/5.0.0/Source/CentralManager.swift#L68-L78">Show on GitHub</a>
<a href="https://github.com/Polidea/RxBluetoothKit/tree/5.0.1/Source/CentralManager.swift#L68-L78">Show on GitHub</a>
</div>
</section>
</div>
Expand Down Expand Up @@ -304,7 +304,7 @@ <h4>Declaration</h4>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/Polidea/RxBluetoothKit/tree/5.0.0/Source/CentralManager.swift#L83-L85">Show on GitHub</a>
<a href="https://github.com/Polidea/RxBluetoothKit/tree/5.0.1/Source/CentralManager.swift#L83-L85">Show on GitHub</a>
</div>
</section>
</div>
Expand All @@ -323,9 +323,9 @@ <h3 class="section-name">State</h3>
<li class="item">
<div>
<code>
<a name="/s:14RxBluetoothKit14CentralManagerC5stateAA0B5StateOv"></a>
<a name="/s:14RxBluetoothKit14CentralManagerC5stateAA0B5StateOvp"></a>
<a name="//apple_ref/swift/Property/state" class="dashAnchor"></a>
<a class="token" href="#/s:14RxBluetoothKit14CentralManagerC5stateAA0B5StateOv">state</a>
<a class="token" href="#/s:14RxBluetoothKit14CentralManagerC5stateAA0B5StateOvp">state</a>
</code>
</div>
<div class="height-container">
Expand All @@ -345,7 +345,7 @@ <h4>Declaration</h4>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/Polidea/RxBluetoothKit/tree/5.0.0/Source/CentralManager.swift#L90-L92">Show on GitHub</a>
<a href="https://github.com/Polidea/RxBluetoothKit/tree/5.0.1/Source/CentralManager.swift#L90-L92">Show on GitHub</a>
</div>
</section>
</div>
Expand Down Expand Up @@ -381,7 +381,7 @@ <h4>Return Value</h4>
<p>Observable that emits <code>next</code> event whenever state changes.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/Polidea/RxBluetoothKit/tree/5.0.0/Source/CentralManager.swift#L98-L100">Show on GitHub</a>
<a href="https://github.com/Polidea/RxBluetoothKit/tree/5.0.1/Source/CentralManager.swift#L98-L100">Show on GitHub</a>
</div>
</section>
</div>
Expand Down Expand Up @@ -479,7 +479,7 @@ <h4>Return Value</h4>
<p>Infinite stream of scanned peripherals.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/Polidea/RxBluetoothKit/tree/5.0.0/Source/CentralManager.swift#L127-L168">Show on GitHub</a>
<a href="https://github.com/Polidea/RxBluetoothKit/tree/5.0.1/Source/CentralManager.swift#L127-L168">Show on GitHub</a>
</div>
</section>
</div>
Expand Down Expand Up @@ -561,7 +561,7 @@ <h4>Return Value</h4>
<p><code>Observable</code> which emits next event after connection is established.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/Polidea/RxBluetoothKit/tree/5.0.0/Source/CentralManager.swift#L182-L185">Show on GitHub</a>
<a href="https://github.com/Polidea/RxBluetoothKit/tree/5.0.1/Source/CentralManager.swift#L182-L185">Show on GitHub</a>
</div>
</section>
</div>
Expand Down Expand Up @@ -627,7 +627,7 @@ <h4>Return Value</h4>
<code><a href="../Classes/Service.html">Service</a></code>s with UUIDs specified in the <code>serviceUUIDs</code> parameter.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/Polidea/RxBluetoothKit/tree/5.0.0/Source/CentralManager.swift#L195-L198">Show on GitHub</a>
<a href="https://github.com/Polidea/RxBluetoothKit/tree/5.0.1/Source/CentralManager.swift#L195-L198">Show on GitHub</a>
</div>
</section>
</div>
Expand Down Expand Up @@ -680,7 +680,7 @@ <h4>Return Value</h4>
<p>Retrieved <code><a href="../Classes/Peripheral.html">Peripheral</a></code>s.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/Polidea/RxBluetoothKit/tree/5.0.0/Source/CentralManager.swift#L204-L207">Show on GitHub</a>
<a href="https://github.com/Polidea/RxBluetoothKit/tree/5.0.1/Source/CentralManager.swift#L204-L207">Show on GitHub</a>
</div>
</section>
</div>
Expand Down Expand Up @@ -746,7 +746,7 @@ <h4>Return Value</h4>
<p>Observable which emits next events when <code>peripheral</code> was connected.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/Polidea/RxBluetoothKit/tree/5.0.0/Source/CentralManager.swift#L216-L224">Show on GitHub</a>
<a href="https://github.com/Polidea/RxBluetoothKit/tree/5.0.1/Source/CentralManager.swift#L216-L224">Show on GitHub</a>
</div>
</section>
</div>
Expand Down Expand Up @@ -800,10 +800,109 @@ <h4>Parameters</h4>
<h4>Return Value</h4>
<p>Observable which emits next events when <code><a href="../Classes/Peripheral.html">Peripheral</a></code> instance was disconnected.
It provides optional error which may contain more information about the cause of the disconnection
if it wasn&rsquo;t the <code>cancelConnection</code> call.</p>
if it wasn&rsquo;t the <code>cancelPeripheralConnection</code> call.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/Polidea/RxBluetoothKit/tree/5.0.0/Source/CentralManager.swift#L233-L249">Show on GitHub</a>
<a href="https://github.com/Polidea/RxBluetoothKit/tree/5.0.1/Source/CentralManager.swift#L233-L249">Show on GitHub</a>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<div class="task-name-container">
<a name="/State%20restoration"></a>
<a name="//apple_ref/swift/Section/State restoration" class="dashAnchor"></a>
<a href="#/State%20restoration">
<h3 class="section-name">State restoration</h3>
</a>
</div>
<ul>
<li class="item">
<div>
<code>
<a name="/s:14RxBluetoothKit14CentralManagerCACSo13DispatchQueueC5queue_s10DictionaryVySSyXlGSg7optionsyAA13RestoredStateVcSg013onWillRestoreL0tcfc"></a>
<a name="//apple_ref/swift/Method/init(queue:options:onWillRestoreState:)" class="dashAnchor"></a>
<a class="token" href="#/s:14RxBluetoothKit14CentralManagerCACSo13DispatchQueueC5queue_s10DictionaryVySSyXlGSg7optionsyAA13RestoredStateVcSg013onWillRestoreL0tcfc">init(queue:options:onWillRestoreState:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Creates new <code>CentralManager</code> instance, which supports bluetooth state restoration.</p>
<div class="aside aside-warning">
<p class="aside-title">Warning</p>
If you pass background queue to the method make sure to observe results on main thread
for UI related code.

</div>
<div class="aside aside-seealso">
<p class="aside-title">Seealso</p>
<p><code><a href="../Structs/RestoredState.html">RestoredState</a></code></p>

</div>

</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="n">convenience</span> <span class="nf">init</span><span class="p">(</span><span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span> <span class="o">=</span> <span class="o">.</span><span class="n">main</span><span class="p">,</span>
<span class="nv">options</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">:</span> <span class="kt">AnyObject</span><span class="p">]?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
<span class="nv">onWillRestoreState</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:14RxBluetoothKit18OnWillRestoreStatea">OnWillRestoreState</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre>

</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>queue</em>
</code>
</td>
<td>
<div>
<p>Queue on which bluetooth callbacks are received. By default main thread is used
and all operations and events are executed and received on main thread.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>options</em>
</code>
</td>
<td>
<div>
<p>An optional dictionary containing initialization options for a central manager.
For more info about it please refer to <a href="https://developer.apple.com/library/ios/documentation/CoreBluetooth/Reference/CBCentralManager_Class/index.html">Central Manager initialization options</a></p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>onWillRestoreState</em>
</code>
</td>
<td>
<div>
<p>Closure called when state has been restored.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="slightly-smaller">
<a href="https://github.com/Polidea/RxBluetoothKit/tree/5.0.1/Source/CentralManager+RestoredState.swift#L24-L31">Show on GitHub</a>
</div>
</section>
</div>
Expand All @@ -813,7 +912,7 @@ <h4>Return Value</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="https://polidea.com" target="_blank" rel="external">Polidea</a>. All rights reserved. (Last updated: 2018-03-14)</p>
<p>&copy; 2018 <a class="link" href="https://polidea.com" target="_blank" rel="external">Polidea</a>. All rights reserved. (Last updated: 2018-04-10)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
Loading

0 comments on commit 2bcf52f

Please sign in to comment.