👁 Image
AgoraIoT.Edge.App.SDK 3.0.3

Introduction

'Agora Edge App SDK 2.0' (AEA2) is a .NET6 and .NET7 SDK for developing Agora Edge Apps.

Content

Upon installation of the Agora.Edge.App.SDK NuGet package, several content pieces are provided to assist in app development. These may be deleted if you are familiar with their purposes and have an alternative.

• Dockerfile.sample - Dockerfile example that can be used to create a Docker image. The file is optimized to create small images.
• AEA.json.sample - Configuration file example which can be used as a basis for a new app.

Documentation and Tutorials

More information on the SDK and tutorials can be found here: https://slb-edge.github.io

Licensing

http://www.apache.org/licenses/LICENSE-2.0

Release Notes

v3.0.3

• Replace MQTT Client with NATS
• Replace alternate cofiguration update through file with redis twin property
• Disabled Key per file and command line argument support for configuration update
• Device Id in IODeviceData is string
• Datatype of Message Id in the MessageHeader changed from Int32 to UInt32
• Added metadata which is a dictionary of string and string to IOPoint.

v3.0.2-beta

• Fixed the runtime configuration update issue

v3.0.1-beta

• NATS Connection issue fixed
• Reflection-based serialization issue with .net 8 trimmed image

v3.0.0-beta

• Replace MQTT Client with NATS
• Replace alternate cofiguration update through file with redis twin property
• Disabled Key per file and command line argument support for configuration update
• Device Id in IODeviceData is string
• Datatype of Message Id in the MessageHeader changed from Int32 to UInt32
• Added metadata which is a dictionary of string and string to IOPoint.

v1.2.9

• MQTTClient Reduce Auto Reconnect Delay to 100ms.
• MQTTClient Fixed Disconnect Logged message
• MQTTClient Enable persistent connection
• MQTTClient Subscription set with QOS=1 and KeepAlivePeriod to 30sec

v1.2.8-beta

• MQTTClient Reduce Auto Reconnect Delay to 100ms.
• MQTTClient Fixed Disconnect Logged message
• MQTTClient Enable persistent connection

v1.2.7-beta

• MQTTClient Reduce Auto Reconnect Delay to 100ms.

v1.2.6-beta

• Add trace to MQTTClient while client Disconnected.
• Updated the Microsoft.Extensions.Configuration.Json to 8.0.1 to fix the Snyk vulnerabilities.

v1.2.5

• Change for Gps location
• Change for Json serialization/deserialization for .net 8.0 trimmed images.

v1.2.4-beta

• Change for Gps location
• Change for Json serialization/deserialization for .net 8.0 trimmed images.

v1.2.3

Release Of Major version including below changes

• Change of properties of Workflow type to be a dictionary of String & String
• Change of payload & response of RequestMessage type to be a dictionary of String & String
• Documentation changes for above change of Types

1.2.2-beta:

• Added Json serializer dynamic type for issue of trimmed assemblies.
• Change of properties of Workflow type to be a dictionary of String & String
• Change of payload & response of RequestMessage type to be a dictionary of String & String
• Documentation changes for above change of Types

1.1.60:

• Reverted the Fix on JsonSerialization for Dynamic types.

1.1.59:

• Fix Bug on JsonSerialization for Dynamic types.
• Redis KeySpaceNotification -- Removed dependency on ":"
• Redis timeoutException in twin property module.

1.1.55:

• Fix Bug on TwinProperty disconnectivity issue.

1.1.54:

• Add TwinProperty feature

1.1.53:

• Fix Bug in Configuration for locating the basepath for Primary AEA.json of an app running on different host � Container � Development from IDE � Development from command line � Test Runner in IDE � Test Runner in CI build

1.1.53-beta:

• Added TwinProperties feature for Reported & Desired properties to be sync to and from Cloud & Edge

1.1.52:

• Continued fix of configuration and use of BusClient Device Id.

1.1.51:

• Release critical bug fix related for configuration of the BusClient Device Id.

1.1.50:

• Release critical bug fix related for configuration of the BusClient Device Id.

1.1.49-beta:

• Added redis change for notify-keyspace-events
• Added (beta) TwinProperties feature for Reported & Desired properties to be sync to and from Cloud & Edge.

1.1.49:

• Add ability to turn off log coloring, e.g. "AEA2:LogColoring: false". Default is 'true'.

1.1.46:

• Fix bug in MessageId not being incremented automatically when creating a new MessageHeader. This affects RequestMsgs and IoDataReportMsgs.

1.1.45:

• Sync with Python version fixing errors in test code and documentation.

1.0.26:

• Update Event Message schema and set its schema version to '1.0.26'.

1.0.25:

• Add RedisCache to provide access to local redis instance at edge. Documentation provided at slb-edge.github.io.
• Add Event Message (preview) for distribution of events.

1.0.24:

• Breaking change - RequestMsg.Arguments is changed to RequestMsg.Payload to be consistent with python SDK.

1.0.23:

• Use IOTEDGE Environment variables for some well known settings... update documentation accordingly.
• Fix bug causing printing of bus configuration

1.0.22:

• Hot fix for Subscriptions not being set properly.

1.0.21:

• Fix bug causing bus client not to connect. (Need a better test for this... future)
• Provide better feedback when connect/disconnect happens in background.
• Add SDK version when logging exceptions.

1.0.20:

• Add systematic test of all configuration elements to assure the configuration is built... even if it is empty. Report any errors in the sources.

1.0.18:

• Add Mock capability for Bus Client
• Rework Configuration Defaults and Overrides via a configuration facade.
• Rework interface to be more in sync with Python version.
• Fix bug in configuration change notifications when rebuilding config programmatically.

1.0.13-beta

• Deprecate AEA2:Logging:Verbosity to simpler AEA2:LogLevel
• Deprecate AEA2:BugClient:UseDataIn and UseRequests, opting for putting 'DataIn' and 'RequestIn' in the AEA2:BusClient:Subscriptions array of topics.
• Add ability to modify any BusClient setting via configuration while application is running.
• Add 'response' field in RequestMsg.
• Add DeviceId to AEA2:BusClient.
• Add ability to add data to IoDataReportMsg without specifying DeviceId in the call.

1.0.7-beta

• Bump the version number.

1.0.6-beta

• Add Configuration Default and Override capability in Configuration, making them available directly using the SKD facade.
• Add UTCDataTime() and change AgoraTimeStamp to method instead of Property to make Python and .NET SDK more similar. Both are available in SDK facade.
• Add optional parameter to AgoraTimeStamp( DateTime tm ) to allow the TimeStamp to convert from a specific DateTime.
• Rework documentation to include Python SDK.
• Fix colors in logging to be similar to Python.
• Add IoDataReportPassThrough (alpha - undocumented)

1.0.5-beta

• Add Requeste message support with correlation ids.
• Add 'AEA2:BusClient:UseRequestIn = true' in AEA.json to use.

1.0.4-beta

• Fix color reset while logging.
• Add ability to set switch dictionary for commandline arguments using SDK shortcut.

1.0.3-beta

• Add support for .NET7.
• Reduce cyclomatic complexity within BusClient.

1.0.2-beta

• Upgrade netMQTT libraries to resolve deadlock issues when sending messages.
• Fix return value from GenericBusClient.SetMessage, which always return false.

1.0.1-beta

• Initial release after 3 internal slb versions were tested