threeMF

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 37 Open GitHub ↗

The Mobile MultiModal (Interaction) Framework (3MF or threeMF) is a generic and extendable ad-hoc networking framework for easy device discovery, capability checking and pattern based RPC communication.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

#threeMF
The Mobile MultiModal (Interaction) Framework (threeMF) is a **generic** and **extendable** ad-hoc networking framework for **easy device discovery**, **capability checking** and pattern based **RPC communication**.

threeMF allows ad-hoc communication between devices, without the pain of handling **service discovery and management**, network **socket** and **disconnection handling** as well as **data serialization**. Data exchange is abstracted with simple patterns which reduce code complexity to a few lines. To fit a wide range of use cases the framework is very generic and extendable.

## How does it work
threeMF creates a P2P network to share ad-hoc network services between devices. Discovery of remote threeMF instances and their management during visibility and disappearance is handled automatically. Each peer can publish [remote procedures](http://en.wikipedia.org/wiki/Remote_procedure_call) (they are called commands in the context of threeMF) and execute them at each other. These commands are a semantic description defining **which data** gets shared on **which network channel** (TCP, UDP, ...) following **which pattern**, either [Request Response](https://github.com/mgratzer/threeMF/wiki/RequestResponse) or [Publish Subscribe](https://github.com/mgratzer/threeMF/wiki/PublishSubscribe).

### Example Code
 - [Request Response](https://github.com/mgratzer/threeMF/wiki/RequestResponse)
 - [Publish Subscribe](https://github.com/mgratzer/threeMF/wiki/PublishSubscribe)

threeMF comes with build-in commands --- but it's real power lies in it's extendability. You are able to customize nearby every part, starting at [custom commands](https://github.com/mgratzer/threeMF/wiki/CustomCommands) over to network channels and communication protocols.

The framework communicates **ad-hoc**, which means it is sending network messages directly between peers using their local network without a central instance.

## Platform
threeMF is currently implemented in [Cocoa](https://developer.apple.com/cocoa/) running on iOS and OSX. The bigger vision is to have a system also spread across other relevant platforms like Android, Windows Phone, ... you name it. Feel free to contact [me](http://twitter.com/mgratzer), if you'r interested in porting threeMF --- I'm glad to provide help if needed.

## Requirements
The current implementation is using **ARC** with minimum deployment targets of **Mac OSX 10.7** and **iOS 5.0**.

## Adding threeMF to your Xcode project

You may use   [CocoaPods](http://cocoapods.org) instead of adding the source files directly to your project. Follow the instructions on the CocoaPods site for installation, and specify threeMF in your [Podfile](http://cocoapods.org/#get_started) with `pod 'threeMF', '~> 0.1'`.

Otherwise you can add threeMF as a [git submodule](http://schacon.github.com/git/user-manual.html#submodules) or [download](https://github.com/mgratzer/threeMF/archive/master.zip) the source code and manually copy it to your project.

1. Add the framework as a git submodule. Go to the root folder of your project and execute the following commands.
``` bash
	$ git submodule add https://github.com/mgratzer/threeMF.git Vendor/threeMF
	$ git submodule update --init --recursive
```

2. Add (simply drag & drop) `Vendor/threeMF/threeMF` to your Xcode project.

3. Make sure the following frameworks are linked to your project's target: `CFNetworking.framework`, `Security.framework`, `SystemConfiguration.framework`.

4. You need to add `CoreMotion.framework` and `CoreLocation.framework` to your -Prefix.pch file, if you want to use `TMFLocationCommand` and `TMFMotionCommand`.

## Documentation
Visit the [Wiki](https://github.com/mgratzer/threeMF/wiki/) for more detailed information and [http://threemf.com/documentation/](http://threemf.com/documentation/) for code documentation.

## Author
Developed by [Martin Gratzer](http://www.mgratzer.com) ([@mgratzer](http://twitter.com/mgratzer)) with supported by the [Interactive Systems research group](http://www.uni-klu.ac.at/tewi/inf/isys/ias/index.html) at the [University of Klagenfurt](http://www.uni-klu.ac.at) under the supervision of [Bonifaz Kaufmann](http://www.bonifazkaufmann.com/) and Martin Hitz.

## Thanks
threeMF uses the great [CocoaAsyncSocket](https://github.com/robbiehanson/CocoaAsyncSocket) library for it's build-in [TCP](http://threemf.com/documentation/Classes/TMFTcpChannel.html) and [UDP](http://threemf.com/documentation/Classes/TMFUdpChannel.html) network channels and the Base64 encoding part from [ytoolkit](https://github.com/sprhawk/ytoolkit) to encode binary data. JSON-RPC is the default communication protocol, but there is also a [coding class](http://threemf.com/documentation/Classes/TMFMsgPackRpcCoder.html) using the [MsgPack-ObjectiveC](https://github.com/msgpack/msgpack-objectivec) for [MsgPack-RPC](https://github.com/mgratzer/threeMF/wiki/MsgPack-RPC).

## License
threeMF is available under the MIT license. See the LICENSE.txt file for more info.

threeMF

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README