The Open Red Button Project

Project Overview

The Open Red Button Project (ORB) is an open source project that adds HbbTV support to browsers. It uses JavaScript and C++ components to enhance browsers with HbbTV functionality. ORB includes libraries for integration with Android's WebView and RDK's WPE.

The ORB project is designed as a reference implementation and requires additional modifications, including minor browser patches, for use in production. Ocean Blue Software (OBS), the creators of ORB, are experienced in making these modifications and integrating ORB into production devices. For commercial support and discussion about how OBS can help with your project, contact OBS at info@oceanbluesoftware.co.uk.

Overview

• src/: Common polyfill adding HbbTV APIs to the browser (JavaScript).

• components/: Application Manager and Network Services components, including Media Synchronization and Companion Screen (C++).

• android/: Android library utilising the system WebView and a mock application for integration testing.

• rdk/: RDK library utilising the system WPE browser.

See those directories for specific build and integration information.

Contribute

If you are not otherwise coordinated with the project, raise a new issue before starting work on a new fix or feature to avoid duplicated effort.

1. Create or update your fork of the repository to work in.
2. Create a new topic branch on master and complete the fix or feature.
3. Open a pull request. You may find that upstream master has changed and you need to rebase your branch.

The maintainer will squash and merge your branch if it is accepted or they will comment on the pull request.

Licensing

By contributing to the ORB project, you agree to license your contributions under the Apache License 2.0.

Resources

• ORB C++ Contributors Guide: Guide for using C++ with ORB.

• ORB JS Contributors Guide: Guide for using JS with ORB.

License

The software designated as ORB Software, as indicated in the copyright notice within each file, is licensed under the Apache License, Version 2.0 (the "License"). You can find the full text of the Apache 2.0 License in the LICENSE file located in the root directory of this repository.

Third-Party Code

The ORB project includes third-party code, each subject to its respective open-source license. This encompasses both external dependencies used in our project and code that we have incorporated directly into our repository. The incorporated code, which may be modified, is also used under the terms of its original license. For information about the specific licenses of the third-party code used in the ORB project, refer to our Third-Party License Documentation.