Groundkit Foundation Release Notes

1. GroundkitFoundation 13.0.0

1.1. Bug Fixes

1.1.1. storage.logging.PacketLoggingInitiatorGRPC

  • BREAKING: Added a separate sporadic task for subscribing to each message, PacketNotification and FullPacketData, to avoid gRPC blocking issues.

  • Deployment types that use this component must be updated to include both new sporadic tasks.

2. GroundkitFoundation 12.1.0

2.1. Features

2.1.1. component.CDS.util

  • Added PARAMETER_GET_SIZE, PARAMETER_GET_DESC and PARAMETER_GET_COUNT to the CommandType enumeration, so that these command types can be recorded in the command archive in Ops.

3. GroundkitFoundation 12.0.0

3.1. Features

3.1.1. comms.pus.PUSAMS

  • Added a Component Type that maps PUS services and sub-services onto AMS service operations, and vice versa.

3.2. Dependencies

  • See hgk 7.0.0 release notes.

  • BREAKING: Users must use hgk 7.x.x in order to use this version of GroundkitFoundation, and may only use it alongside workspaces and bundles generated with hgk 7.x.x.

4. GroundkitFoundation 11.0.0

4.1. Features

4.1.1. core.component.eds.EDSSender

  • Added a Component Type that subscribes to EDS messages, serialises them using AMS, and proxies them to a remote system.

4.1.2. core.component.eds.EDSInitiatorGRPC

  • Added a Component Type with a subscribeOverGrpc sporadic task that requests event messages over gRPC — typically from a core.component.eds.EDSTargetGRPC on another deployment — and publishes the messages it receives within its own deployment.

4.2. Bug Fixes

4.2.1. LocalFileStore

  • Fixed reading of large files. The maximum supported size is 2 GB minus 8 bytes.

  • The component now creates its mount point, and any parent directories that do not exist, so the folder no longer has to be created by hand.

4.2.2. Publish-subscribe over gRPC

  • BREAKING: Publish-subscribe messages sent over gRPC now follow the standard initiator/target pattern for the storage.logging.CommandLoggingService, communication.FileTransfer, storage.logging.EventLogging and cdh.BTS services. The target component subscribes to published messages, handles client subscribe requests and returns messages on a server-side stream; the initiator component sends the subscribe request from a sporadic task on deployment startup and publishes what it receives within its own deployment.

  • BREAKING: The storage.logging.CommandNotificationSenderGRPC, communication.FileTransferMessageSenderGRPC, storage.logging.EventNotificationSenderGRPC and cdh.bts.BTSSenderGRPC components have been removed and must be taken out of any deployment type that uses them.

5. GroundkitFoundation 10.0.0

5.1. Features

5.1.1. Loopback Service Proxy Initiators

  • Loopback service proxy initiators now use the wildcard deployment ID when looping requests back into the host deployment.

5.1.2. io.CommunicationsService

  • BREAKING: The gRPC service proxy initiator and target components have been simplified and standardised. As with the standard service proxy initiators, the full service provider ID must now be supplied when invoking the send operation, and the map of service provider IDs to channel IDs has been removed from the init data in CommunicationsServiceInitiatorGRPCImplInitData.java. Deployments that specified this map must be updated.

5.2. Dependencies

  • See hgk 6.2.0 release notes.

  • Users must use hgk 6.2.0 in order to use this version of GroundkitFoundation.

6. GroundkitFoundation 9.0.0

6.1. Features

6.1.1. comms.ksat.KSATNameValueTC

  • Added a Component Type for sending and receiving KSAT name/value telecommand frames.

6.1.2. Loopback Service Proxy Initiators

  • Added loopback service proxy initiators for the component.AAS, component.PAS, storage.FSS, communication.FileTransfer and cdh.BTS services.

6.1.3. storage.logging.PacketPublisher

  • Added a Component Type that sits between two communications components in a deployment and publishes the incoming or outgoing packets it receives using the packet logging service.

6.1.4. storage.logging.InContextPacketLoggingBroker

  • Added a Component Type that brokers packet logging service messages.

6.1.5. Packet logging over gRPC

  • BREAKING: Full packets can now be published both locally and over gRPC. The packet logging service gains a fullPacketData service message, and storage.logging.PacketLoggingTargetGRPC now sends service messages as they arrive on the stream opened by the initiator.

  • BREAKING: Added storage.logging.PacketLoggingInitiatorGRPC, which subscribes to publish-subscribe messages over gRPC from a sporadic task and republishes them within its own deployment. This removes the need for the PacketNotificationSenderGRPC component, which has been deleted and must be replaced with storage.logging.PacketLoggingInitiatorGRPC and storage.logging.PacketLoggingTargetGRPC.

6.2. Dependencies

  • See hgk 6.2.0 release notes.

  • Users must use hgk 6.x.x in order to use this version of GroundkitFoundation.

7. GroundkitFoundation 8.0.0

7.1. Features

7.1.1. comms.Slipframe

  • Added a Compontent Type that implements a byte-oriented framing protocol based on special characters for separating frames.

7.1.2. comms.ksat.KSATGenericTC

  • Added a protocol Component Type for framing KSAT telecommand packets.

7.1.3. io.CommunicationsService

  • BREAKING A new unsigned 32-bit integer field, routingInfo, has been added to both operations of io.CommunicationsService. All Components which require or provide this service will need to be updated to account for this change.

8. GroundkitFoundation 7.2.0

