Skip to content

Latest commit

 

History

History
executable file
·
95 lines (58 loc) · 3.84 KB

README.md

File metadata and controls

executable file
·
95 lines (58 loc) · 3.84 KB
Raw

OpenXC-iOS-Library

CI Status Version License Platform

OpenXC-iOS-Library

This framework is part of the OpenXC project. This iOS framework contains the tools required to read vehicle data from the vehicle's CAN bus through the OpenXC vehicle interface in any iOS application.

OpenXC iOS framework for use with the C5 BLE device. To run the example project, clone the repo, and run pod install from the Example directory first.

OpenXC-iOS-Library-Version

  • V7.0.0

Supported versions:

  • iOS - up to 15.0
  • XCode - up to 13.3
  • Swift - Swift 5

Note: TravisCI build run will work only till XCode 10.2 -iOS 12.0 (travis-ci/travis-ci#7031) but the framework supports XCode 10.2 and iOS 12

Using the Framework

The framework can be picked directly from the releases

  • Simulator build - openXCiOSFramework.framework.simulator.zip, ProtocolBuffers.framework.simulator.zip
  • Device build - openXCiOSFramework.framework.device.zip, ProtocolBuffers.framework.device.zip

Building from XCode

Make sure you have XCode10 installed with iOS11 to build it from XCode. This framework must be included in any iOS application that needs to connect to a VI

Refer to this document for more details on installation and usage.

API usage details are available here.

Also see Step by Step Guide to build framework.

Tests

  • to be added

Building from Command Line

The project requires XCode, XCode command line tools installed.

To install XCode command line tools, follow these steps for XCode:

  • Launch XCode
  • Go to Preferences - Locations - Command Line Tools - Install
  • Open "Terminal" and change directory to framework
  • Run - xcodebuild clean build test -project openxc-ios-framework.xcodeproj -scheme openxc-ios-framework

Releasing the App and Library

  • Update CHANGELOG.mkd
  • Merge into master push to GitHub
  • Update OpenXC in CocoaPods:
    • Update s.version in openxcframework.podspec
    • Follow the instructions in step #7 here.
    • When pushing to the specs repository, you must register your session first: $pod trunk register [email protected] 'Your Name'
    • The email address must belong to an owner of the pod
  • Go to https://github.com/openxc/openxc-ios-library/releases and promote the tag you just created to a new release - copy and paste the changelog into the description. Note that the tag was already created in the CocoaPods section above.

Contributing

Please see our Contribution Documents

Example

To run the example project, clone the repo, and run pod install from the Example directory first.

Requirements

Installation

openxcframework is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod 'openxcframework'

Author

kranjanford, [email protected]

License

openxcframework is available under the MIT license. See the LICENSE file for more info.

Copyright (c) 2016 Ford Motor Company Licensed under the BSD license.