OSD 1.0 Developer Home
From The Neuros Technology Wiki
Neuros Technology | Products: LINK, OSD, | Developers
Welcome to Neuros OSD (previously MPEG-4 Recorder III) project developer home !
This the place where you can find developer documentation and resources. (For general user information, instead, look at the OSD Users Page).
NOTE: This page is for the OSD1, for information on the HD OSD 2.0 see the OSD 2.0 Development Page
Contents |
[edit] Documentation
We have lots of documentation for developers, Build guides, HOWTOs, Design documents, Hardware documents. It's still a bit scattered currently. Work is in progress to consolidate it.
Note:This documentation is generally aimed at developers. Although some general user information can be found here, in general Neuros_OSD is a better starting place on the wiki for general user information.
Note#2: This documentation is for the OSD1.0, if you're interested in the OSD2, look at the OSD 2.0 Development page
[edit] Design Documents
Language package and translate tool
[edit] Setup and build guides
Some of these guides are undergoing consolidation into one single definitive guide, that will be kept up to date. Some work is in progress now to that end, so pardon any inconvenience.
- This is the main guide for getting started with the OSD, and the one where all other general guides will be consolidated into or linked from. This is also the one that will be preferentially kept up to date.
- This is a guide to setting up a Neuros-friendly coLinux platform right on top of Windows. Kind of like a VM but faster and easier to set up. You can build the OSD firmware on Windows this way.
- This document provides brief notes for various parts that are needed to set up a Linux development environment with Neuros developer board or development hardware. ((TODO: try to refactor into the main guide))
- This document provides instructions to build the OSD (previously Recorder III) main application from related repositories. ((TODO: try to refactor into the main guide, probably somewhat obsolete))
[edit] Other guides and HOWTOs for developers
The guides and HOWTOs focus on helping with specific tasks once you have setup a basic build system using the instructions above.
- This page is a guide of how we use bugzilla on the OSD, and some links to nifty tables,etc
- This document describes how you can create a simple player as an example of building an application for the OSD.
- Get your OSD running mpd and kicking out some hawt tunez. WARNING: OUTDATED
- Finally some "fun", setting up wireless support for the OSD! WARNING: OUTDATED
[edit] Various tips and tricks for developers
[edit] OSD software design documents
These are documents released by either the Neuros engineering team or by the community and then officially picked up by Neuros and implemented.
- This page gives information on the Platform that underlies all the new "platform" products.
- This document provides high level functional description for the OSD (previously Recorder III). This document will also guide the OSD user interface design and overall software design.
- Neux Widget, Window Manager and Desktop Brief - Obsolete! Replaced by Qt4
- This document gives a brief explanation of the Neuros Nano-X based GUI toolkit concepts and design.
- This document gives a brief explanation of the Neuros multi-media framework architecture.
- This document describes the auto update software's architectural design for the OSD product firmware. WARNING: MOSTLY OUTDATED
[edit] OSD hardware documentation
[edit] Block Diagram
- A block diagram and a schematic block diagram
[edit] Remote Control
- This has information on the waveforms and codes the stock OSD remote uses
- Here's our key layout, ie. this is the graphics you'll actually see on the remote that's included with OSD
- We use a set of stock S*ny remote codes, here's the description.
- This book details the remote and its rise to prominence from very humble beginnings. It also has codes and graphs and stuff that looks like it might be of use to someone really smart.
[edit] Contributing
Like all the Neuros projects, The OSD exists as a collaborative effort between community developers and dedicated full-time Neuros internal developers. There are three main areas where you can help: documentation, implementation, and testing, all defined broadly.
In terms of documentation, you are not limited to just document what has been done, you are welcome to document what should be done as well, although the latter is usually done in the form of discussion.
For implementation, you are welcome to experiment with the OSD Gamma units and contribute your new designs, also feel free to download source code and add new features or fix bugs.
Regarding testing, you are welcome to report bugs and contribute test files.
[edit] Code Submission Rules
You are welcome to download the source code and experiment with it. Should you feel you want to commit your implementation, please submit a diff -u file with a description what has been changed to the developer mailing list. Prepend the title of your post with [PATCH] to gather attention of the Neuros developers, who will review your submission and include into the official tree.
[edit] Other stuff (will be restructured shortly)
- Development Roadmap
- C Coding Standards (WIP) ((NOTE: obsolete))
- OSD 1.0 Projects List
This wiki is user updated and the information here cannot be considered official Neuros communication
