This repository is dedicated to the development and dissemination of space data standards, employing Flatbuffer Interface Definition Language (IDL) schemas as a modern alternative to legacy space data message formats. By embracing Flatbuffers, we aim to provide an efficient, cross-platform serialization solution that is critical for space operations.
Flatbuffers offer several advantages over traditional data serialization methods, particularly in terms of performance and memory efficiency. This makes them highly suitable for space applications where resources are at a premium.
import { writeFileSync, readFileSync } from 'fs';
import { join } from 'path';
import { writeFB, readFB } from 'spacedatastandards.org';
import ipfsHash from 'pure-ipfs-only-hash';
import { standards } from 'spacedatastandards.org';
const { OMMT } = standards.OMM;
const generateOMMData = async () => {
const dataPath = 'test/output/data';
const ommDataArray = [
new OMMT({
OBJECT_NAME: "VANGUARD 1",
OBJECT_ID: "1958-002B",
EPOCH: "2024-06-22T16:56:20.014080",
// other fields as required
}),
new OMMT({
OBJECT_NAME: "VANGUARD 2",
OBJECT_ID: "1959-001A",
EPOCH: "2024-06-23T17:58:04.409760",
// other fields as required
})
];
const resultBuffer = writeFB(ommDataArray);
const CID = await ipfsHash.of(resultBuffer);
writeFileSync(join(dataPath, `${CID}.omm.fbs`), resultBuffer);
// Reading the flatbuffer
const buffer = readFileSync(join(dataPath, `${CID}.omm.fbs`));
const flatbuffers = readFB(buffer);
flatbuffers.forEach(obj => {
console.log({
OBJECT_NAME: obj.OBJECT_NAME,
OBJECT_ID: obj.OBJECT_ID,
EPOCH: obj.EPOCH
});
});
}
generateOMMData();
The repository is structured to facilitate easy access and collaboration:
- dist/: This directory contains the generated source code files from Flatbuffer IDLs, ready for use in various programming environments.
The primary goal of this repository is to establish a set of standardized Flatbuffer IDLs that can replace a variety of legacy space data messages such as SATCAT, TLE, VCM, and others. These legacy formats have served the space industry for decades, but as technology progresses, the need for more advanced data handling becomes apparent.
Transitioning to Flatbuffer IDLs allows us to address the challenges of modern space data communication, ensuring faster, more reliable, and more secure data exchange. These standards are essential for the interoperability between different systems and organizations within the aerospace sector.
For the generated Flatbuffer IDL source code files, please refer to the dist/ folder in this repository. Each subfolder within dist/ corresponds to a specific Flatbuffer schema related to a space data standard.
Access the Generated Source Code Files
Contributions to this repository are welcome. To propose changes or improvements to the existing Flatbuffer IDLs, please submit a pull request or open an issue for discussion.
For more detailed discussions or to request new features, you may reach out to us via email at spacestandards@digitalarsenal.io, or by opening an issue on this repository.
For a more comprehensive understanding of the space data standards being developed in this repository, please refer to our Gitbook documentation.
For historical context and information about legacy message documentation, please visit the legacy message documentation section.
This project is licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
