Predix SDK for Ios

Total Page:16

File Type:pdf, Size:1020Kb

Predix SDK for Ios Predix SDK for iOS © 2020 General Electric Company Contents Predix SDK for iOS Overview 1 Predix SDK for iOS 1 Asset API 1 Authentication API 1 NoSQL Local Database API 2 Offline API 3 Online API 3 PredixUIKit for iOS 3 TimeSeries API 3 Getting Started with SDK for iOS 5 Before You Begin 5 Adding the SDK to Your Project 5 Adding the Module Map 6 ii Predix SDK for iOS Copyright GE Digital © 2020 General Electric Company. GE, the GE Monogram, and Predix are either registered trademarks or trademarks of General Electric Company. All other trademarks are the property of their respective owners. This document may contain Confidential/Proprietary information of General Electric Company and/or its suppliers or vendors. Distribution or reproduction is prohibited without permission. THIS DOCUMENT AND ITS CONTENTS ARE PROVIDED "AS IS," WITH NO REPRESENTATION OR WARRANTIES OF ANY KIND, WHETHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO WARRANTIES OF DESIGN, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE. ALL OTHER LIABILITY ARISING FROM RELIANCE UPON ANY INFORMATION CONTAINED HEREIN IS EXPRESSLY DISCLAIMED. Access to and use of the software described in this document is conditioned on acceptance of the End User License Agreement and compliance with its terms. © 2020 General Electric Company iii Predix SDK for iOS Overview Predix SDK for iOS The Predix SDK for iOS is a powerful software design kit (SDK) to accelerate the development of IIoT applications for Predix using iOS, macOS, tvOS, and watchOS. The overall application development process is simpler and faster with the use of a robust set of APIs that feel natural to a Swift developer. Predix SDK for iOS key features: • Asset API • Authentication API (UAA) • NoSQL Local Database API • Online API • Offline API • TimeSeries API For more information on the Predix SDK for iOS APIs, see the following: • Getting Started Guides • How to Guides • API Documentation Related Reference Before You Begin on page 5 Learn about prerequisites for using the Predix Mobile iOS SDK and find the SDK Download link. Asset API The Predix SDK for iOS Asset API allows your application to access Asset data from the Asset Service available on Predix.io. The SDK provides a simple native Swift API that converts Asset JSON requests and responses into Swift models that make it easier to use, display, and manipulate Asset data from Swift. • Predix SDK for iOS handles authentication with Asset, you simply need to provide the UAA endpoint and Zone ID. • Request data using native Swift objects. • Response data is represented with native Swift objects making it easier to filter, display, and find data that is most critical to your application. For more information on using the Asset API, see the Asset API documentation. Authentication API The Authentication API allows you to authenticate users and your application with the Predix User Account and Authentication (UAA). Authentication API includes: • Native authentication using User Credentials • WebView authentication using Authorization Code Grant • RefreshToken authentication using Biometrics (TouchID and FaceID) • Client Credential authentication for applications that do not use a Username and Password to protect their applications. © 2020 General Electric Company 1 Supported iOS Features • Native UI login • UIWebView login • WKWebView login • SafariViewController login • SFAuthenticationSession Support for Biometric Authentication - The SDK works with TouchID and FaceID out of the box. You can simply tell the Authentication API that you want to use biometric authentication and the SDK does the work for you. Privacy for User Credentials - The SDK respects user privacy and never stores the Usernames and Passwords. All tokens are secured in Apple's device Keychain and can only be accessed by the user who stored them. For more information on using the Authentication API, see Using Authentication API to Authenticate a User. NoSQL Local Database API The NoSQL Local Database API allows you to replicate and load balance your data. Following are some key features of the NoSQL Local Database API: Document Database Management - Document management allowing you to write, retrieve, or delete a document from a database. The central concept of the NoSQL database is the "document". The document encapsulates and organizes data in name/value pairs; and it is identified by a system-wide unique identifier (ID). Async Interaction - Async interaction to maximize mobile device resources and UI responsiveness. The PredixSDK Database API is largely asynchronous in nature. The API calls for most document interactions and running queries takes a Swift completion handler closure as a parameter. The closure is called when the requested operation is complete. This is similar to many other APIs within the Apple ecosystem. Note: Developers using the PredixSDK must have a thorough understanding of asynchronous patterns, Google Cloud Datastore (GCD), and Swift closures to enable the maximum performance and responsiveness from their PredixSDK-based applications. Data Replication - Easy set up for data replication and flexibility for many complex data iteration use cases. You can use the PredixSDK Database as a local data store and use it with the PredixSync service to synchronize documents to and from a backend server and to other users. Data replication is a complex task but the Predix system makes it easy to setup and provides flexibility for many complex data iteration use cases. Note: As with any offline data interaction, care must be taken to determine what type of data a user needs when offline. When designing your applications data model, it is important to consider that mobile devices have limited storage capacity and often have limited network bandwidth. A balance must be struck between having enough information to meet the applications use cases, and preventing an application from being too “chatty” or attempting to synchronize large quantities of data. Indexes and Queries - Ability to create indexes of the documents and run queries against those indexes. With indexes and queries, you can enable searches, perform sorting, summarization, and other more relational database-like data interactions. An index consists of a key (the data being indexed) and an optional value (additional data stored with the index). The data in the index is sorted based on a key. Queries can retrieve data from the index by either specifying a list of keys or a range of keys. These keys are simple data types or arrays to provide more complex sorting and retrieval scenarios. 2 © 2020 General Electric Company For more information on using the NoSQL Local Database API, see the Getting Started with the NoSQL Local Database API. Offline API The Offline API allows your application to access critical APIs when there is no internet connectivity. You can use the PredixSDK Database as a local data store, and use it with the PredixSync service to synchronize documents to and from a backend server and/or to other users. • Easy to setup of data replication mechanism • Flexibility for complex data iteration use cases For more information on Offline API, see NoSQL Local Database API Online API The Online API allows you to associate a UAA authentication session to a network request. Based on this association, the SDK manages the bearer token and populates the authorization header for you. This allows you to focus on your application logic and relieves you from the additional stress of managing the bearer token for your network requests to Predix Services. Online API includes: • Requests to Predix services or server-side apps automatically populate the bearer token for you. • Trace IDs are automatically generated allowing you to trace and diagnose a request using tools like Splunk. For more information on using Online API, see Using the Online API to make Network Requests PredixUIKit for iOS The PredixUIKit for iOS is a framework of data visualization components based on Predix Design System and some common visualization components. When used with Predix SDK for iOS, the PredixUIKit allows you to utilize the available data visualization components to accelerate the overall application development process. You can use the PredixUIKit for iOS to display your data stored in Predix Cloud with very minimal coding. The Predix UI components of the PredixUIKit are open source and are built specifically to work seamlessly with the Predix SDK for iOS. PredixUIKit Features: • Data Visualization • UAA Authentication • Time Series View For more information on PredixUIKit for iOS, see the Getting Started with PredixUIKit TimeSeries API The TimeSeries API allows your application to access Time Series data from the Time Series Service available on Predix.io. The SDK provides a simple native Swift API that converts Time Series JSON © 2020 General Electric Company 3 requests and responses into Swift models that make it easier to use, display, and manipulate Time Series data from Swift. • Predix SDK for iOS handles authentication with Time Series, you simply need to provide the UAA endpoint and Zone ID. • Request data using native Swift objects. • Response data is represented with native Swift objects making it easier to filter, display, and find data that is most critical to your application. For more information on using the TimeSeries API, see Using the TimeSeries API to Fetch Time Series Data 4 © 2020 General Electric Company Getting Started with SDK for iOS Before You Begin Learn about prerequisites for using the Predix Mobile iOS
Recommended publications
  • Zebra Scanner SDK for Ios Developer Guide (En)
    ZEBRA SCANNER SDK for iOS DEVELOPER GUIDE ZEBRA SCANNER SDK for iOS DEVELOPER GUIDE MN001834A04 Revision A July 2019 ii Zebra Scanner SDK for iOS Developer Guide No part of this publication may be reproduced or used in any form, or by any electrical or mechanical means, without permission in writing from Zebra. This includes electronic or mechanical means, such as photocopying, recording, or information storage and retrieval systems. The material in this manual is subject to change without notice. The software is provided strictly on an “as is” basis. All software, including firmware, furnished to the user is on a licensed basis. Zebra grants to the user a non-transferable and non-exclusive license to use each software or firmware program delivered hereunder (licensed program). Except as noted below, such license may not be assigned, sublicensed, or otherwise transferred by the user without prior written consent of Zebra. No right to copy a licensed program in whole or in part is granted, except as permitted under copyright law. The user shall not modify, merge, or incorporate any form or portion of a licensed program with other program material, create a derivative work from a licensed program, or use a licensed program in a network without written permission from Zebra. The user agrees to maintain Zebra’s copyright notice on the licensed programs delivered hereunder, and to include the same on any authorized copies it makes, in whole or in part. The user agrees not to decompile, disassemble, decode, or reverse engineer any licensed program delivered to the user or any portion thereof.
    [Show full text]
  • Iphone Ios 5 Development Essentials
    iPhone iOS 5 Development Essentials i iPhone iOS 5 Development Essentials – First Edition ISBN-13: 978-1466337275 © 2011 Neil Smyth. All Rights Reserved. This book is provided for personal use only. Unauthorized use, reproduction and/or distribution strictly prohibited. All rights reserved. The content of this book is provided for informational purposes only. Neither the publisher nor the author offers any warranties or representation, express or implied, with regard to the accuracy of information contained in this book, nor do they accept any liability for any loss or damage arising from any errors or omissions. This book contains trademarked terms that are used solely for editorial purposes and to the benefit of the respective trademark owner. The terms used within this book are not intended as infringement of any trademarks. Rev 2.3p ii Table of Contents Preface ............................................................................................................................................................... xix 1. About iPhone iOS 5 App Development Essentials .............................................................................................. 1 1.1 Example Source Code ................................................................................................................................... 2 1.2 Feedback ...................................................................................................................................................... 2 2. The Anatomy of an iPhone 4S ...........................................................................................................................
    [Show full text]
  • Ios SDK Release Notes for Ios 8.0 Beta 5
    iOS SDK Release Notes for iOS 8.0 Beta 5 Important: This is a preliminary document for an API or technology in development. Apple is supplying this information to help you plan for the adoption of the technologies and programming interfaces described herein for use on Apple‑branded products. This information is subject to change, and software implemented according to this document should be tested with final operating system software and final documentation. Newer versions of this document may be provided with future betas of the API or technology. Contents: Introduction Bug Reporting Notes and Known Issues Introduction iOS SDK 8.0 provides support for developing iOS apps. It is packaged with a complete set of Xcode tools, compilers, and frameworks for creating apps for iOS and OS X. These tools include the Xcode IDE and the Instruments analysis tool, among many others. With this software you can develop apps for iPhone, iPad, or iPod touch running iOS 8. You can also test your apps using the included iOS Simulator, which supports iOS 8. iOS SDK 8.0 requires a Mac computer running OS X v10.9.3 (Mavericks) or later. This version of iOS is intended for installation only on devices registered with the Apple Developer Program. Attempting to install this version of iOS in an unauthorized manner could put your device in an unusable state. For more information and additional support resources, visit http://developer.apple.com/programs/ios/. Bug Reporting For issues not mentioned in the Notes and Known Issues section, please file bugs through the Apple Developer website (https://developer.apple.com/bug‑reporting/ios/).
    [Show full text]
  • Using MBS Plugin with Filemaker Ios SDK
    Using MBS Plugin with FileMaker iOS SDK As some new people play with FileMaker's iOS SDK and our MBS Plugin, here a few steps to give you an easier start: • Get iOSAppSDKPackage_16.0.1.tbz on the iOS App SDK webpage from FileMaker's community benefits. • Unpack the archive. • Open Terminal, cd to the folder of the app sdk. For me this command line: • cd /Users/cs/Desktop/iOSAppSDKPackage_16.0.1 • Run the makeprojdir command giving a folder name, the app name and the identifier: • ./makeprojdir test test de.monkeybreadsoftware.test • Of course you use your own names and bundle id. • Open test project in Xcode • In the target popup menu you can select a simulated device and when you run the app. The section for installed plugins will be empty. Congratulations, now the app should run in simulator! If you have trouble till here, maybe you review the iOS App SDK 16 Guide. • Now you can drag & drop the plugin into the plugins section in the Xcode project right in the Custom Application Resources folder. • Run the app again and it should show the plugin listed with version. Now you can use the plugin in your scripts for the solution and test in the simulator. If the plugin is not visible, please check logs and see if some error occurred. Please use MBS("Trace") command to write all plugin calls to the log in Xcode, so you spot errors easier. • Next you can change target to be your iPhone and run the app on the iPhone. This may need some code signing things and an Apple ID registered for developing.
    [Show full text]
  • Ios SDK Release Notes for Ios 9 Beta 3
    8/7/2015 iOS 9 Release Notes iOS SDK Release Notes for iOS 9 Beta 3 Important: This is a preliminary document for an API or technology in development. Apple is supplying this information to help you plan for the adoption of the technologies and programming interfaces described herein for use on Apple‑branded products. This information is subject to change, and software implemented according to this document should be tested with final operating system software and final documentation. Newer versions of this document may be provided with future betas of the API or technology. Contents: Introduction Bug Reporting Autosubmission of Diagnostic and Usage Data Notes and Known Issues Introduction iOS SDK 9.0 provides support for developing iOS apps. It is packaged with a complete set of Xcode tools, compilers, and frameworks for creating apps for iOS and OS X. These tools include the Xcode IDE and the Instruments analysis tool, among many others. With this software you can develop apps for iPhone, iPad, or iPod touch running iOS 9. You can also test your apps using the included Simulator, which supports iOS 9. iOS SDK 9.0 requires a Mac computer running OS X v10.10.3 (Yosemite) or later. This version of iOS is intended for installation only on devices registered with the Apple Developer Program. Attempting to install this version of iOS in an unauthorized manner could put your device in an unusable state. For more information and additional support resources, visit http://developer.apple.com/programs/ios/. Bug Reporting For issues not mentioned in the Notes and Known Issues section, please file bugs through the Apple Developer website (https://developer.apple.com/bug‑reporting/ios/).
    [Show full text]
  • Building the Ios Wrapper Version 1.3.0+
    Building The iOS Wrapper Version 1.3.0+ Contents Introduction.................................................................................................................................................... 2 Setting Up The Build Environment ................................................................................................................ 2 Install xCode .............................................................................................................................................. 2 Set Up Code Signing Requirements ......................................................................................................... 2 Certificates ............................................................................................................................................. 3 Identifiers ............................................................................................................................................... 4 Devices .................................................................................................................................................. 5 Provisioning Profile ................................................................................................................................ 5 Open The Project ...................................................................................................................................... 6 Configuring The App ....................................................................................................................................
    [Show full text]
  • Ios 7 App Development Essentials
    i iOS 7 App Development Essentials ii iOS 7 App Development Essentials – First Edition ISBN-13: 978-0-9860273-5-2 © 2013 Neil Smyth/eBookFrenzy. All Rights Reserved. This book is provided for personal use only. Unauthorized use, reproduction and/or distribution strictly prohibited. All rights reserved. The content of this book is provided for informational purposes only. Neither the publisher nor the author offers any warranties or representation, express or implied, with regard to the accuracy of information contained in this book, nor do they accept any liability for any loss or damage arising from any errors or omissions. This book contains trademarked terms that are used solely for editorial purposes and to the benefit of the respective trademark owner. The terms used within this book are not intended as infringement of any trademarks. Rev 1. 0 iii Table of Contents 1. Start Here ............................................................................................................................... 1 1.1 For New iOS Developers ......................................................................................................... 2 1.2 For iOS 6 Developers .............................................................................................................. 3 1.3 Source Code Download .......................................................................................................... 4 1.4 Feedback ...............................................................................................................................
    [Show full text]
  • MAD Week 1 Ios Intro.Pptx
    Mobile Applicaon Development Aileen Pierce IPHONE & IPAD APPLICATION DEVELOPMENT OVERVIEW Introduc,on • iOS overview • So:ware Development Kit (SDK) Components • Downloading the iOS SDK iOS • iOS is the Operang System that runs on the iPhone, iPad, and iPod Touch (iOS devices) – Objec,ve-C programming language – Frameworks SDK • The iOS SDK has all the tools and applicaons needed to develop apps for iOS • The SDK is installed on the laptops in ATLAS • You will need to download and install the SDK on your Mac • iOS Dev Center hLp://developer.apple.com/ – Register as an Apple Developer – Join the Developer Program – Download the iOS SDK from the Mac App store Developer Programs • Free program – Can’t run it on a device – Can’t submit it to the app store • University Program – Invitaon only – Can run on a device (good for tes,ng) – Can’t submit it to the app store • $99 Standard Program – Allows you to distribute your apps in the Apple App Store SDK • hLp://developer.apple.com/devcenter/ios • Downloads • Xcode 4 and iOS SDK 5.1 – Xcode 4 requires Lion Mac OSX 10.7 or later • We will be staying on this version all semester, do NOT upgrade during the semester SDK Components • Xcode – Integrated Development Environment (IDE) to create and manage development projects – Interface Builder • Tool to build your applicaon user interfaces • Frameworks – So:ware libraries that provide specific func,onality • Simulator – Simulates running your apps on your Mac • Instruments – Gather and analyze data on your apps behavior iOS Development Center • Explore all the resources available in the development center • iOS Reference Library – Geng started documents – Reference documents – Sample code • Videos • Forums For Thursday • Download and install the iOS SDK on your Mac • Explore the iOS Development Center • Play with an iPhone and iPad if you’re not familiar with them (hey, it could happen) .
    [Show full text]
  • Final Readme Xcode 4.2 for Lion
    Xcode 4.2 Includes SDKs for Mac OS X 10.7 Lion and iOS 5 Contents Introduction About SDKs Installation Deprecation Notice Introduction Xcode is the complete developer toolset for creating applications for Mac, iPhone, and iPad. This package installs the Xcode IDE, the Instruments analysis tool, iOS Simulator, and OS framework bundles in the form of Mac OS X SDKs and iOS SDKs. What’s New in Xcode 4.2 for Lion • Support for Mac OS X 10.7 Lion and iOS SDK 5 • Apple LLVM compiler 3.0 with Automatic Reference Counting (ARC) • Storyboarding support in Interface Builder to design multi-view workflows for iOS • OpenGL ES graphical debugger within the main Xcode debugging interface • LLVM compiler support for C++’0x features using the new LLVM libc++ standard library • Additional bug fixes, stability, and performance improvements What’s New in Xcode 4 • Xcode 4 has a brand new, single window interface for all major workflows • Interface Builder is now integrated within the main Xcode IDE • Assistant shows a paired editor with complementary files, e.g.: header or UI controller • Live Issues display coding errors as you type, and Fix-it can correct the mistake for you Compatibility: Xcode 4 requires an Intel-based Mac running Mac OS X 10.7.0 Lion or later, and includes Mac OS X SDK 10.7 and 10.6, and iOS SDK 5. To develop apps targeting prior versions of Mac OS X or iOS, see the section titled About SDKs and the iOS Simulator below. Developer Resources: The Mac and iOS Developer Programs provide access to the App Store, additional support and documentation, as well as provisioning resources to enable testing and deployment on an iPhone, iPod touch, or iPad device.
    [Show full text]
  • Iphone Ios 6 Development Essentials
    i iPhone iOS 6 Development Essentials ii iPhone iOS 6 Development Essentials – First Edition ISBN-13: 978-1479211418 © 2012 Neil Smyth. All Rights Reserved. This book is provided for personal use only. Unauthorized use, reproduction and/or distribution strictly prohibited. All rights reserved. The content of this book is provided for informational purposes only. Neither the publisher nor the author offers any warranties or representation, express or implied, with regard to the accuracy of information contained in this book, nor do they accept any liability for any loss or damage arising from any errors or omissions. This book contains trademarked terms that are used solely for editorial purposes and to the benefit of the respective trademark owner. The terms used within this book are not intended as infringement of any trademarks. Rev 1.0 iii Table of Contents 1. Start Here .......................................................................................................................................................... 1 1.1 For New iOS Developers ...................................................................................................................................... 1 1.2 For iOS 5 Developers ........................................................................................................................................... 1 1.3 Source Code Download ....................................................................................................................................... 2 1.4 Feedback ............................................................................................................................................................
    [Show full text]
  • Apple® Ios SDK – Objective-C
    Getting Started with Apple® iOS Development – Apple® iOS SDK – Objective-C A Zebra Technologies Application Note 2 Overview This document describes the end to end process of designing, packaging, deploying and running an Apple® iPhone/iPod application using the ZebraLink SDK The sample code used in this guide is from the MyFirstZebraApp sample code article. Target Audience The information delivered in this document assumes the reader has reasonable technical competence covering Apple®iOS environment, core programming concepts and rationales. System Prerequisites You must install all the system prerequisites listed in this section. Note: The default installation options for all these prerequisites are satisfactory. MAC OS X Unlike development for other mobile device environments, development for Apple®iOS based mobile devices must be conducted on Mac OS X. Refer to Mac OS X. XCode and iOS SDK XCode is the development environment for apps that run on the Apple® iOS operating system. For more information and to download links, refer to for XCode and the iOS SDK. Zebra Multiplatform SDK The ZebraLink for Apple® iOS digital devices SDK contains all the required components to develop applications for Zebra label printers. The SDK includes the header files to scan for and connect to network based Zebra label printers. For more information, including system prerequisites and downloads, refer to ZebraLink SDK, A Zebra Technologies Application Note 3 Zebra Network-Enabled Label Printer In order to fully test the application that you create, you must have a network-enabled Zebra printer capable of understanding ZPL. For more information, refer to Zebra label printers. Apple® iOS Device While the Apple® iOS simulator included in the XCode toolkit satisfies most of the anticipated requirements for developing with Apple® iOS, we recommend that you test all of your development with a physical device.
    [Show full text]
  • Internal Structure of Ios and Building Tools for Ios Apps
    International Journal Of Computer Science And Applications Vol. 6, No.2, Apr 2013 ISSN: 0974-1011 (Open Access) Available at: www.researchpublications.org Internal structure of iOS and Building tools for iOS apps Miss Priyanka V. Kanoi Miss Payal N. ingole 2nd yr Information and Technology 3rd yr Computer sc and Engineering JDIET , Yavatmal JDIET, Yavatmal [email protected] [email protected] operating system: "iPhone OS".In June 2010, Apple rebranded Abstract : iOS is world’s most advanced operating system. With iPhone OS as "iOS". The trademark "IOS" had been used by its easy-to-use interface, amazing features, and rock-solid Cisco for over a decade for its operating system, IOS, used on stability, iOS is the foundation of iPhone, iPad, and iPod touch. It its routers. To avoid any potential lawsuit, Apple licensed the is the most user friendly operating system. With better GUI "IOS" trademark from Cisco. Apple provides major updates to performance. iOS consists of four layers – cocoa touch layer, the iOS operating system approximately once a year over media layer, core service layer, core OS layer. Some of the developmental tools used for preparing iOS apps include iTunes and also, since iOS version 5.0, over the air. The latest XCODE, Instruments and developer library. With thousands of major update is iOS 6, publicly announced on June 11, 2012 apps in practically every category, iOS is the platform for the and released on September 12, 2012. Over 200 new features world’s largest collection of mobile apps. And every app starts debut in iOS 6, including Apple's new Passbook service, with the right DNA.
    [Show full text]