CHANGELOG.md

3.1.1

• 🪲 Fix static octet string serilazation bug.
• ⭐ Add missing octet string configuration to C# EventBufferConfig.

3.1.0

• ⭐ Added IOutstationApplication::OnConfirmProcess. See PR #403.
• ⭐ OutstationParams::maxControlsPerRequest is now auint32_t and its default value is 4,294,967,295. See issue #390.
• 🪲 Fix FrozenCounter::toString() in Java bindings. See issue #389.

3.0.4

• 🪲 Fix regression in 3.0 .NET bindings which causes deadband settings to not be applied. See PR #387.

3.0.3

• 🪲 Fix TimeDuration overflow bug. See PR #382.
• 🪲 Revert EventMode::EventOnly to 2.x behaviour. See PR #385 and PR #386.

3.0.2

• 🪲 Fix discrepancy between DNPTime::TimestampQuality and HeaderInfo::TimestampQuality. See PR #379.

3.0.1

• 🪲 Fix double-delete issue in C# adapter. See PR #376.

3.0.0

New features:

• ⭐ Add support for Immediate Freeze (0x07), Immediate Freeze No Ack (0x08), Freeze-and-Clear (0x09), Freeze-and-Clear No Ack (0x10). See PR #320.
• Add support for broadcast. See PR #312.
• ⭐ Add UDP support. See PR #314.
• ⭐ Add unsolicited fixed number of retries See PR #323.
• ⭐ Add support for timestamp quality and g51v2 (CTO Unsynchronized). See PR #316.
• ⭐ Add support for TLS 1.3 (requires OpenSSL 1.1.1). See PR #372.

API changes:

• ⭐ Complete reorganization of the code to produce a single library. Properly separate the public header files from the private ones. Refactor the CMake to use modern practices.
• ⭐ Outstation database points are now specified using a map instead of a sorted array. See PR #296.
• ⭐ ICommandHandler now includes a Begin and a End callback to know which commands were grouped together in a single APDU. See PR #341.
• ⭐ ISOEHandler now includes a BeginFragment and EndFragment to help determine if it's a multi-fragment response or an unsolicited response. See PR #298.
• ⭐ When sending requests, a distinct SOEHandler can be specified to help associate the response with the request. To keep the old behaviour, simply pass the same SOEHandler on each request. See PR #339.
• ⭐ All public enumerations used by the library exposes a to_string and a from_string method. They also expose a to_type and a from_type method to convert to and from the underlying integer value. See PR #308.
• ⭐ Control Relay Output Block now expose each field individually. See PR #349.
• ⭐ Instead of relying on an output parameter, DNP3Manager now throws an exception on misconfiguration. This also includes if a server was not able to bind to a port. See issue #293 and PR #367.
• ❌ Remove sending data-link confirmation support. It still supports receiving confirmed data to interoperability. See issue #364 and PR #367.
• 🪲 TaskConfig now takes a std::shared_ptr instead of a reference. See issue #238 and PR #367.

Bindings changes:

• ⭐ Add typed flag handling in Java and C#. See PR #342.
• ⭐ In the Java bindings, when DNP3Manager fails, an descriptive exception is thrown instead of returning a null. See PR #367.
• ⭐ Published NuGet packages now include both x86 and x64 binaries.
• 🪲 Provide IDnpTimeSource interface in Java and C#. See issue #353 and PR #357.
• 🪲 Add typesAllowedInClass0 in Java bindings. See PR #360.

CI:

• 🔨 Move continuous integration to GitHub Actions.
• 🔨 Add automated Subset Level 2 conformance testing. The report is available here: https://dnp3.github.io/conformance/report.html
• 🔨 Add code coverage results using Codecov. See PR #301.

Other:

• 🪲 Fix few minor conformance issues. See PR #356.
• 🪲 Fix issue in data-link state machine. See issue #138 and PR #367.
• ⏫ Update ASIO dependency to 1.16. See PR #365.

2.4.0

