Skip to content

Commit

Permalink
Release 1.5.0
Browse files Browse the repository at this point in the history
  • Loading branch information
oleksii-frolov committed Jul 10, 2015
2 parents 8d76e62 + 65da646 commit 7fc7030
Show file tree
Hide file tree
Showing 15 changed files with 273 additions and 132 deletions.
4 changes: 4 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,7 @@
path = core
url = https://github.com/ConnectSDK/Connect-SDK-Android-Core.git
branch = master
[submodule "modules/firetv"]
path = modules/firetv
url = https://github.com/ConnectSDK/Connect-SDK-Android-FireTV.git
branch = master
18 changes: 18 additions & 0 deletions AUTHORS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,21 @@
Ibrahim Adnan -- [GitHub](https://github.com/iadnan) | [Twitter](https://twitter.com/ibrahimadnan)

iOS SDK, iOS sample apps, documentation

---

Eugene Nikolskyi -- [GitHub](https://github.com/eunikolsky)

iOS SDK, iOS sample apps, documentation

---

Oleksii Frolov -- [GitHub](https://github.com/frolov-alexey)

Android SDK, Android sample apps, documentation

---

Henry Levak -- [GitHub](https://github.com/henrylevak) | [Twitter](http://www.twitter.com/HenryLevak)

Product Manager, Provider of Bubble Teas
Expand Down
6 changes: 3 additions & 3 deletions AndroidManifest.xml
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
package="com.connectsdk"
android:versionCode="10"
android:versionName="1.4.4" >
android:versionCode="11"
android:versionName="1.5.0" >

<uses-sdk
android:minSdkVersion="10"
android:targetSdkVersion="10" />
android:targetSdkVersion="22" />

<application />
</manifest>
19 changes: 17 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,28 @@
# Connect SDK Android Changelog

## 1.5.0 -- 09 Jul 2015

- Added Amazon Fling SDK support to play and control media on Fire TV devices
- Added playlist support for WebOS TVs
- Added media player loop capability for WebOS TVs
- Added feature to pin web apps on WebOS TVs
- Extended play state subscription to handle media playback errors on WebOS TVs
- Fixed launching input picker for new versions of WebOS TVs
- Fixed discovery for Chromecast
- Deprecated old media player methods
- Miscellaneous bug fixes
- [See commits between 1.4.4 and 1.5.0](https://github.com/ConnectSDK/Connect-SDK-Android/compare/1.4.4...1.5.0)

[View files at version 1.5.0](https://github.com/ConnectSDK/Connect-SDK-Android/tree/1.5.0)

## 1.4.4 -- 29 Apr 2015

- Added LG Music Flow speaker support (Google Cast for Audio and DLNA)
- Added AirPlay pin mode support
- Added pairing type for DeviceService
- Replaced DefaultHttpClient with HttpURLConnection
- Added a new exception class - NotSupportedServiceCommandError
- Fixed DLNA subscribtion methods
- Fixed DLNA subscription methods
- Fixed lint warnings
- Miscellaneous bug fixes
- [See commits between 1.4.3 and 1.4.4](https://github.com/ConnectSDK/Connect-SDK-Android/compare/1.4.3...1.4.4)
Expand All @@ -19,7 +34,7 @@
- Reverted Roku 6.1 fix for playing video as Roku has fixed its media player
- Added proper encoding of special characters for metadata in DLNAService
- Added getPlayState implementation into AirPlayService
- Implemeted sending number key for NetcastTV
- Implemented sending number key for NetcastTV
- Miscellaneous bug fixes
- [See commits between 1.4.2 and 1.4.3](https://github.com/ConnectSDK/Connect-SDK-Android/compare/1.4.2...1.4.3)

Expand Down
22 changes: 8 additions & 14 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Please do not use GitHub issues for general questions about the SDK. Instead, use any of the following services to reach out to the development team.

- [@ConnectSDK](https://twitter.com/ConnectSDK)
- [Stack Overflow TV Tag](http://www.stackoverflow.com/tags/tv)
- Stack Overflow: [Connect-SDK tag](https://stackoverflow.com/tags/connect-sdk) (or [TV tag](https://stackoverflow.com/tags/tv))
- [[email protected]](mailto:[email protected])

##Versioning
Expand All @@ -14,17 +14,7 @@ We use [semantic versioning](http://semver.org/) in our tagged releases.

##Branching Strategy

- master
+ latest stable, QA'd, tagged release of the SDK
+ assume that this is safe for production use
- sdk_MAJOR.MINOR
+ stable branch working towards the next major/minor/patch release
+ safe for checking out new features, but do not use in any production apps
- sdk_MAJOR.MINOR-dev
+ unstable development branch working towards the next major/minor/patch release
+ may not compile/run without errors
+ for development only
+ submit pull requests against this branch
We use the [successful git branching model](http://nvie.com/posts/a-successful-git-branching-model/), except without release branches, and the `develop` branch is named `dev`.

##Bug Reports & Feature Requests

Expand All @@ -36,11 +26,15 @@ If you experience a crash, please attach your symbolicated crash log or stack tr

##Pull Requests

If you would like to submit code, please fork the repository on GitHub and develop on the latest sdk-X.Y-dev branch. We do not accept pull requests on the master branch, as we only merge QA'd & tagged code into the master branch. See the description of our branching strategy above.
If you would like to submit code, please fork the repository on GitHub and develop in a feature branch, created from the latest `dev` commit. We do not accept pull requests on the `master` branch, as we only merge QA'd and tagged code into the `master` branch.

###Tests

Please include unit tests for the new/changed functionality with your pull request. It will help to verify the code is working as designed and make sure there are no regressions in future releases.

###Use of third party libraries

Connect SDK does include some third party libraries, but we try to avoid using them. If you'd like to integrate a library with a pull request, make sure that library has an open source license (MIT, Apache 2.0, etc).
Connect SDK includes some third party libraries. If you'd like to integrate a library with a pull request, make sure that library has an open source license (MIT, Apache 2.0, etc).

###Licensing

Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@ Apache License
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright (c) 2013-2014 LG Electronics.
Copyright (c) 2013-2015 LG Electronics.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down
111 changes: 45 additions & 66 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
#Connect SDK Android
Connect SDK is an open source framework that connects your mobile apps with multiple TV platforms. Because most TV platforms support a variety of protocols, Connect SDK integrates and abstracts the discovery and connectivity between all supported protocols.
This project can be built in Android Studio or directly with Gradle. Eclipse IDE is not supported since 1.5.0 version.

For more information, visit our [website](http://www.connectsdk.com/).

Expand All @@ -12,25 +13,32 @@ This project has the following dependencies, some of which require manual setup.

This project has the following dependencies.
* [Connect-SDK-Android-Core](https://github.com/ConnectSDK/Connect-SDK-Android-Core) submodule
- Requires [Java-WebSocket library](https://github.com/TooTallNate/Java-WebSocket)
- Requires [jmDNS library](https://github.com/openhab/jmdns)
* [Connect-SDK-Android-Google-Cast](https://github.com/ConnectSDK/Connect-SDK-Android-Google-Cast) submodule
- Requires [GoogleCast.framework](https://developers.google.com/cast/docs/downloads)
* [Java-WebSocket library](https://github.com/TooTallNate/Java-WebSocket)
* [Connect-SDK-Android-FireTV](https://github.com/ConnectSDK/Connect-SDK-Android-FireTV) submodule
- Requires [AmazonFling.framework](https://developer.amazon.com/public/apis/experience/fling/docs/amazon-fling-sdk-download)

##Including Connect SDK in your app with Android Studio
Edit your project's build.gradle to add this in the "dependencies" section
```groovy
dependencies {
//...
compile 'com.connectsdk:connect-sdk-android:1.4.+'
compile 'com.connectsdk:connect-sdk-android:1.5.0'
}
```
This prebuilt library doesn't have Amazon Fling SDK support, because it’s not available on maven. You need to set the project up from sources
if you want to have Amazon Fling SDK support.

##Including Connect SDK in your app with Android Studio from sources
1. Open your terminal and execute these commands
- cd your_project_folder
- git clone https://github.com/ConnectSDK/Connect-SDK-Android.git
- cd Connect-SDK-Android
- git submodule init
- git submodule update
```
cd your_project_folder
git clone https://github.com/ConnectSDK/Connect-SDK-Android.git
cd Connect-SDK-Android
git submodule update --init
```

2. On the root of your project directory create/modify the settings.gradle file. It should contain something like the following:
```groovy
Expand All @@ -45,33 +53,9 @@ dependencies {
}
```

4. Sync project with gradle files
5. Add permissions to your manifest

##Including Connect SDK in your app with Eclipse

1. Clone repository (or download & unzip)
2. Set up the submodules by running the following commands in Terminal
- `git submodule init`
- `git submodule update`
3. Open Eclipse
4. Click File > Import
5. Select `Existing Android Code Into Workspace` and click `Next`
6. Browse to the `Connect-SDK-Android` project folder and click `Open`
7. Check all projects and click `Finish`
8. Follow the setup instructions for each of the service submodules
- [Connect-SDK-Android-Google-Cast](https://github.com/ConnectSDK/Connect-SDK-Android-Google-Cast)
9. Right-click the `Connect-SDK-Android-Core` project and select `Properties`, in the `Library` pane of the `Android` tab add
- Connect-SDK-Android
10. Right-click the `Connect-SDK-Android-Google-Cast` project and select `Properties`, in the `Library` pane of the `Android` tab add following libraries
- Connect-SDK-Android-Core
- android-support-v7-appcompat
- android-support-v7-mediarouter
- google-play-services_lib
11. **IN YOUR PROJECT** select `Properties`, in the `Library` pane of the `Android` tab add following libraries
- Connect-SDK-Android-Core
- Connect-SDK-Android-Google-Cast
12. Set up your manifest file as per the instructions below
4. Setup [FireTV submodule](https://github.com/ConnectSDK/Connect-SDK-Android-FireTV)
5. Sync project with gradle files
6. Add permissions to your manifest

###Permissions to include in manifest
* Required for SSDP & Chromecast/Zeroconf discovery
Expand All @@ -97,11 +81,11 @@ This metadata tag is necessary to enable Chromecast support.
```xml
<application ... >
...

<meta-data
android:name="com.google.android.gms.version"
android:value="@integer/google_play_services_version" />

</application>
```

Expand All @@ -112,49 +96,44 @@ Add the following line to your proguard configuration file (otherwise `Discovery
-keep class com.connectsdk.** { * ; }
```

##Migrating from 1.3 to 1.4 release

1. Open terminal and go to your local Connect-SDK-Android repo
2. Pull the latest updates by running command `git pull` in Terminal
3. Set up the submodules by running the following commands in Terminal
- `git submodule init`
- `git submodule update`
4. Open Eclipse
5. Click `File > Import`
6. Select `Existing Android Code Into Workspace` and click `Next`
7. Browse to the `Connect-SDK-Android/core` folder and click `Open` to import core submodule
8. Click `Finish`
9. Do the steps 5-8 for Connect-SDK-Android-Google-Cast which is located in `Connect-SDK-Android/modules/google_cast` folder
10. Right click on `Connect-SDK-Android` project and select `Properties`, in the `Library` pane of the `Android` tab
- remove all libraries references
11. Right-click the `Connect-SDK-Android-Core` project and select `Properties`, in the `Library` pane of the `Android` tab add
- Connect-SDK-Android
12. Right-click the `Connect-SDK-Android-Google-Cast` project and select `Properties`, in the `Library` pane of the `Android` tab add following libraries
- Connect-SDK-Android-Core
- android-support-v7-appcompat
- android-support-v7-mediarouter
- google-play-services_lib
13. **IN YOUR PROJECT** select `Properties`, in the Library pane of the Android tab
- remove Connect-SDK-Android
- add Connect-SDK-Android-Core
- add Connect-SDK-Android-Google-Cast.
###Tests
Connect SDK has unit tests for some parts of the code, and we are continuing to increase the test coverage.
These tests are based on third party libraries such as Robolectric, Mockito and PowerMock. You can easily run these tests with Gradle:
```
gradle test
```
Also the project has a target for generating test coverage report with Jacoco. Use this command for generating it.
```
gradle jacocoTestReport
```
The test coverage report will be in this folder `Connect-SDK-Android/build/reports/jacoco/jacocoTestReport/html`.

##Contact
* Twitter [@ConnectSDK](https://www.twitter.com/ConnectSDK)
* Ask a question with the "tv" tag on [Stack Overflow](http://stackoverflow.com/tags/tv)
* Ask a question on Stack Overflow with the [Connect-SDK tag](https://stackoverflow.com/tags/connect-sdk) (or [TV tag](https://stackoverflow.com/tags/tv))
* General Inquiries [email protected]
* Developer Support [email protected]
* Partnerships [email protected]

##Credits
Connect SDK for Android makes use of the following open-source projects.
Connect SDK for Android makes use of the following projects, some of which are open-source.

* [Amazon Fling SDK](https://developer.amazon.com/fling)
- [Amazon Fling SDK Terms of Service](https://developer.amazon.com/public/support/pml.html)
* [Android-DLNA](https://code.google.com/p/android-dlna/) (Apache License, Version 2.0)
* [Google Cast SDK](https://developers.google.com/cast/)
- [Google Cast SDK Additional Developer Terms of Service](https://developers.google.com/cast/docs/terms)
- [Google APIs Terms of Service](https://developers.google.com/terms/)
* [Java-WebSocket](https://github.com/TooTallNate/Java-WebSocket) (MIT)
* [JmDNS](http://jmdns.sourceforge.net) (Apache License, Version 2.0)
* [Android-DLNA](https://code.google.com/p/android-dlna/) (Apache License, Version 2.0)

These projects are used in tests:
* [Mockito](http://mockito.org/) (MIT)
* [Robolectric](http://robolectric.org) (MIT)
* [PowerMock](https://github.com/jayway/powermock) (Apache License, Version 2.0)

##License
Copyright (c) 2013-2014 LG Electronics.
Copyright (c) 2013-2015 LG Electronics.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down
Loading

0 comments on commit 7fc7030

Please sign in to comment.