8.1. Features

8.1.1. storage.fss.FSSTarget

  • Added a Component Type that allows a local provider of the FSS Service to be accessed remotely using serialised FSS requests.

8.2. Dependencies

  • See hgk 5.2.0 release notes.

  • Users must use hgk 5.x.x in order to use this version of GroundkitFoundation

9. GroundkitFoundation 7.1.0

9.1. Features

9.1.1. io.communications.CommunicationsServiceInitiatorGRPC

  • Added a component that receives Send operation requests from local consumers and forwards them to remote deployments over gRPC.

  • Receives Notify operation messages from the remote deployment and forwards them back to the local consumer.

9.1.2. io.communications.CommunicationsServiceTargetGRPC

  • Added a component that receives Send operation requests from remote deployments over gRPC and forwards them to local providers.

  • Receives Notify operation messages from local providers and streams them back to the remote initiator.

9.2. Dependencies

  • See GenOne Java 6.0.1 release notes.

  • See hgk 5.1.0 release notes.

10. GroundkitFoundation 7.0.0

10.1. Bug Fixes

10.1.1. comms.io.net.tcp.SimpleTCPClient

  • BREAKING: Fixed an issue where the component continuously attempted to reconnect when disconnected, causing log flooding and high CPU usage.

  • The component no longer attempts to reconnect automatically and requires a TCP server to be running before deployment startup if messages are to be sent.

10.2. Features

10.2.1. Missions and Deployment Types

  • Added BasicCommsDemo deployment type.

  • Added BasicCommsMission for testing communications with the Generic Linux BasicCommsDemo deployment in FlightkitFoundation.

10.3. Dependencies

  • See GenOne Java 6.0.1 release notes.

  • See hgk 5.0.3 release notes.

  • BREAKING: Users must use hgk 5.x.x with this version of GroundkitFoundation.

11. GroundkitFoundation 6.0.0

11.1. Features

11.1.1. storage.fss.LocalFilestore

  • BREAKING: Ported LocalFilestore from GroundCommon. This is a breaking change for users of GroundCommon, who must remove this component from GroundCommon.

11.1.2. core.component.eds

  • BREAKING: Renamed core.component.eds.EDSTarget to core.component.eds.EDSReceiver.

11.2. Dependencies

  • See GenOne Java 6.0.0 release notes.

  • See hgk 5.0.0 release notes.

  • BREAKING: Users must use hgk 5.x.x with this version of GroundkitFoundation.

12. GroundkitFoundation 5.0.1

12.1. Dependencies

  • Updated workspace hgk and gen-one-java requirements.

  • See GenOne Java 5.0.1 release notes.

  • See hgk 4.0.1 release notes.

  • BREAKING: Users must use hgk 5.x.x with this version of GroundkitFoundation.

13. GroundkitFoundation 5.0.0

13.1. Bug Fixes

13.1.1. JVM OSAL

  • Fixed an issue where periodic task periods were interpreted as milliseconds rather than seconds.

13.2. Features

13.2.1. Connection Lifecycle

  • BREAKING: Connection lifecycle methods are now conditionally generated. Components that require connection lifecycle methods must specify connectionPhase="true" in their componentType.xml. Components that do not require these methods must remove them.

13.3. Dependencies

  • BREAKING: Updated workspace hgk and gen-one-java requirements.

  • See GenOne Java 5.0.0 release notes.

  • See hgk 4.0.0 release notes.

  • BREAKING: Users must use hgk 5.x.x with this version of GroundkitFoundation.

14. GroundkitFoundation 4.0.0

14.1. Bug Fixes

14.1.1. BTSTargetGRPC

  • Changed logging level for messages from info to debug.

14.2. Removed Components

  • None.

15. GroundkitFoundation 3.3.0

15.1. Features

15.1.1. core.component.eds.EDSTargetGRPC

  • Added a component exposing the EDS target over gRPC.

15.2. Removed Components

  • None.

16. GroundkitFoundation 3.2.0

16.1. Features

16.1.1. comms.io.net.tcp.SimpleTCPClient

  • Added a revised and improved SimpleTCPClient component.

16.2. Removed Components

16.2.1. comms.tcp.TCPClient

  • Removed the legacy TCPClient component and replaced it with the improved SimpleTCPClient.

17. GroundkitFoundation 3.1.0

17.1. Features

17.1.1. gRPC Proxy Components

  • Added IOConnectionSenderGRPC component to publish ConnectionStateChange messages over gRPC.

  • Added FileTransferInitiatorGRPC and FileTransferTargetGRPC components for proxy access to communication.FileTransfer services over gRPC.

  • Added FileTransferMessageSenderGRPC component to publish TransferStatusChange messages over gRPC.

  • Added BTSSenderGRPC component to publish BeaconMessage messages over gRPC.

18. GroundkitFoundation 3.0.0

18.1. Features

18.1.1. Networking and Notifications

  • Added TCPServer component.

  • Added PacketNotificationSenderGRPC component.

  • Added EventNotificationSenderGRPC component.

  • Added ParameterValueNotificationSenderGRPC component.

  • Added BeaconNotificationSenderGRPC component.

  • Added io.connection.ConnectionServiceInitiatorGRPC component.

18.2. Breaking Changes

18.2.1. Logging and Services

  • BREAKING: Ported multiple logging services and components from GroundCommon with renamed services and modified dependencies. Refactoring is required in GroundCommon and dependent repositories to accommodate these changes.