Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@rzeznickij
rzeznickij committed Jun 26, 2024
1 parent fd5cbbb commit b4da576
Show file tree
Hide file tree
Showing 267 changed files with 13,431 additions and 682 deletions.
51 changes: 43 additions & 8 deletions index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
</a>
</div>
<div class="library-version">
</div>
v0.0.2 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":mobileblesdk:dokkaHtml/release">androidJvm</button>
Expand All @@ -65,6 +65,7 @@
<div class="breadcrumbs"></div>
<div class="cover ">
<h1 class="cover"><span><span>mobileblesdk</span></span></h1>
<div class="platform-hinted UnderCoverText" data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":mobileblesdk:dokkaHtml/release"><p class="paragraph">Welcome to the Tedee Mobile SDK for Android! This comprehensive toolkit empowers developers to seamlessly integrate Tedee Lock functionality into their Android applications. Whether you're building a smart home app or enhancing access control features, our SDK provides the necessary tools to communicate with and control Tedee locks with ease, leveraging Bluetooth Low Energy (BLE) communication protocol.</p><h2 class="">Features</h2><ul><li><p class="paragraph"><strong>Effortless Integration</strong>: Incorporate Tedee lock functionality into your Android applications seamlessly.</p></li><li><p class="paragraph"><strong>Full Control</strong>: Communicate with and operate Tedee locks, including <a href="https://tedee.com/product-info/tedee-pro/">Tedee PRO</a> and <a href="https://tedee.com/product-info/tedee-go-best-keyless-access/">Tedee GO</a>, with comprehensive control options.</p></li><li><p class="paragraph"><strong>Efficient Communication</strong>: Utilize Bluetooth Low Energy (BLE) for efficient device interaction, ensuring optimal performance and minimal energy consumption.</p></li><li><p class="paragraph"><strong>Add Lock to Account</strong>: Add a lock to your Tedee account and register the lock device. For detailed steps, refer to <a href="https://github.com/tedee-com/tedee-example-ble-android/blob/master/ADD_LOCK_README.md">Add lock to account - tutorial</a> readme file.</p></li></ul><h2 class="">Add Lock to Account Tutorial</h2><p class="paragraph"><a href="https://github.com/tedee-com/tedee-example-ble-android/blob/master/ADD_LOCK_README.md">Add lock to account - tutorial</a> will guide you through the basic steps required to add a lock to your Tedee account and register the lock device.</p><h2 class="">Example App</h2><p class="paragraph">Explore the capabilities of the Tedee Mobile SDK through our <a href="https://github.com/tedee-com/tedee-example-ble-android">example app</a>. This example app demonstrates various use cases and serves as a practical guide for integrating the SDK into your projects.</p><h2 class="">Support</h2><p class="paragraph">For any inquiries, feedback, or assistance, our Android team is here to help. Reach out to us at <a href="https://github.com/tedee-com/tedee-mobile-sdk-android/discussions">Discussions</a> section with any questions or concerns you may have.</p><p class="paragraph">We're excited to witness the innovative solutions you create with the Tedee Mobile SDK! Happy coding! 🚀</p></div></div>
</div>
<h2 class="">Packages</h2>
<div class="table"><a data-name="581129496%2FPackages%2F-261839533" anchor-label="tedee.mobile.sdk.ble" id="581129496%2FPackages%2F-261839533" data-filterable-set=":mobileblesdk:dokkaHtml/release"></a>
Expand All @@ -82,7 +83,9 @@ <h2 class="">Packages</h2>
</div>
</div>
</div>
<div></div>
<div><span class="brief-comment"><a data-name="581129496%2FPackages%2F-261839533" anchor-label="tedee.mobile.sdk.ble" id="581129496%2FPackages%2F-261839533" data-filterable-set=":mobileblesdk:dokkaHtml/release"></a>
<p class="paragraph">This package houses the Bluetooth constants.</p>
</span></div>
</div>
</div>
<a data-name="1067962328%2FPackages%2F-261839533" anchor-label="tedee.mobile.sdk.ble.bluetooth" id="1067962328%2FPackages%2F-261839533" data-filterable-set=":mobileblesdk:dokkaHtml/release"></a>
Expand All @@ -100,7 +103,29 @@ <h2 class="">Packages</h2>
</div>
</div>
</div>
<div></div>
<div><span class="brief-comment"><a data-name="1067962328%2FPackages%2F-261839533" anchor-label="tedee.mobile.sdk.ble.bluetooth" id="1067962328%2FPackages%2F-261839533" data-filterable-set=":mobileblesdk:dokkaHtml/release"></a>
<p class="paragraph">This package contains main classes and interfaces for Tedee Mobile SDK for Android used to maintain devices added to an account.</p>
</span></div>
</div>
</div>
<a data-name="882024891%2FPackages%2F-261839533" anchor-label="tedee.mobile.sdk.ble.bluetooth.adding" id="882024891%2FPackages%2F-261839533" data-filterable-set=":mobileblesdk:dokkaHtml/release"></a>
<div class="table-row" data-filterable-current=":mobileblesdk:dokkaHtml/release" data-filterable-set=":mobileblesdk:dokkaHtml/release">
<div>
<div class="main-subrow ">
<div class=""><span class="inline-flex">
<div><a href="mobileblesdk/tedee.mobile.sdk.ble.bluetooth.adding/index.html">tedee.mobile.sdk.ble.bluetooth.adding</a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="882024891%2FPackages%2F-261839533"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div class="pull-right">
<div class="platform-tags no-gutters">
<div class="platform-tag jvm-like">androidJvm</div>
</div>
</div>
</div>
<div><span class="brief-comment"><a data-name="882024891%2FPackages%2F-261839533" anchor-label="tedee.mobile.sdk.ble.bluetooth.adding" id="882024891%2FPackages%2F-261839533" data-filterable-set=":mobileblesdk:dokkaHtml/release"></a>
<p class="paragraph">This package contains classes and interfaces for adding lock to account. This includes unsecure connecting to the lock, getting all needed data from the lock (like firmware version, device settings, and signature), and registering the device.</p>
</span></div>
</div>
</div>
<a data-name="1138397554%2FPackages%2F-261839533" anchor-label="tedee.mobile.sdk.ble.bluetooth.error" id="1138397554%2FPackages%2F-261839533" data-filterable-set=":mobileblesdk:dokkaHtml/release"></a>
Expand All @@ -118,7 +143,9 @@ <h2 class="">Packages</h2>
</div>
</div>
</div>
<div></div>
<div><span class="brief-comment"><a data-name="1138397554%2FPackages%2F-261839533" anchor-label="tedee.mobile.sdk.ble.bluetooth.error" id="1138397554%2FPackages%2F-261839533" data-filterable-set=":mobileblesdk:dokkaHtml/release"></a>
<p class="paragraph">Here, you will find all possible errors that you could encounter.</p>
</span></div>
</div>
</div>
<a data-name="1741079407%2FPackages%2F-261839533" anchor-label="tedee.mobile.sdk.ble.extentions" id="1741079407%2FPackages%2F-261839533" data-filterable-set=":mobileblesdk:dokkaHtml/release"></a>
Expand All @@ -136,7 +163,9 @@ <h2 class="">Packages</h2>
</div>
</div>
</div>
<div></div>
<div><span class="brief-comment"><a data-name="1741079407%2FPackages%2F-261839533" anchor-label="tedee.mobile.sdk.ble.extentions" id="1741079407%2FPackages%2F-261839533" data-filterable-set=":mobileblesdk:dokkaHtml/release"></a>
<p class="paragraph">Discover some useful extensions for manipulating byte data.</p>
</span></div>
</div>
</div>
<a data-name="-730286724%2FPackages%2F-261839533" anchor-label="tedee.mobile.sdk.ble.keystore" id="-730286724%2FPackages%2F-261839533" data-filterable-set=":mobileblesdk:dokkaHtml/release"></a>
Expand All @@ -154,7 +183,9 @@ <h2 class="">Packages</h2>
</div>
</div>
</div>
<div></div>
<div><span class="brief-comment"><a data-name="-730286724%2FPackages%2F-261839533" anchor-label="tedee.mobile.sdk.ble.keystore" id="-730286724%2FPackages%2F-261839533" data-filterable-set=":mobileblesdk:dokkaHtml/release"></a>
<p class="paragraph">Assistance with generating and managing key pairs from the keystore are provided in this package.</p>
</span></div>
</div>
</div>
<a data-name="935213203%2FPackages%2F-261839533" anchor-label="tedee.mobile.sdk.ble.model" id="935213203%2FPackages%2F-261839533" data-filterable-set=":mobileblesdk:dokkaHtml/release"></a>
Expand All @@ -172,7 +203,9 @@ <h2 class="">Packages</h2>
</div>
</div>
</div>
<div></div>
<div><span class="brief-comment"><a data-name="935213203%2FPackages%2F-261839533" anchor-label="tedee.mobile.sdk.ble.model" id="935213203%2FPackages%2F-261839533" data-filterable-set=":mobileblesdk:dokkaHtml/release"></a>
<p class="paragraph">Contained within are the public model classes used for our API.</p>
</span></div>
</div>
</div>
<a data-name="-541364178%2FPackages%2F-261839533" anchor-label="tedee.mobile.sdk.ble.permissions" id="-541364178%2FPackages%2F-261839533" data-filterable-set=":mobileblesdk:dokkaHtml/release"></a>
Expand All @@ -190,7 +223,9 @@ <h2 class="">Packages</h2>
</div>
</div>
</div>
<div></div>
<div><span class="brief-comment"><a data-name="-541364178%2FPackages%2F-261839533" anchor-label="tedee.mobile.sdk.ble.permissions" id="-541364178%2FPackages%2F-261839533" data-filterable-set=":mobileblesdk:dokkaHtml/release"></a>
<p class="paragraph">Find permission utilities here that can aid in obtaining the necessary permissions.</p>
</span></div>
</div>
</div>
</div>
Expand Down
Loading

0 comments on commit b4da576

Please sign in to comment.