41f9713f09
* "Typo" in headline Since this is the Readme for FSSBodySignals the Headline wrongly contains FSSAllBodiesFound. * Update README.md to remove mention of EDDB EDDB is now defunct and its links are dead. * added update 17 schema changes, also protected from additional properties approachsettlement gets station data fsssignaldiscovered gets signaltype * additionalproperties in correct place --------- Co-authored-by: Lord Asrothear <lord@asrothear.de> Co-authored-by: Rob <robxp@hotmail.com> Co-authored-by: Avraham Adler <aadler@users.noreply.github.com> Co-authored-by: Gareth Harper <git@spansh.co.uk>
2.0 KiB
EDDN FSSBodySignals Schema
Introduction
Here we document how to take data from an ED FSSBodySignals Journal
Event and properly structure it for sending to EDDN.
Please consult EDDN Schemas README for general documentation for a schema such as this.
If you find any discrepancies between what this document says and what is defined in the relevant Schema file, then you should, in the first instance, assume that it is the Schema file that is correct. PLEASE open an issue on GitHub to report any such anomalies you find so that we can check and resolve the discrepancy.
Senders
The primary data source for this schema is the ED Journal event
FSSBodySignals.
Augmentations
horizons and odyssey flags
Please read horizons and odyssey flags in the Developers' documentation.
gameversion and gamebuild
You MUST always set these as per the relevant section of the Developers' documentation.
StarSystem
You MUST add a StarSystem string containing the name of the system from the
last FSDJump, CarrierJump, or Location event.
You MUST apply a location cross-check, as per Other data augmentations.
StarPos
You MUST add a StarPos array containing the system co-ordinates from the
last FSDJump, CarrierJump, or Location event.
You MUST apply a location cross-check, as per Other data augmentations.
Remove _Localised key/values
All keys whose name ends with _Localised, i.e. the Type_Localised
key/values in Signals.
Examples:
{ "timestamp":"2022-05-18T00:10:57Z", "event":"FSSBodySignals", "BodyName":"Phoi Auwsy ZY-Z d132 7 a", "BodyID":37, "SystemAddress":4546986398603, "Signals":[ { "Type":"$SAA_SignalType_Geological;", "Type_Localised":"Geological", "Count":2 } ] }