author	title	date	status
Cora Middleton	AferoSwiftSDK	2023-April-20	1.6.0

AferoSwiftSDK

An SDK for interacting with the Afero service and peripheral platform.

AferoSwiftSDK

LICENSE

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Required Environment

XCode 14

AferoSwiftSDK supports Swift versions 5+, and Xcode versions 13 and 14, and iOS 11.0+.

GitHub

AferoSwiftSDK is hosted in source format on GitHub; partners are provided read-only access. In addition, for compatibility with CocoaPods installation, the user must configure their GitHub account for password-less authentication at the command line. GitHub provides a number of methods for accomplishing this, including SSH Keys and Personal Access Tokens.

Cocoapods

AferoSwiftSDK and AferoIOSSofthub are provided as CocoaPods, and have been tested with CocoaPods version 1.11.3 and earlier.

Getting Started

Configure your Podfile

Before developing with AferoSwiftSDK, a workspace's Podfile must be configured to integrate it:

# Reference the Afero SDK
    source 'git@github.com:aferodeveloper/Podspecs.git'

    # Explicitly reference the master CocoaPods repo.
    source 'https://github.com/CocoaPods/Specs.git'

    platform :ios, '9.3'
    use_frameworks!

    ...

    pod 'AferoSwiftSDK/AFNetworking', '1.2.2'

Update/Install Pods

Once configured, the developer may run pod update, which will integrate AferoSwiftSDK and any prerequisite packages into their project.

Import Afero

Once integrated, AferoSwiftSDK introduces the Afero module into a workspace. Each file which requires access to AferoSwiftSDK symbols will need to import the module, as such:

    //
    //  ViewController.swift
    //  MyApp
    //
    //  Created by Joe Britt on 3/17/19.
    //  Copyright © 2019 Afero, Inc. All rights reserved.
    // 
    import UIKit
    import Afero // Minimum requirement

    // Optional (but often necessary)
    import ReactiveSwift // Necessary for referring to Reactive symbols (signals, sinks)
    import PromiseKit // Necessary for referring to Promises (Futures)

Example App

Included with AferoSwiftSDK is the AferoLab example app, in //AferoSwiftSDK/Examples. The app provides an Afero client that allows a user to:

Create accounts, sign in, sign out, and change/reset passwords.
List, add, and remove devices.
Interact with device attributes.
Run the Afero Softhub.
Configure Wi-Fi on Wi-Fi-capable devices.

Title/Link	Description
Softhub	Afero Softhub Usage
REST API Client	Describes interaction with the Afero Cloud REST API.
Push Notifications	Documents use of DeviceRules to implement push notifications for Afero device state changes.
SofthubMinder	Example code for managing softhub state vis á vis UIApplication lifecycle.

Colophon

This document was created using a combination of Github-Flavored Markdown, Mermaid for sequence diagrams, and PlantUML for UML.

Creation was done in Atom, with rendered output created using markdown-preview-enhanced.

aferodeveloper/AferoSwiftSDK