Updating docs on telemetry

This commit is contained in:
Ryan Summers 2021-07-16 14:25:37 +02:00
parent fba60ef990
commit 661c3746af
3 changed files with 11 additions and 13 deletions

View File

@ -4,15 +4,13 @@
# Stabilizer Firmware
## Hardware
[![Hardware](https://github.com/sinara-hw/Stabilizer/wiki/Stabilizer_v1.0_top_small.jpg)](https://github.com/sinara-hw/Stabilizer)
## Applications
This firmware offers a library of hardware and software functionality targeting the use of the Stabilizer hardware in various digital signal processing applications commonly occurring in Quantum Technology.
It provides abstractions over the fast analog inputs and outputs, time stamping, Pounder DDS interfaces and a collection of tailored and optimized digital signal processing algorithms (IIR, FIR, Lockin, PLL, reciprocal PLL, Unwrapper, Lowpass, Cosine-Sine, Atan2).
An application can compose and configure these hardware and software components to implement different use cases.
Check out the [Documentation](https://quartiq.de/stabilizer) for more information on usage,
configuration, and development.
Check out the [Documentation](https://quartiq.de/stabilizer) for more information on usage.
## Hardware
[![Stabilizer](https://github.com/sinara-hw/Stabilizer/wiki/Stabilizer_v1.0_top_small.jpg)](https://github.com/sinara-hw/Stabilizer)
[![Pounder](https://user-images.githubusercontent.com/1338946/125936814-3664aa2d-a530-4c85-9393-999a7173424e.png)](https://github.com/sinara-hw/Pounder/wiki)

View File

@ -11,10 +11,10 @@ To run locally:
bundle install
bundle exec jekyll serve
```
1. Navigate to `localhost:4000` in a web browser
1. Navigate to `localhost:4000/stabilizer/` in a web browser
Note: Some of the links in the docs rely on Cargo's documentation. To make all links work locally, run:
```
cargo doc --bins
cargo doc --no-deps -p dsp -p miniconf -p stabilizer -p ad9959
cp -r target/thumbv7em-none-eabihf/doc docs/firmware
```

View File

@ -49,13 +49,13 @@ pub struct TelemetryBuffer {
#[derive(Serialize)]
pub struct Telemetry {
/// Most recent input voltage measurement.
adcs: [f32; 2],
pub adcs: [f32; 2],
/// Most recent output voltage.
dacs: [f32; 2],
pub dacs: [f32; 2],
/// Most recent digital input assertion state.
digital_inputs: [bool; 2],
pub digital_inputs: [bool; 2],
}
impl Default for TelemetryBuffer {