Metadata-Version: 2.4
Name: fprime-yamcs
Version: 0.1.2
Summary: FPrime/YAMCS Bridge: Connects F Prime to YAMCS with event support
Author-email: Michael Starch <LeStarch@googlemail.com>
Maintainer-email: Michael Starch <LeStarch@googlemail.com>
License-Expression: Apache-2.0
Project-URL: Homepage, https://github.com/fprime-community/fprime-yamcs
Project-URL: Documentation, https://github.com/fprime-community/fprime-yamcs
Project-URL: Repository, https://github.com/fprime-community/fprime-yamcs
Project-URL: Issues, https://github.com/fprime-community/fprime-yamcs/issues
Keywords: fprime,yamcs,events,telemetry,spacecraft
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: yamcs-client>=1.12.1
Requires-Dist: fprime-gds>=4.1.0
Requires-Dist: fprime-xtce>=0.1.0
Requires-Dist: PyYAML>=6.0.2
Dynamic: license-file

# fprime-yamcs: A YAMCS to F Prime Bridge Package

fprime-yamcs is designed to run YAMCS as the ground system when working with fprime. It operates similar to fprime-gds where it launches YAMCS in-lieu of the fprime-gds data pipelines.

## Requirements

`fprime-yamcs` requires the users to have `mvn` installed. See: [https://maven.apache.org/](https://maven.apache.org/).

> ![CAUTION]
> `mvn` requires JDK to be installed

## Usage

Install this package and run `fprime-yamcs` on a compatible F Prime deployment.

## Configuration 

YAMCS is powerful and has many configuration properties. `fprime-yamcs` requires one instance of YAMCS defined in the configuration to have the following MDB:

```
mdb:
   - type: xtce
     args:
        file: .../fprime.xtce.xml
```

This is to allow for automatic dictionary generation. Users declining this service must specify: `--no-convert-dictionary`.

## Caveats

Currently, the default configuration of YAMCS requires F Prime to connect a CCSDS TC/TM framer/deframer to the Drv.Udp component ensuring that UDP is the transport mechanism.


