dohertj2/lmxopcua
1
0
Fork 0
Code Issues 1 Pull Requests 1 Actions Packages Projects Releases Wiki Activity

fix(driver-s7-cli): resolve Medium code-review finding (Driver.S7.Cli-002)

Browse Source 
Trim the --type help text on read and subscribe to the implemented set
(Bool/Byte/Int16/UInt16/Int32/UInt32/Float32) and append a one-line caveat that
Int64, UInt64, Float64, String, and DateTime are not yet implemented and will
return BadNotSupported — so the CLI does not advertise options that cannot succeed.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
Joseph Doherty
2026-05-22 10:17:33 -04:00
parent 01a6b6d859
commit 086f487786
2 changed files with 8 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
src/Drivers/Cli/ZB.MOM.WW.OtOpcUa.Driver.S7.Cli/Commands/ReadCommand.cs
View File

@@ -19,9 +19,12 @@ public sealed class ReadCommand : S7CommandBase
IsRequired = true)] IsRequired = true)]
public string Address { get; init; } = default!; public string Address { get; init; } = default!;
// Driver.S7.Cli-002: help text trimmed to the types the driver actually implements.
// Int64 / UInt64 / Float64 / String / DateTime are defined in S7DataType but the driver
// raises NotSupportedException (→ BadNotSupported) on reads of those types.
[CommandOption("type", 't', Description = [CommandOption("type", 't', Description =
"Bool / Byte / Int16 / UInt16 / Int32 / UInt32 / Int64 / UInt64 / Float32 / Float64 / " + "Bool / Byte / Int16 / UInt16 / Int32 / UInt32 / Float32 (default Int16). " +
"String / DateTime (default Int16).")] "Int64, UInt64, Float64, String, and DateTime are not yet implemented and will return BadNotSupported.")]
public S7DataType DataType { get; init; } = S7DataType.Int16; public S7DataType DataType { get; init; } = S7DataType.Int16;
[CommandOption("string-length", Description = [CommandOption("string-length", Description =

5
src/Drivers/Cli/ZB.MOM.WW.OtOpcUa.Driver.S7.Cli/Commands/SubscribeCommand.cs
View File

@@ -15,9 +15,10 @@ public sealed class SubscribeCommand : S7CommandBase
[CommandOption("address", 'a', Description = "S7 address — same format as `read`.", IsRequired = true)] [CommandOption("address", 'a', Description = "S7 address — same format as `read`.", IsRequired = true)]
public string Address { get; init; } = default!; public string Address { get; init; } = default!;
// Driver.S7.Cli-002: help text trimmed to the types the driver actually implements.
[CommandOption("type", 't', Description = [CommandOption("type", 't', Description =
"Bool / Byte / Int16 / UInt16 / Int32 / UInt32 / Int64 / UInt64 / Float32 / Float64 / " + "Bool / Byte / Int16 / UInt16 / Int32 / UInt32 / Float32 (default Int16). " +
"String / DateTime (default Int16).")] "Int64, UInt64, Float64, String, and DateTime are not yet implemented and will return BadNotSupported.")]
public S7DataType DataType { get; init; } = S7DataType.Int16; public S7DataType DataType { get; init; } = S7DataType.Int16;
[CommandOption("interval-ms", 'i', Description = "Publishing interval ms (default 1000).")] [CommandOption("interval-ms", 'i', Description = "Publishing interval ms (default 1000).")]