README.md

#My Stuff Everywhere™ - mse-ios repository

iPhone iOS client application for My Stuff Everywhere. The native application uses C++ code to discover DIAL and Chromecast devices. The device information is sent to a web page in an embedded UIWebView. Everything else of interest happens in the web application (see the `mse-html` repository for more information).

##Important Notes 

1. The Xcode project for the iOS application (mseclient/mseclient.xcodeproj) also contains two OS X targets. One is a simulator with basically the same functionality as the iOS application except that it only supports the discovery of DIAL Servers (no chromecast support). The other is a discovery proxy application that discovers DIAL Servers and uploads the discovered devices to a web service. There is a JavaScript library for querying this web service - `mse-html/js/dial.js`. This is not used at the moment but could be used to create a JavaScript client application that is not capable of native discovery.

2. The above OS X targets use a version of curl that is only available in Mavericks (OS X version 9) and above. If you wish to build these on Mountain Lion or below, you'll have to build and install a newer version of the curl library. You can download the source for this here: 

[https://html5.cablelabs.com/mse/support/curl-7.33.0.tar.gz](https://html5.cablelabs.com/mse/support/curl-7.33.0.tar.gz)

3. The iOS target requires the GoogleCast framework and a libcurl binary. These are included in the repository for your convenience. You may in the future have to download a newer version of the framework and/or rebuild the curl library. You can download the source for the curl library here: 

[https://html5.cablelabs.com/mse/support/ioscurl-7.36.0.tar.gz](https://html5.cablelabs.com/mse/support/ioscurl-7.36.0.tar.gz)


##Folder descriptions

###discovery
Contains C++ sources for DIAL discovery, shared by all of the targets in the Xcode project.

###ios
Contains required iOS frameworks, libraries, and include files.

###mseclient
Contains the Xcode project and related files

##Targets
The Xcode project mseclient/mseclient.xcodeproj contains several projects:

- mseclient-ios - iOS client
- mseclient - OS X client that simulates running on an iPhone
- mseproxy = OS X application that discovers dial servers and local WebSockets bridge instances and conveys this to a web service which is accessible from JavaScript

##Configuration
You will need to copy mseConfig.h from mse/samples to this folder and configure it for your external server.

See [https://html5.cablelabs.com/mse/quickstart.html](https://html5.cablelabs.com/mse/quickstart.html)