Home
Welcome to the software developer wiki for opendatakit!
Our user documentation is here
For setting up the development environment, see here.
Tips for debugging are here.
Some ideas for 1.x and perhaps 2.0 contributions are here. Notes on related projects in the UW-ICTD repository are here.
Two documents on the 1.x XForms specification are here and here. These are retained for historical purposes and give some insight into the development of the external group and field appearances.
The issue# on GitHub is +1 from the issue number from GoogleCode. When issue #'s are given, if they refer to "(on Google Code)", then +1 to find them on GitHub. This also applies to issue numbers in check-in comments prior to July 8, 2015.
| Project Name | Details |
|---|---|
| Collect | Data collection tool (Android) |
| Release Notes | |
| Source Overview | |
| google-play-services | needed by Collect and the ODK 2.0 tools for Google Maps support |
| validate | validate form definitions and display errors |
| briefcase | locally archive submissions and migrate across Aggregate servers |
| Release Notes | |
| Briefcase-Aggregate APIs | |
| formUploader | alternate entrypoint to briefcase to upload form definitions to Aggregate |
| Release Notes | |
| aggregate | webserver to host data-of-record from a data-collection effort |
| Release Notes | |
| AppEngine Troubleshooting | |
| Tomcat Troubleshooting | |
| AWS Install | |
| 0.9.x -to- 1.x Migration | |
| Master-Slave Migration | |
| Deployment Configuration | |
| Database Structure | |
| Publisher Implementation Details | |
| Briefcase-Aggregate APIs | |
| ODK 2.0 Sync Protocol | |
| Security Notes | |
| Source Code Overview | |
| Eclipse Setup | |
| Uninstall Instructions | |
| aggregate-components | libraries used by Aggregate and test jigs |
| sample-forms | example forms |
| breathcounter | example app launched by Collect |
| foneastra | standalone board for device control |
| Overview | |
| httpclientandroidlib | script to repackage Apache Http jars |
| Android Library | base library with AIDL defns |
| Android Common | common library for consumer wrappers |
| Services | webserver, database services and content providers |
| Combined Release Notes | |
| Technologies | |
| Survey | survey app (akin to Collect) |
| Combined Release Notes | |
| Technologies | |
| Tables | app-level navigation and table-level display graph and report |
| Technologies | |
| AppDesigner | design an ODK 2.0 app |
| Hosting on Static Webserver | |
| Sync Client | standalone app to access Aggregate using ODK 2.0 RESTful API |
| Suitcase | retrieve data in csv form from Aggregate |
NOTE: the Android projects below all generally depend upon the playservices project.
| Project Name | Details |
|---|---|
| Scan | scan a mark-sense form |
| Release Notes | |
| Web App | |
| XLSX Scan form definition | |
| Sensors Framework | framework for connecting sensors |
| Release Notes | |
| Sensor Drivers | implementations for various sensors |
| Zebra Printer Driver Release Notes |
| Project Name | Details |
|---|---|
| Build | ODK Build graphical drag-and-drop form designer (see README.md) |
| Clinic | Interfaces OpenMRS with ODK Collect |
| Overview | |
| Clinic Patient Design |
If you want to become a maintainer for one of these projects, please contact us on the Google group for software engineering questions: opendatakit-developers@
| Project Name | Details |
|---|---|
| Sync | replaced by Services, used to synchronize data up to Aggregate |
| ActionBarSherlock | no longer used; required for early builds of ODK 2.0 tools when backward compatibility to Android 2.x devices was deemed important |
| PlayLicensing | no longer used; required for early builds of ODK Survey as we explored ways to distribute form definitions via the Google Play store |
| Submit | background data submittal using the ODK 2.0 Synchronization protocol |
| Dropbox | simple app that accepts and saves ODK Collect submissions to the file system |
| Manage | control devices through push notifications |
| Overview | |
| ReadMe | |
| Design Document | |
| RangeFinder | APK for optically estimating range to objects |
| Tasks | ? |
| Visualize | ? |
| Voice | IVR tree built upon Javarosa XForms |
| Overview | |
| Listen | ? |