• ⭐ Added optional reconnection delay parameter to ChannelRetry. When a connection is lost, this parameter is used to wait before reattempting to establish a connection. Then, the same reconnection strategy as before is used for retries. See issue #354.
• 🪲 Fix conformance issue with data-link confirmations. See PR #359.
• 🪲 Fix conformance issue select & operate behaviour. See PR #359.
• 🪲 Fix issue when compiling with MingW. See PR #345.

2.3.3

• 🪲 Fix C# exception on time conversion upon restart command not supported. See issue #350.

2.3.2

• 🪲 Fix C# issue where EventConfig::clazz was never set. See issue #291.

2.3.1

• 🪲 Fix final case for issue #216. See PR #310.
• 🪲 Add missing include for usage with ASIO_DYN_LINK (see PR #311)

2.3.0

• 🪲 Fixes for issues #268, #262, #259, #257, #255, #251, #228, #216.
• ⭐ Added overloaded methods for TCP and TLS clients to support outstation redundancy (#277).
• ⭐ .NET bindings can now be configured and built using CMake (requires CMake >= 3.8).
• ⭐ Expanded fuzzing support from Google OSS Fuzz to the master and outstation handlers.
• ⭐ Added support for cold/warm restart in Java OutstationApplication interface.
• 🔧 Migrate default ASIO version to 1-12-2. Older versions may no longer be compatible.
• 📝 Added automatic code formating with clang-format.

2.3.0-M1

• ⭐ Small internal change to support openssl 1.1.x (pull request)
• ⭐ TCP server channels can now configurably drop or accept.
• 🔧 This causes a breaking API change by adding a parameter to DNP3Manager::AddTCPServer(...).
• ⭐ Outstation now supports transmitting octet strings
• ⭐ Masters can now optimize control requests for 1-byte index qualifiers. This optimization can be enabled via MasterParams.controlIndexMode.
• ⭐ ILinkListener has two additional callbacks for unknown destination / source addresses.
• ⭐ Outstations can now queue events w/o updating static values using EventMode::EventOnly.
• 🪲 Fix integer underflow w/ discontiguous outstation indices
• 🪲 Fix memory leak in C# DNP3ManagerAdapter.

2.2.0

• No changes from 2.2.0-RC5

2.2.0-RC5

• 🪲 Fixed a bug where connection attempts were not retrieved after failed DNS resolution.

2.2.0-RC4

• 🪲 Fixed a regression in outstation whereby the session could hang indefinitely if a non-read request was received during UnsolConirmWait.

2.2.0-RC3

• 🪲 Fixed a regression whereby multi segment messages could be transmitted with trailing garbage.
• 🪲 Fixed a bug whereby improper TLS shutdown from the remote host could result in an infinite loop. TLS shutdown is no longer utilized in favor of just a hard TCP close.

2.2.0-RC2

• 🪲 Java bindings in 2.2.0-RC1 were leaking local references. Modified the bindings to use resource management class to ensure this doens't happen going forward.
• 🪲 Fixed a bug in outstation/master enable/disable that put the session into an invalid state.

2.2.0-RC1

• ⭐ Java bindings have been added to the project.
• ⭐ New API for creating "masters as servers" (aka GPRS-based systems)
• 🔧 DNP3Manager now returns shared_ptr. IChannel now returns shared_ptr<IMaster/IOutstation>. Shutdown is now idempotent on these interfaces used via shared_ptr.
• 🔧 Channel, master, and outstation now accept all callback interfaces via shared_ptr.
• 🔧 The external format for statistics has been changed to ease maintainence. Each class now owns the statistics it increments.
• 🪲 Fixed a bug where the keep-alive timer would rapidly fire in C# if set to Timespan.MaxValue.
• 🪲 Fixed a bug in the outstation state machine where it would incorrectly ignore repeat READ requests.
• 🪲 Fixed a bug in the ASDU formatting where a request for a range of 255 measurement values would result in a malformed response.
• 🪲 Fixed a bug in the TLS client that caused the channel to be unrecoverable after any disconnect.

2.1.0

• Minor formatting and documentation tweaks

2.1.0-RC6

• 🔧 The C# LinkConfig class now uses Timespan for timeouts for consistency with other API elements. This also solved an issue where the LinkTimeout could not be effectively disabled since MaxInt wasn't big enough to ensure it never ran.
• 🔧 Moved experimental SA components to the "secauth" branch.
• 🔧 ILogHandler is now injected as an argument to the DNP3Manager constructor as a shared_ptr.
• ⭐ Master and outstation interfaces can now control their log level independently of the channel they're created on.
• 🪲 Fixed a bug in the C# bindings where the ILogHandler was prematurely freed by the GC.
• Refactored cmake build files into several sub-files for better modularity.

2.1.0-RC5

• 🪲 Fixed a bug in the master multi-drop functionality where removing an active master, caused remaining session to freeze.
• 🪲 Fixed a bug in ClearRestartTask where the completion callback was invoked with the wrong task type.
• ⭐ HeaderInfo class in ISOEHandler now exposes isEvent member which tells user if header is for an event type. Added this to C# as well.
• ⭐ C++ outstation demos now load the current timestamp using overloaded MeasUpdate constructor

2.1.0-RC4

• ⭐ Tagged released now automatically deployed to Nuget via AppVeyor build
• ⭐ Code generator now produces lookup functions for group variation time/tag information.
• ⭐ Added a decoder feature used to power the website decoder.

2.1.0-RC3

• 🪲 Fixed a bug in the C# bindings where non-zero based indices were not being detected properly.

2.1.0-RC2

• 🪲 Fixed a bug that was causing the keep-alive to not retry at the configured rate

2.1.0-RC1

• Migrated fully to CMake, including generated SLN
• Separated include vs private headers
• New guide + doxygen docs
• Add an ILinkListener interface inherited by IMasterApplication/IOutstationApplication that allows you to monitor link-layer activity.
• Master can now send any combination and # of commands in a single request
• Support for TLS client/server (optional in build)
• Modified the IMaster interface to inherit from ICommandProcessor which now contains only two methods.
• Master now uses Task[T] everywhere instead of custom Future[T]. Eases uses with TPL and async/await.
• Master now has a parameter to timeout tasks that fail to start within a certain TimeDuration.
• Implemented the RequestLinkStates/LinkStatus heartbeat functionality in 1815.
• 🪲 Fixed a bug in the way CTO objects were handled w/ Group2Var3 and Group4Var3
• C# bindings now use .NET Task[T] instead of custom Future[T]
• Introduced an experimental version of SAv5 (not intended for production use)
• Significantly refactored the master/outstation internals to accommodate adding SA via inheritance.
• Added parser/formatter generators for variable-length objects in Group120

2.0.1

No changes to 2.0.1-RC3 for final 2.0.1 release

2.0.1-RC3

• Workaround for broken std::chrono::steady_clock impl thanks to Liam MacIsaac.
• Based on user feedback, the .NET outstation API now uses a more intuitive "ChangeSet" to update values in the outstation.
• The .NET "simulator" has been restored with more features surfaced and outstation plugins can now be written to simulate devices.

2.0.1-RC2

• DNPManager.AddTCPClient now takes an additional parameter for the local adapter address (0.0.0.0 == all adapters)
• Overloaded CROB constructor allows for non-standard control codes to be specified.
• Fixed a thread-safety issue in the outstation on data update. The API has shifted for updating the outstation database to accomodate this fix.
• Fixed an uninitialized control code variable in the CROB introduced in 2.0.1-RC1.

2.0.1-RC1

• Added support for Group50Var4 (Time and Interval) objects. These are static only objects (no events) that can are read/write.
• Added support for Binary/Analog command events to the parser and the master API courtesy of Sid Hoda.
• Added support for the ASSIGN_CLASS function code.
  • Assignment to the outstation db is automatic, but there is a callback on IOutstationApplication for any desired user action
  • The master can assign class automatically during the startup handshaking based on callbacks in IMasterApplication
• Substantially refactored/simplified the master scheduler to make extension easier.
  • Most tasks that are explicitly rejected via IIN bits (e.g. enable/disable unsol) no longer retry on failure
• Added support for discontigous outstation databases based on an earlier contriubtion from Alan Murray
  • Virtual (dnp3) indices are now assigned after creation of the outstation, but before enabling it
  • Note: Discontigous mode must be set in the OutstationConfig in C++, automatically detected in C#
  • Discontiguous mode is slightly less performant on range-based READ's because of O(log(n)) binary search
• Static and event response types can now be configured on a per-point basis
  • In C++ this occurs after creating the outstation instance, but before enabling it.
  • In C#, all values are specified in the DatabaseTemplate
• Fixed a minor conformance issue: Group1Var1 is now promoted to Group1Var2 if the quality != ONLINE
• The are now two methods for monitoring master tasks
  • Callbacks on IMasterApplication for built-in tasks and ones that were created with a userId
  • Optional per-task callback interfaces supplied when the task was created
• Arbitrary master scans (qualifiers 0x06, 0x00/0x01, 0x07/0x08) can now be created in C# using an API contributed by Damon Sutherland
• Added a flag to the outstation that limits the number of queued event checks to 1. This was done for determinism on embedded systems with limited space to queue executor actions.

2.0.0

• Fixed an issue in openpal::Synchronized where the stack would deadlock under heavy contention
• Fixed bug where counter 'numTransportErrorRx' was incremented twice
• The log alias in LogRoot is now dynamically sized removed the artificial limitation

2.0.0-RC3

• Dynamic memory allocation now allowed in core library during initialization.
  • Removed various redundant static container types in openpal
  • Database and event buffers now create they underlying storage from configuration
  • Hard limits that were in Configure.h are no longer necessary.
• C++/C# master API now receives callback whenever an IIN field is received to allow user layer processing.
• Fixed a bug where periodic taks with period < 0 would rapid-retry instead ()
• Added an embedded demo for the sam3x8E ARM (arduino DUE)
• Parsers are no longer singletons, both groups of functions to reduce SRAM usage on embedded systems.
• ICommandHandler semantics switched back to Select/Operate to more closely match spec. Operate is indistinguisable from DirectOperate at user layer
• Include guards now prepend library name to avoid potential conflicts
• Master can now bind arbitrary 0x06 (all objects) periodic scans

2.0.0-RC2

Conformance fixes based on testing with 3rd party harness. Only remaining level 2 conformance item is handling broadcast addressing.

• Outstation now handles limited count (0x07, 0x08) request headers for class polls and specific variation polls.
• IOutstationApplication can now handle cold/warm restart function codes.

Master measurement API (ISOEHandler) now informs application of qualifer, group variation, and validity of timestamps for each header received.

2.0.0-RC1

Refactoring / Improvements - General

• To enable ports to other platforms and MCUs, the 1.1.x library was divided into 4 sub-libraries.

  • openpal - The Platform Abstraction Layer (PAL) provides abtract base classes for key abstractions like IPhysicalLayer, IExecutor, ITimer, etc.
  • opendnp3 - The core dnp3 library. It only depends on openpal and is platform independent C++11.
  • asiopal - Implements the PAL using boost::asio. This PAL can be used on server platforms like Windows, Linux, & OSX. It only depends on openpal.
  • asiodnp3 - Provides a nice wrapper to opendnp3 for server platforms. Depends on all three libraries.

• Library uses a new parser and generator that vastly improves readability, maintainability, performance, and safety.

• Example applications for Atmel Studio for Arduino boards have been added. They are not yet production ready, but a proof of concept.

• Stack depth has been reduced to better suite embedded systems.

• Core library is now organized by layer making navigation, maintainence, and learning the library easier.

• C++ libraries are now exception-free. They can be compiled with -fno-exceptions.

• IExecutor now uses an "Action0" which is a parameterless functor. Uses type-safe erasure/lambdas combined with static allocation.

• Core library now uses sprintf instead of iostreams. All usage of std::string removed to improve portability.

• Removed some instances of recursion in the link layer CRC checking. The library is now recursion-free.

• The library no longer uses BOOST. Instead it uses the standalone verison (header only) of ASIO

• Tests were ported from BOOST_TEST to Catch. Catch is header only and redistributed with the project.

• Core library no longer uses STL. This makes ports to MCUs much easier.

• Core library no longer uses dynamic memory allocation. Databases and buffers are either statically allocated or injected allowing the user to choose.

• Library no longer uses size_t as this type changes length on 32/64-bit platforms. Explicit types are now used from .

• Application layer objects and most enums are now generated using a companion Scala project in the 'generation' folder.

• Buffer wrappers "WriteBuffer" and "ReadOnlyBuffer" are now passed around internally instead of pairs of uint8_t* and uint32_t.

• Upgraded solution file to VS2013

• x86 and x64 outputs now build side-by-side

• LogEntry class no longer carries timestamp. This allows the timestamp to be set by the specific platform.

• Setpoint/Control terminology changed to AnalogOutput & BinaryOutput to correspond to the specification.

• Libraries no longer have separate src/include directories. This decision was premature.

• Clang is now an officially supported compiler and will also be used for static analysis. Project compiles with Clang 3.4.

• Logging is now explicitly controlled using the bitfields instead of enums. This allows dnp3 specific log levels to be defined without polluting openpal with their definitions.

External Features

• Ticket 56 - Measurement types can now tell the user if the timestamp is valid or not (bool IsTimeValid() const)
• Ticket 43 - Master command callbacks now provide a type that can distinguish between local and remote failure, e.g. when the repsonse times out or the channel is closed.
• Ticket 47 - TCP client can now perform asynchronous DNS host resolution and try mutliple resolved addresses in a single "open" sequence.
• Ticket 56 - C++ channels can also specify a "strategy" for full control over the wait period for retry.
• Ticket 30 - Outstation API now provides control of the NeedTime IIN bit.
• Ticket 29 - Scans are now exposed as part of the master API. Callbacks can be registered to observe success and failure. Class scans may be defined dynamically and performed on demand.
• C++ TCP Client/Server can now configure native socket types with an optional functor. This allows platform-specific customization of things like TCP keep-alives.
• Master applications now specify "ISOEHandler" (Sequence of Events) instead of "IDataObserver". It allows users to discern between static and event types.
• Renamed outstation API "IDataObserver" to the more descriptive "IMeasurementLoader"
• Outstation now uses a simple interface "ITimeWriteHandler" to receive time write requests
• The start of a master or outstation is delayed until a Enable() method is called. Stacks may be dynamically paused/resumed at runtime with the Enable/Disable methods.
• Master now supports additional types:
  • Frozen Counters, Double-bit Binaries, and Octet Strings
• Outstation now supports additional types:
  • Frozen Counters, Double-bit Binaries, and AO/BO status events
• Java Future can now be called with an optional timeout
• Channels now have expoential backoff capability controlled by min/max retry parameters.
• Each channel can low control the its log level dynamically via the SetLogFilters() method.

Bug / conformance fixes

• Default integrity poll is now a Class 1/2/3/0 scan as per the specification.
• Outstation now reports events in correct order-of-occurence across all seven types it supports.
• Physical layer disconnects now observer the minRetry parameter. This prevents rapid connect/disconnect cycling when a server is closing connections.
• Transport layer can now receive non-fin packets with payload length between 1 and 249. It's very strange for an implementation to do this, but its actually in the spec.
• Count-of-zero headers are now explicitly disallowed and parsing is halted.
• Ticket 57 - When a READ is received while waiting for a confirm, any further retries should be canceled. (also fixed on 1.1.x)
• Ticket 62 - Fixed a bug where the master scheduler could hang if the the channel was closed while waiting for response to a command.

Removed

• VTO "routers" are now longer provided. 0-length strings of all types (Groups 110-113) are now explicitly not allowed.
• ASIOPAL now explicitly uses std::chrono::steady_clock for timers. There is no longer a typedef.
• Library no longer supports 4-octet qualifier codes. All indices used uint16_t as underlying type.
• Support for "delta" values has been removed. New implementations do not need to support this according to the spec.