Skip to content
This repository has been archived by the owner on Mar 5, 2024. It is now read-only.

Commit

Permalink
Started working on revision 0.3
Browse files Browse the repository at this point in the history
- The unstable version of the spec is found in oni-spec-wip.txt
- Updated README
- Removed all API implemention documentation from README
- Added contributing guidlines to README
  • Loading branch information
jonnew committed Nov 13, 2019
1 parent 98cc763 commit 2408d0f
Show file tree
Hide file tree
Showing 5 changed files with 470 additions and 10 deletions.
12 changes: 9 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,8 +1,14 @@
paper: spec.md
current: oni-spec.txt
pandoc \
--columns 1 \
--latex-engine=xelatex \
-o spec.pdf -s spec.md
-o oni-spec.pdf -s oni-spec.txt

wip: oni-spec-wip.txt
pandoc \
--columns 1 \
--latex-engine=xelatex \
-o oni-spec-wip.pdf -s oni-spec-wip.txt

clean:
rm spec.pdf
rm oni-spec.pdf
20 changes: 13 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,15 +36,21 @@ following components:
1. Host device driver specification [WIP]
1. Host programming interface specification

Each can be found as a separate section in the specification itself.
Each can be found as a separate section in the specification itself.

## Contributing
[oni-spec-wip.txt](oni-spec-wip.txt) is the _unstable_ work in
progress for the next ONI revision. Please make changes and PRs to this
document only. This repo shall not contain a PDF version of this WIP spec.

## Implementations

### Open Ephys 2.0
In addition to these specifications, we have created the following flagship
implementations which form data acquisition system at the base of our [next
generation headstages](../headstage-64). These implementations are modular --
you can use them for your project. There is no need to reinvent the wheel:
implementations which form the basis of our [next generation acquisition
system](https://jonnew.github.io/open-ephys-pcie/). These implementations are
modular -- you can use them for your project. There is no need to reinvent the
wheel:

- Firmware implementations based on (1,2).
- TODO
Expand All @@ -53,10 +59,10 @@ you can use them for your project. There is no need to reinvent the wheel:
- TODO

- API implementations based upon (4):
- [liboepcie](../api/liboepcie) is an ANSI-C open-ephys++ API implementation.
- [liboni](../api/liboepcie) is an ANSI-C open-ephys++ API implementation.
It contains functions for configuring and stream data to and from hardware.
- [cppoepcie](../api/cppoepcie) C++14 bindings for liboepcie.
- [clroepcie](../api/clroepcie) CLR/.NET bindings for liboepcie.
- [cpponi](../api/cppoepcie) C++14 bindings for liboepcie.
- [clroni](../api/clroepcie) CLR/.NET bindings for liboepcie.

If you think these implementations are missing something, feel free to use the
spec to develop for yourself or submit a bug report. When you use these
Expand Down
Loading

0 comments on commit 2408d0f

Please sign in to comment.