open.hd

README

// SETTINGS \\

:doctype: book

// -- Table of Contents

:toc:
:toclevels: 3
:toc-title: 
:toc-placement!:

// -- Icons

ifdef::env-github[]

:caution-caption: :fire:
:important-caption: :exclamation:
:note-caption: :paperclip:
:tip-caption: :bulb:
:warning-caption: :warning:
endif::[]

ifdef::env-github[]
:status:
:outfilesuffix: .asciidoc
endif::[]

:sectanchors:
:numbered:

// SETTINGS END \\

// Variables \\
:telegram: link:https://t.me/OpenHD_May_2019[Telegram]
:wiki: link:https://openhd.gitbook.io/open-hd[Wiki]
:openhd: link:https://github.com/HD-Fpv/Open.HD[OpenHD]
:imageBuilder: link:https://github.com/HD-Fpv/Open.HD_Image_Builder[Image Builder]
:settingsApp: link:https://github.com/HD-Fpv/Open.HD_AndroidApp[Settings App]
:forum: link:https://discuss.openhdfpv.com[OpenHD Forum]

// === BEGIN OF CONTENT === \\

// Logo
image:wiki-content/Open.HD Logo Splashscreen/Plain_OpenHD_Logo.jpg[OpenHD Logo]

// Badges
image:https://img.shields.io/badge/Telegram-Join_us!-informational?logo=Telegram&style=flat-square[title="Telegram", link="https://t.me/OpenHD_HDFPV"]
image:https://img.shields.io/github/commit-activity/m/OpenHD/Open.HD?style=flat-square[title="GitHub commit activity", link=""]
image:https://img.shields.io/github/issues-raw/OpenHD/Open.HD?style=flat-square[title="GitHub issues", link="https://github.com/OpenHD/Open.HD/issues"]
image:https://img.shields.io/github/downloads/OpenHD/Open.HD/total?style=flat-square[title="GitHub All Releases", link=""]
image:https://img.shields.io/github/repo-size/OpenHD/Open.HD?style=flat-square[title="GitHub repo size", link=""]
image:https://img.shields.io/github/license/OpenHD/Open.HD?style=flat-square[title="GitHub License", link="LICENSE"]

---

// Table of Contents
toc::[]

== Welcome to OpenHD!

OpenHD uses off-the-shelf Wi-Fi adapters available for purchase online, however it is not standard Wi-Fi, which is unsuitable for low-latency
or very long distance transmission. Instead, Open.HD configures the Wi-Fi adapter in a way that is closer to a simple broadcast, much like analog
video transmission hardware you may be using already.

High definition video, 2-way UAV telemetry, audio, and RC control signals can all be sent over a single transmission channel.

A multi-platform Open.HD app is available for live video with a customizable OSD.

TIP: Look around, read the {wiki}, ask questions on {telegram} and contribute back!

== Structure

This repository is one of the following which form the foundation of the project:

[options="header"]
[cols="1, 5"]
|===
| Name | Description

| {wiki}
| The documentation of this project.

| {openhd}
| The core functionality.

| {imageBuilder}
| The Image Builder preinstalls the OpenHD packages on a ready-to-use image.

| {settingsApp}
| For changing settings remotely on ground and air unit.

|===

== Community
Feel free to join our growing community.

We have a {forum}, and public {telegram} group with more then 400 members helping each other.

If you just want to see when new releases are announced, you can either star this repository on Github (requires an
account), or follow the link:https://t.me/OpenHDReleaseAnnouncements[Open.HD Release Announcements] channel on Telegram.

== Developers
Contribution is always welcome!
Start helping us by open up an issue or pull request.
We recommend to get in touch with us via the {telegram} group.

*Thanks to all the people who already contributed!*

[#img-contributors,link=https://github.com/OpenHD/OpenHD/graphs/contributors]
image::https://contrib.rocks/image?repo=OpenHD/OpenHD[Contributors]

== License

OpenHD is licensed under GPLv2, you can find it's contents in this link Raspbian, Linux Kernel, Drivers are licensed under GPLv2 Original code (if found) is licensed as stipulated in respective source files or under the GPLv2 license

== Credits

Befinitiv- original wifibroadcast, Rangarid- OSD, Rodizio- EZ-WifiBroadcast, SVP-COM, Dino.de, Jelle, Vitaliy, and many others

== Logotype

OpenHD logo was designed by link:https://kurtzgraphics.com/[KURTZ]

== Warranty/Disclaimer

This is a free software and comes with no Warranty as stated in parts 11 and 12 of GPLv2 license.
The creators and contributors of the software are not responsible for how it is used.