Skip to content

Add schema for engineering units update #101

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ and work with the flat buffers union data type in your root element.
|------|----------------------------------|-----------------------------------------------------------------------------------------------|
| f140 | `f140_general.fbs ` | [OBSOLETE] Can encode an arbitrary EPICS PV |
| f141 | `f141_ntarraydouble.fbs ` | [OBSOLETE] A simple array of double, testing file writing |
| f142 | `f142_logdata.fbs ` | (DEPRECATED) For log data, for example forwarded EPICS PV update [superseded by f144] |
| f142 | `f142_logdata.fbs ` | (DEPRECATED) For log data, for example forwarded EPICS PV update [superseded by f144] |
| f143 | `f143_structure.fbs ` | [OBSOLETE] Arbitrary nested data |
| f144 | `f144_logdata.fbs ` | Controls related log data, typically from EPICS or NICOS. Note: not to be used for array data |
| ev42 | `ev42_events.fbs ` | Multi-institution neutron event data for a single pulse |
Expand All @@ -77,9 +77,9 @@ and work with the flat buffers union data type in your root element.
| ADAr | `ADAr_area_detector_array.fbs ` | (DEPRECATED) EPICS area detector array data [superseded by ad00] |
| ad00 | `ad00_area_detector_array.fbs ` | EPICS area detector array data |
| mo01 | `mo01_nmx.fbs ` | Daquiri monitor data: pre-binned histograms, raw hits and NMX tracks |
| ns10 | `ns10_cache_entry.fbs ` | (DEPRECATED) NICOS cache entry |
| ns11 | `ns11_typed_cache_entry.fbs ` | (DEPRECATED) NICOS cache entry with typed data (not used) |
| hs00 | `hs00_event_histogram.fbs ` | (DEPRECATED) Event histogram stored in n dim array |
| ns10 | `ns10_cache_entry.fbs ` | (DEPRECATED) NICOS cache entry |
| ns11 | `ns11_typed_cache_entry.fbs ` | (DEPRECATED) NICOS cache entry with typed data (not used) |
| hs00 | `hs00_event_histogram.fbs ` | (DEPRECATED) Event histogram stored in n dim array |
| hs01 | `hs01_event_histogram.fbs ` | Event histogram stored in n dim array |
| dtdb | `dtdb_adc_pulse_debug.fbs ` | Debug fields that can be added to the ev42 schema |
| ep00 | `ep00_epics_connection_info.fbs` | (DEPRECATED) Status of the EPICS connection |
Expand All @@ -95,6 +95,7 @@ and work with the flat buffers union data type in your root element.
| fc00 | `fc00_forwarder_config.fbs ` | Configuration update for Forwarder |
| al00 | `al00_alarm.fbs ` | Generic alarm schema for EPICS, NICOS, etc. |
| da00 | `da00_dataarray.fbs ` | Pseudo-scipp DataArray with time-dependent and constant Variables |
| un00 | `un00_units.fbs ` | Engineering units update |

## Useful information:

Expand Down
13 changes: 13 additions & 0 deletions schemas/un00_units.fbs
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
// Generic units schema

file_identifier "un00";


table Units {
source_name: string (required); // Source of the alarm state (e.g. EPICS PV, NICOS device, etc.)
timestamp: long; // Nanoseconds since UNIX epoch
units: string; // Describes the engineering units. Note this is optional
// as a PV may not have a units (.EGU) attribute.
}

root_type Units;