- How to contact us?
- Getting started
- Navigating the documentation
- Infrastructure information
- Urban Heartbeat
- RESTful Interface
- GDP Version 2 Transition
- Useful links
Editing instructions: In order to make sure that the wiki is not a complete mess, we are going to enforce some brutal cleanup policies. The main page (this page) serves as an organized directory of almost every wiki page; we will delete any orphan page by default.
General Note: In order to avoid multiple copies of the same information leading to inevitable consistency issues, we try to keep the information primarily in the source code repository and provide pointers to files within the repository from this wiki. Any appropriately formatted markdown files in the repository can be directly linked in a wiki page, see syntax guide.
This page describes the existing deployed version of the GDP that was in use at the October 2017 Terraswarm meeting. For information about the next generation, see GDP 2018.
How to contact us?¶
Read the general philosophy first, here: source:doc/developer/tutorial/gdp-tutorial-part1.md. This should give you an idea of why we made certain design choices.
For ease of getting started, we maintain a basic server side infrastructure in Berkeley (see below). What this means is: in order to get started, you do not need to run a log-server or router. However, at the minimum, you will need the client side C-library. If you wish to use some other language bindings, you definitely need the bindings for that particular language, but you probably will still need the C-library. The reason for this is: in order to minimize developer effort in supporting multiple languages, we have created thin wrappers in languages (say Python) that internally call the C-library.
If you are a user of the GDP and you're not responsible for installing, developing, or maintaining the GDP infrastructure itself, see User Introduction to the GDP. This discusses how to connect to the GDP and other similar things.
The supported platform is Linux (x86 and ARM v8), but the code has been known to work on Mac, FreeBSD by various people. In order to be able to write/run GDP applications, a user needs the C-library and/or language bindings as mentioned above.
- We currently maintain prepackaged versions of C library and Python binding in form of
.debpackages (see source:README-deb.md). These usually are a little outdated than the most recent version from the repository.
- For instructions on how to compile from source, see Compiling the GDP from Source. See Repo access for instructions on how to get access to source code.
The GDP router is in its own separate repository for historical reasons.
We have put together a tutorial to allow you to get started quickly without needing to dig around in the API documentation. However, note that the tutorial does not cover every possible usage.
- Part 1, covers the general philosophy: source:doc/developer/tutorial/gdp-tutorial-part1.md.
- Part 2, walks through writing sample application in Python: source:doc/developer/tutorial/gdp-tutorial-part2.md.
Navigating the documentation¶
- The clientside C-library API: source:doc/developer/gdp-programmatic-api.html
- API for the Python binding around the C API: source:lang/python/README
In-depth technical information, such as protocol details, etc. Note that we experimented a little bit with various document formats earlier, and there are still places where other formats (
.html, etc) need to be converted to markdown.
- Internals of the GDP protocol: source:doc/internal/gdp-proto-v4-proposal.md
- GDP library implementation details: source:doc/internal/gdp-library-implementation.html
- Log metadata: source:doc/developer/gdp-gob-metadata.html
- A discussion of encryption in the GDP: source:doc/gdp-encryption.html
- REST interface (definitely outdated): source:doc/developer/gdp-rest-interface.html
For users to get started without worrying about setting up their own log-servers and routers, we maintain a basic infrastructure at Berkeley. We have the following 4 machines:
Each of these machines runs both a router and a log-server. The router, by default, listens on TCP port 8007. If you use a prepackaged distribution, these are installed by default in
/etc/ep_adm_params/gdp. If you are starting from source, see elsewhere.
The log-servers do not listen on a TCP/UDP port. They can be referenced by their 256-bit GDP name. For the moment, the GDP names are derived by taking a SHA256 hash of a human readable string. The convention we use is a reverse-DNS style notation. For example, the log-server running on
gdp-01.eecs.berkeley.edu is named
edu.berkeley.eecs.gdp-01.gdplogd (note the
gdplogd at the end).
See GDP Production Infrastructure for details.
This ideally should be moved to it's own sub-project in long term
- Visualization for sensor data: Live plots
- In the GDP repo: gdp/doc/gdp-rest-interface.html
- RESTful Server Administration