external/miraclecast
1
0
Fork 0
mirror of https://github.com/albfan/miraclecast.git synced 2025-02-12 16:11:54 +00:00
Code Issues Releases Wiki Activity
miraclecast/README.md

175 lines
6.7 KiB
Markdown
Raw Normal View History

render README in markdown
2014-09-02 23:13:52 +00:00
# MiracleCast - Wifi-Display/Miracast Implementation
Initial MiracleCast Implementation This initial commit contains the main "miracled" daemon that does link-management and peer-discovery/control. The "miraclectl" tool can be used to control this daemon during runtime. Note that this implementation is still missing a lot of stuff. All it currently does is provide link-management and basic peer-discovery. Following commits will hook everything else up. The actual Miracast/Wifi-Display related runtime control is not being worked on, yet. Feel free to use the proof-of-concept from the OpenWFD repository. The MiracleCast implementation will not get any such functionality unless the basic link-management is properly working. Signed-off-by: David Herrmann <dh.herrmann@gmail.com>
2014-02-06 15:43:11 +00:00
Add Gitter badge
2016-01-09 10:31:32 +00:00
[![Join the chat at https://gitter.im/albfan/miraclecast](https://badges.gitter.im/albfan/miraclecast.svg)](https://gitter.im/albfan/miraclecast?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
Add continuous integration
2016-01-24 22:33:09 +00:00
[![Build Status](https://semaphoreci.com/api/v1/projects/5ece4a7a-365b-4f7c-bfcc-6dcdece7002f/671892/badge.svg)](https://semaphoreci.com/albfan/miraclecast)
Add Gitter badge
2016-01-09 10:31:32 +00:00
polish device tester script closes #22
2015-05-01 19:57:28 +00:00
The MiracleCast project provides software to connect external monitors to your system via Wi-Fi. It is compatible to the Wifi-Display specification also known as Miracast. MiracleCast implements the Display-Source as well as Display-Sink side.
res: update README Add some proper information to the README file and point to the website for more details. Signed-off-by: David Herrmann <dh.herrmann@gmail.com>
2014-02-11 14:43:09 +00:00
better first step guide
2015-03-05 22:58:10 +00:00
The Display-Source side allows you to connect external displays to your system and stream local content to the device. A lot of effort is put into making this as easy as connecting external displays via HDMI.
render README in markdown
2014-09-02 23:13:52 +00:00
better first step guide
2015-03-05 22:58:10 +00:00
On the other hand, the Display-Sink side allows you to create wifi-capable external displays yourself. You can use it on your embedded devices or even on full desktops to allow other systems to use your device as external display.
Initial MiracleCast Implementation This initial commit contains the main "miracled" daemon that does link-management and peer-discovery/control. The "miraclectl" tool can be used to control this daemon during runtime. Note that this implementation is still missing a lot of stuff. All it currently does is provide link-management and basic peer-discovery. Following commits will hook everything else up. The actual Miracast/Wifi-Display related runtime control is not being worked on, yet. Feel free to use the proof-of-concept from the OpenWFD repository. The MiracleCast implementation will not get any such functionality unless the basic link-management is properly working. Signed-off-by: David Herrmann <dh.herrmann@gmail.com>
2014-02-06 15:43:11 +00:00
render README in markdown
2014-09-02 23:13:52 +00:00
## Requirements
The MiracleCast projects requires the following software to be installed:
better first step guide
2015-03-05 22:58:10 +00:00
- **systemd**: A system management daemon. It is used for device-management (udev), dbus management (sd-bus) and service management.
kdbus is avaliable by default relates to #41
2016-06-26 10:28:32 +00:00
Systemd >= 221 will work out of the box. For earlier versions systemd must be compiled with --enable-kdbus, even though kdbus isn't used, but only the independent, experimental sd-libraries.
render README in markdown
2014-09-02 23:13:52 +00:00
*required*: >=systemd-213
Initial MiracleCast Implementation This initial commit contains the main "miracled" daemon that does link-management and peer-discovery/control. The "miraclectl" tool can be used to control this daemon during runtime. Note that this implementation is still missing a lot of stuff. All it currently does is provide link-management and basic peer-discovery. Following commits will hook everything else up. The actual Miracast/Wifi-Display related runtime control is not being worked on, yet. Feel free to use the proof-of-concept from the OpenWFD repository. The MiracleCast implementation will not get any such functionality unless the basic link-management is properly working. Signed-off-by: David Herrmann <dh.herrmann@gmail.com>
2014-02-06 15:43:11 +00:00
better first step guide
2015-03-05 22:58:10 +00:00
- **glib**: A utility library. Used by the current DHCP implementation. Will be removed once sd-dns gains DHCP-server capabilities.
render README in markdown
2014-09-02 23:13:52 +00:00
*required*: ~=glib2-2.38 (might work with older releases, untested..)
res: update README Add some proper information to the README file and point to the website for more details. Signed-off-by: David Herrmann <dh.herrmann@gmail.com>
2014-02-11 14:43:09 +00:00
better first step guide
2015-03-05 22:58:10 +00:00
- **check**: Test-suite for C programs. Used for optional tests of the MiracleCast code base.
render README in markdown
2014-09-02 23:13:52 +00:00
*optional*: ~=check-0.9.11 (might work with older releases, untested..)
Fix minor typo in README Signed-Off-By: 林博仁 <Buo.Ren.Lin@gmail.com>
2017-03-26 11:38:26 +00:00
- **gstreamer**: MiracleCast rely on gstreamer to show cast its output. You can test if all needed is installed launching [res/test-viewer.sh](https://github.com/albfan/miraclecast/blob/master/res/test-viewer.sh)
better first step guide
2015-03-05 22:58:10 +00:00
Fixed small grammar error in README: this -> these.
2017-02-10 03:38:50 +00:00
- **P2P Wi-Fi device** Although widespread these days, there are some devices not compatible with [Wi-Fi Direct](http://en.wikipedia.org/wiki/Wi-Fi_Direct) (prior know as Wi-Fi P2P). Test yours with [res/test-hardware-capabilities.sh](https://github.com/albfan/miraclecast/blob/master/res/test-hardware-capabilities.sh)
polish device tester script closes #22
2015-05-01 19:57:28 +00:00
better first step guide
2015-03-05 22:58:10 +00:00
- copy the dbus policy **res/org.freedesktop.miracle.conf** to `/etc/dbus-1/system.d/`
add gstreamer prerequisites
2014-11-21 21:14:39 +00:00
render README in markdown
2014-09-02 23:13:52 +00:00
## Install
Initial MiracleCast Implementation This initial commit contains the main "miracled" daemon that does link-management and peer-discovery/control. The "miraclectl" tool can be used to control this daemon during runtime. Note that this implementation is still missing a lot of stuff. All it currently does is provide link-management and basic peer-discovery. Following commits will hook everything else up. The actual Miracast/Wifi-Display related runtime control is not being worked on, yet. Feel free to use the proof-of-concept from the OpenWFD repository. The MiracleCast implementation will not get any such functionality unless the basic link-management is properly working. Signed-off-by: David Herrmann <dh.herrmann@gmail.com>
2014-02-06 15:43:11 +00:00
update instructions for autotools
2015-04-11 21:48:23 +00:00
To compile MiracleCast, you can choose from [autotools](http://en.wikipedia.org/wiki/GNU_build_system) or [cmake](http://en.wikipedia.org/wiki/CMake):
Autotools:
$ ./autogen.sh
$ mkdir build
$ cd build
$ ../configure --prefix=/usr/local #avoid --prefix for a standard install
Cmake:
$ mkdir build
$ cd build
$ cmake ..
Compile
render README in markdown
2014-09-02 23:13:52 +00:00
Initial MiracleCast Implementation This initial commit contains the main "miracled" daemon that does link-management and peer-discovery/control. The "miraclectl" tool can be used to control this daemon during runtime. Note that this implementation is still missing a lot of stuff. All it currently does is provide link-management and basic peer-discovery. Following commits will hook everything else up. The actual Miracast/Wifi-Display related runtime control is not being worked on, yet. Feel free to use the proof-of-concept from the OpenWFD repository. The MiracleCast implementation will not get any such functionality unless the basic link-management is properly working. Signed-off-by: David Herrmann <dh.herrmann@gmail.com>
2014-02-06 15:43:11 +00:00
$ make
update instructions for autotools
2015-04-11 21:48:23 +00:00
Test
$ make check #only with autotools by now
Install
Initial MiracleCast Implementation This initial commit contains the main "miracled" daemon that does link-management and peer-discovery/control. The "miraclectl" tool can be used to control this daemon during runtime. Note that this implementation is still missing a lot of stuff. All it currently does is provide link-management and basic peer-discovery. Following commits will hook everything else up. The actual Miracast/Wifi-Display related runtime control is not being worked on, yet. Feel free to use the proof-of-concept from the OpenWFD repository. The MiracleCast implementation will not get any such functionality unless the basic link-management is properly working. Signed-off-by: David Herrmann <dh.herrmann@gmail.com>
2014-02-06 15:43:11 +00:00
$ sudo make install
update instructions for autotools
2015-04-11 21:48:23 +00:00
Select interface to use Start miraclecast against interface of choose. - By tagged udev device - By `--interface` or `-i` option resolves #36, resolves #43, resolves #46
2015-08-23 11:24:48 +00:00
## Automatic interface selection with udev
If you want to select the interface to start miraclecast with, add a udev rule with the script [res/write-udev-rule.sh](https://github.com/albfan/miraclecast/blob/master/res/write-udev-rule.sh) and configure miraclecast with
$ ../configure --enable-rely-udev
You can also choose the interface with `--interface` option for miracle-wifid.
General instructions to compile miraclecast
2015-10-26 21:01:49 +00:00
## Linux Flavours and general compilation instructions
specific linux flavours install steps
2015-03-29 21:24:21 +00:00
### Ubuntu
Details for ubuntu distributions General details for systemd prerequisite. relates to #83
2016-06-30 09:59:45 +00:00
Check your systemd version with:
$ systemctl --version
If you are on 221 or above your systemd has kdbus enabled.
If you are below 221, an alternative repo was created to install systemd with dbus
specific linux flavours install steps
2015-03-29 21:24:21 +00:00
https://github.com/albfan/systemd-ubuntu-with-dbus
Details for ubuntu distributions General details for systemd prerequisite. relates to #83
2016-06-30 09:59:45 +00:00
See there was interface changes on systemd 219, if you are below that version, use branch [systemd-219](https://github.com/albfan/miraclecast/tree/systemd-219) to compile miraclecast
Upgrade dependencies to interface callback changes relates to #53
2015-10-26 20:43:47 +00:00
specific linux flavours install steps
2015-03-29 21:24:21 +00:00
> See specific instructions on that repo
### Arch linux
UIBC support Basic support for UIBC (single mouse events and key events) - Option --uibc on miracle-sinkctl to enable it - Option --log-journal-level to see player execution on journalctl - Controller for uibc miracle-uibcctl - Player based on PyGtk to receive and communicate mouse and keyevents closes #57
2016-07-02 13:35:58 +00:00
Use existing [AUR package](https://aur.archlinux.org/packages/miraclecast/). Remember to enable kdus to systemd-git dependency if you are below 221 systemd.
install on arch linux through AUR package
2015-04-12 09:18:13 +00:00
$ export _systemd_git_kdbus=--enable-kdbus
You can achieve installation using [yaourt](https://wiki.archlinux.org/index.php/Yaourt)
Initial MiracleCast Implementation This initial commit contains the main "miracled" daemon that does link-management and peer-discovery/control. The "miraclectl" tool can be used to control this daemon during runtime. Note that this implementation is still missing a lot of stuff. All it currently does is provide link-management and basic peer-discovery. Following commits will hook everything else up. The actual Miracast/Wifi-Display related runtime control is not being worked on, yet. Feel free to use the proof-of-concept from the OpenWFD repository. The MiracleCast implementation will not get any such functionality unless the basic link-management is properly working. Signed-off-by: David Herrmann <dh.herrmann@gmail.com>
2014-02-06 15:43:11 +00:00
General instructions to compile miraclecast
2015-10-26 21:01:49 +00:00
### Other flavours
If you feel confidence enough (since systemd is the entrypoint for an OS) extract instructions from arch linux AUR PKGBUILD:
- [systemd-kdbus](https://aur.archlinux.org/cgit/aur.git/tree/PKGBUILD?h=systemd-kdbus)
- [miraclecast](https://aur.archlinux.org/cgit/aur.git/tree/PKGBUILD?h=miraclecast)
render README in markdown
2014-09-02 23:13:52 +00:00
## Documentation
Initial MiracleCast Implementation This initial commit contains the main "miracled" daemon that does link-management and peer-discovery/control. The "miraclectl" tool can be used to control this daemon during runtime. Note that this implementation is still missing a lot of stuff. All it currently does is provide link-management and basic peer-discovery. Following commits will hook everything else up. The actual Miracast/Wifi-Display related runtime control is not being worked on, yet. Feel free to use the proof-of-concept from the OpenWFD repository. The MiracleCast implementation will not get any such functionality unless the basic link-management is properly working. Signed-off-by: David Herrmann <dh.herrmann@gmail.com>
2014-02-06 15:43:11 +00:00
quickstart
2015-01-27 05:46:51 +00:00
Steps to use it as sink:
add debian support to miracle-utils.sh and normal-wifi.sh
2016-08-15 03:15:12 +00:00
1. shutdown wpa_supplicant and NetworkManager
quickstart
2015-01-27 05:46:51 +00:00
better first step guide
2015-03-05 22:58:10 +00:00
$ sudo kill -9 $(ps -ef | grep wpa_supplican[t] | awk '{print $2}')
# now you can use `res/kill-wpa.sh`
miraclecast starts wpa_supplicant relates #35
2015-07-29 19:05:01 +00:00
>Remember to save your config to use with `res/normal-wifi.sh`
>it will be easily located with `ps -ef | grep wpa_supplicant` on `-c` option.
quickstart
2015-01-27 05:46:51 +00:00
2. launch wifi daemon
$ sudo miracle-wifid &
better first step guide
2015-03-05 22:58:10 +00:00
3. launch sink control (your network card will be detected. here 3)
quickstart
2015-01-27 05:46:51 +00:00
$ sudo miracle-sinkctl
[ADD] Link: 3
4. run WiFi Display on link:
> run 3
better first step guide
2015-03-05 22:58:10 +00:00
5. Pair your machine with other miracast device (mirroring)
quickstart
2015-01-27 05:46:51 +00:00
better first step guide
2015-03-05 22:58:10 +00:00
6. See your screen device on this machine
quickstart
2015-01-27 05:46:51 +00:00
Steps to use it as peer:
1. Repeat steps 1 and 2 from "use as sink"
2. launch wifi control
$ sudo miracle-wifictl
3. Enable visibility for other devices
4. Locate them using scanning
fix typo in README.md
2016-08-10 09:11:01 +00:00
> p2p-scan
quickstart
2015-01-27 05:46:51 +00:00
UIBC support Basic support for UIBC (single mouse events and key events) - Option --uibc on miracle-sinkctl to enable it - Option --log-journal-level to see player execution on journalctl - Controller for uibc miracle-uibcctl - Player based on PyGtk to receive and communicate mouse and keyevents closes #57
2016-07-02 13:35:58 +00:00
5. Apart from list, or show info with peer &lt;mac&gt; there's nothing useful here by now. For a Q&D see [Using as peer](https://github.com/albfan/miraclecast/issues/4)
## UIBC
> The User Input Back Channel (UIBC) is an optional WFD feature that when implemented facilitates communication of user inputs to a User Interface, present at the WFD Sink, to the WFD Source.
To use it just add `--uibc` on `miracle-sinkctl` startup. Single mouse events and key events are implemented.
Initial MiracleCast Implementation This initial commit contains the main "miracled" daemon that does link-management and peer-discovery/control. The "miraclectl" tool can be used to control this daemon during runtime. Note that this implementation is still missing a lot of stuff. All it currently does is provide link-management and basic peer-discovery. Following commits will hook everything else up. The actual Miracast/Wifi-Display related runtime control is not being worked on, yet. Feel free to use the proof-of-concept from the OpenWFD repository. The MiracleCast implementation will not get any such functionality unless the basic link-management is properly working. Signed-off-by: David Herrmann <dh.herrmann@gmail.com>
2014-02-06 15:43:11 +00:00
documentation about autocompletion
2015-08-22 10:24:08 +00:00
## Autocompletion
Source [res/miraclecast-completion](https://github.com/albfan/miraclecast/blob/master/res/miraclecast-completion) for autocompletion
render README in markdown
2014-09-02 23:13:52 +00:00
## License
Initial MiracleCast Implementation This initial commit contains the main "miracled" daemon that does link-management and peer-discovery/control. The "miraclectl" tool can be used to control this daemon during runtime. Note that this implementation is still missing a lot of stuff. All it currently does is provide link-management and basic peer-discovery. Following commits will hook everything else up. The actual Miracast/Wifi-Display related runtime control is not being worked on, yet. Feel free to use the proof-of-concept from the OpenWFD repository. The MiracleCast implementation will not get any such functionality unless the basic link-management is properly working. Signed-off-by: David Herrmann <dh.herrmann@gmail.com>
2014-02-06 15:43:11 +00:00
better first step guide
2015-03-05 22:58:10 +00:00
This software is licensed under the terms of the GNU-LGPL license. Please see ./COPYING for further information.
## Credits
This software is originally maintained by: David Herrmann dh.herrmann@gmail.com
This fork is maintained by: Alberto Fanjul albertofanjul@gmail.com
If you have any questions, do not hesitate to contact one of the maintainers.
Initial MiracleCast Implementation This initial commit contains the main "miracled" daemon that does link-management and peer-discovery/control. The "miraclectl" tool can be used to control this daemon during runtime. Note that this implementation is still missing a lot of stuff. All it currently does is provide link-management and basic peer-discovery. Following commits will hook everything else up. The actual Miracast/Wifi-Display related runtime control is not being worked on, yet. Feel free to use the proof-of-concept from the OpenWFD repository. The MiracleCast implementation will not get any such functionality unless the basic link-management is properly working. Signed-off-by: David Herrmann <dh.herrmann@gmail.com>
2014-02-06 15:43:11 +00:00
better first step guide
2015-03-05 22:58:10 +00:00
## Additional urls
Initial MiracleCast Implementation This initial commit contains the main "miracled" daemon that does link-management and peer-discovery/control. The "miraclectl" tool can be used to control this daemon during runtime. Note that this implementation is still missing a lot of stuff. All it currently does is provide link-management and basic peer-discovery. Following commits will hook everything else up. The actual Miracast/Wifi-Display related runtime control is not being worked on, yet. Feel free to use the proof-of-concept from the OpenWFD repository. The MiracleCast implementation will not get any such functionality unless the basic link-management is properly working. Signed-off-by: David Herrmann <dh.herrmann@gmail.com>
2014-02-06 15:43:11 +00:00
better first step guide
2015-03-05 22:58:10 +00:00
- Website: http://www.freedesktop.org/wiki/Software/miracle
- Original repo: git://people.freedesktop.org/~dvdhrm/miracle
- Fork repo: https://github.com/albfan/miraclecast
Add technical specs relates #38
2016-07-02 14:06:02 +00:00
- Technical spec: https://www.wi-fi.org/file/wi-fi-display-technical-specification-v11 (free registration required)
Reference in a new issue Copy permalink