atc-kepware-configuration 1.1.22

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet tool install --global atc-kepware-configuration --version 1.1.22
This package contains a .NET tool you can call from the shell/command line. 
dotnet new tool-manifest # if you are setting up this repo
dotnet tool install --local atc-kepware-configuration --version 1.1.22
This package contains a .NET tool you can call from the shell/command line. 
#tool dotnet:?package=atc-kepware-configuration&version=1.1.22                

                    
                

            
nuke :add-package atc-kepware-configuration --version 1.1.22

NuGet Version

Atc.Kepware

Kepware configuration library for executing commands, reads and writes on Kepware servers

CLI Tool

The Atc.Kepware.Configuration.CLI tool is available through a cross platform command line application.

Installation

The tool can be installed as a .NET global tool by the following command

dotnet tool install --global atc-kepware-configuration

or by following the instructions here to install a specific version of the tool.

A successful installation will output something like

The tool can be invoked by the following command: atc-kepware-configuration
Tool 'atc-kepware-configuration' (version '1.0.xxx') was successfully installed.`

Update

The tool can be updated by the following command

dotnet tool update --global atc-kepware-configuration

Usage

Since the tool is published as a .NET Tool, it can be launched from anywhere using any shell or command-line interface by calling atc-kepware-configuration. The help information is displayed when providing the --help argument to atc-kepware-configuration

Option <span style="color:yellow">--help</span>
atc-kepware-configuration --help

USAGE:
    atc-kepware-configuration.exe [OPTIONS]

OPTIONS:
    -h, --help       Prints help information
    -v, --verbose    Use verbose for more debug/trace information
        --version    Display version

COMMANDS:
    connectivity
    iot-gateway
Command <span style="color:yellow">connectivity</span>
atc-kepware-configuration connectivity --help

USAGE:
    atc-kepware-configuration.exe connectivity [OPTIONS] <COMMAND>

EXAMPLES:
    atc-kepware-configuration.exe connectivity channels get all -s [server-url]
    atc-kepware-configuration.exe connectivity channels get euromap63 -s [server-url] --name [channelName]
    atc-kepware-configuration.exe connectivity channels get opcuaclient -s [server-url] --name [channelName]
    atc-kepware-configuration.exe connectivity channels create euromap63 -s [server-url] --name [channelName] --description [description]
    atc-kepware-configuration.exe connectivity channels create opcuaclient -s [server-url] --name [channelName] --description [description]

OPTIONS:
    -h, --help    Prints help information

COMMANDS:
    channels    Commands for channels
    devices     Commands for devices
    tags        Commands for tags
Command <span style="color:yellow">connectivity channels</span>
atc-kepware-configuration connectivity channels --help

USAGE:
    atc-kepware-configuration.exe connectivity channels [OPTIONS] <COMMAND>

EXAMPLES:
    atc-kepware-configuration.exe connectivity channels get all -s [server-url]
    atc-kepware-configuration.exe connectivity channels get euromap63 -s [server-url] --name [channelName]
    atc-kepware-configuration.exe connectivity channels get opcuaclient -s [server-url] --name [channelName]
    atc-kepware-configuration.exe connectivity channels create euromap63 -s [server-url] --name [channelName] --description [description]
    atc-kepware-configuration.exe connectivity channels create opcuaclient -s [server-url] --name [channelName] --description [description]

OPTIONS:
    -h, --help    Prints help information

COMMANDS:
    get       Operations related to retrieving channels
    create    Operations related to creating channels
    delete    Delete channel
Command <span style="color:yellow">connectivity devices</span>
atc-kepware-configuration connectivity devices --help

USAGE:
    atc-kepware-configuration.exe connectivity devices [OPTIONS] <COMMAND>

EXAMPLES:
    atc-kepware-configuration.exe connectivity devices get all -s [server-url] --channel-name [channelName]
    atc-kepware-configuration.exe connectivity devices get euromap63 -s [server-url] --channel-name [channelName] --device-name [deviceName]
    atc-kepware-configuration.exe connectivity devices get opcuaclient -s [server-url] --channel-name [channelName] --device-name [deviceName]
    atc-kepware-configuration.exe connectivity devices create euromap63 -s [server-url] --channel-name [channelName] --device-name [deviceName]
--description [description] --session-file-path [filePath]
    atc-kepware-configuration.exe connectivity devices create opcuaclient -s [server-url] --channel-name [channelName] --device-name [deviceName]
--description [description]

OPTIONS:
    -h, --help    Prints help information

COMMANDS:
    get       Operations related to retrieving devices
    create    Operations related to creating devices
    delete    Delete device from channel
Command <span style="color:yellow">connectivity tags</span>
atc-kepware-configuration connectivity tags --help

USAGE:
    atc-kepware-configuration.exe connectivity tags [OPTIONS] <COMMAND>

EXAMPLES:
    atc-kepware-configuration.exe connectivity tags search -s [server-url] --search MyTag
    atc-kepware-configuration.exe connectivity tags search -s [server-url] --search *Tag
    atc-kepware-configuration.exe connectivity tags search -s [server-url] --search My*
    atc-kepware-configuration.exe connectivity tags search -s [server-url] --search *yt*
    atc-kepware-configuration.exe connectivity tags create tag -s [server-url] --channel-name [channelName] --device-name [deviceName] --name [tagName]
--address [tagAddress] --scan-rate [scanRate] --data-type [dataType] --client-access [clientAccess] --description [description]

OPTIONS:
    -h, --help    Prints help information

COMMANDS:
    get       Get tags for channel and device
    create    Operations related to creating tags and tag groups
    delete    Operations related to deleting tags and tag groups
    search    Search tags
Command <span style="color:yellow">iot-gateway</span>
atc-kepware-configuration iot-gateway --help

USAGE:
    atc-kepware-configuration.exe iot-gateway [OPTIONS] <COMMAND>

EXAMPLES:
    atc-kepware-configuration.exe iot-gateway iot-agent mqtt-client create -s [server-url] --name [iotAgentName] --url [url] --publish-message-format [Standard|Advanced]
    atc-kepware-configuration.exe iot-gateway iot-agent mqtt-client get -s [server-url] --name [iotAgentName]
    atc-kepware-configuration.exe iot-gateway iot-agent mqtt-client all -s [server-url]
    atc-kepware-configuration.exe iot-gateway iot-agent rest-client create -s [server-url] --name [iotAgentName] --url [url] --publish-message-format [Standard|Advanced]
    atc-kepware-configuration.exe iot-gateway iot-agent rest-client get -s [server-url] --name [iotAgentName]

OPTIONS:
    -h, --help    Prints help information

COMMANDS:
    iot-agent   Commands for iot agents
    iot-item    Commands for iot items
Command <span style="color:yellow">iot-gateway iot-agent</span>
atc-kepware-configuration iot-gateway iot-agent --help

USAGE:
    atc-kepware-configuration.exe iot-gateway iot-agent [OPTIONS] <COMMAND>

EXAMPLES:
    atc-kepware-configuration.exe iot-gateway iot-agent mqtt-client create -s [server-url] --name [iotAgentName] --url [url] --publish-message-format [Standard|Advanced]
    atc-kepware-configuration.exe iot-gateway iot-agent mqtt-client get -s [server-url] --name [iotAgentName]
    atc-kepware-configuration.exe iot-gateway iot-agent mqtt-client all -s [server-url]
    atc-kepware-configuration.exe iot-gateway iot-agent mqtt-client delete -s [server-url] --name [iotAgentName]
    atc-kepware-configuration.exe iot-gateway iot-agent rest-client create -s [server-url] --name [iotAgentName] --url [url] --publish-message-format [Standard|Advanced]

OPTIONS:
    -h, --help    Prints help information

COMMANDS:
    mqtt-client    Operations related to MQTT Client Iot Agents
    rest-client    Operations related to Rest Client Iot Agents
    rest-server    Operations related to Rest Server Iot Agents
Command <span style="color:yellow">iot-gateway iot-agent rest-client</span>
atc-kepware-configuration iot-gateway iot-agent rest-client --help

USAGE:
    atc-kepware-configuration.exe iot-gateway iot-agent rest-client [OPTIONS] <COMMAND>

EXAMPLES:
    atc-kepware-configuration.exe iot-gateway iot-agent rest-client create -s [server-url] --name [iotAgentName] --url [
url] --publish-message-format [Standard|Advanced]
    atc-kepware-configuration.exe iot-gateway iot-agent rest-client get -s [server-url] --name [iotAgentName]
    atc-kepware-configuration.exe iot-gateway iot-agent rest-client all -s [server-url]
    atc-kepware-configuration.exe iot-gateway iot-agent rest-client enable -s [server-url] --name [iotAgentName]
    atc-kepware-configuration.exe iot-gateway iot-agent rest-client disable -s [server-url] --name [iotAgentName]

OPTIONS:
    -h, --help    Prints help information

COMMANDS:
    create     Create a rest-client iot agent (if not exists)
    get        Get a single rest-client iot agent
    all        Get all rest-client iot agents
    enable     Enable a rest-client iot agent (if exists)
    disable    Disable a rest-client iot agent (if exists)
    update     Update a rest-client iot agent (if exists)
    delete     Delete a rest-client iot agent (if exists)
Command <span style="color:yellow">iot-gateway iot-agent rest-client create</span>
atc-kepware-configuration iot-gateway iot-agent rest-client create --help

USAGE:
    atc-kepware-configuration.exe iot-gateway iot-agent rest-client create [OPTIONS] <COMMAND>

EXAMPLES:
     atc-kepware-configuration.exe iot-gateway iot-agent rest-client create -s [server-url] --name [iotAgentName] --url [url] --publish-message-format [Standard|Advanced]

OPTIONS:
    -h, --help                                               Prints help information
    -v, --verbose                                            Use verbose for more debug/trace information
    -s, --server-url <SERVER-URL>                            Server Url for Kepserver configuration endpoint
    -u, --username [USERNAME]                                UserName for Kepware server configuration endpoint
    -p, --password [PASSWORD]                                Password for Kepware server configuration endpoint
    -n, --name <NAME>                                        Iot Agent Name
        --description [DESCRIPTION]                          Iot Agent Description
        --ignore-quality-changes                             Indicates whether changes in quality should be ignored and not passed on
        --url <URL>                                          The URl of the endpoint to send data to
        --publish-http-method <PUBLISH-HTTP-METHOD>          Sets the HttpMethod for Publishing. Valid values are: Post (default), Put
        --rate <RATE>                                        Specifies the frequency, in milliseconds, at which the agent pushes data to the endpoint
        --publish-format <PUBLISH-FORMAT>                    Sets the format type for Publishing. Valid values are: Narrow (default), Wide
        --max-events-per-publish                             The number of tag events the gateway packages in a single transmission when using narrow format
        --transaction-timeout <TRANSACTION-TIMEOUT>          Defines the maximum amount of time, in seconds, allowed for a transaction to run
        --send-initial-update                                Indicates if an initial update should be sent out on each tag when the Iot Agent starts up
        --http-headers <KEY=VALUE>                           The headers to send to url on each connection
        --publish-message-format <PUBLISH-MESSAGE-FORMAT>    Specifies how messages should be formatted. Valid values are: Standard, Advanced (default)
        --publish-media-type [PUBLISH-MEDIA-TYPE]            Sets the media type for Publishing. Only valid when PublishMessageFormat is set to (Advanced). Valid values are: Json (default), Xml,
                                                             XhtmlXml, TextPlain, TextHtml


atc-kepware-configuration iot-gateway iot-item --help

USAGE:
    atc-kepware-configuration.exe iot-gateway iot-item [OPTIONS] <COMMAND>

EXAMPLES:
    atc-kepware-configuration.exe iot-gateway iot-item mqtt-client create -s [server-url] --iot-agent-name [
iotAgentName] --server-tag [serverTag] --scan-rate [scanRate]
    atc-kepware-configuration.exe iot-gateway iot-item mqtt-client get -s [server-url] --iot-agent-name [iotAgentName]
--server-tag [serverTag]
    atc-kepware-configuration.exe iot-gateway iot-item mqtt-client all -s [server-url]
    atc-kepware-configuration.exe iot-gateway iot-item mqtt-client enable -s [server-url] --iot-agent-name [
iotAgentName] --server-tag [serverTag]
    atc-kepware-configuration.exe iot-gateway iot-item mqtt-client disable -s [server-url] --iot-agent-name [
iotAgentName] --server-tag [serverTag]

OPTIONS:
    -h, --help    Prints help information

COMMANDS:
    mqtt-client    Operations related to MQTT Client Iot Agent Iot Items
    rest-client    Operations related to Rest Client Iot Agent Iot Items
    rest-server    Operations related to Rest Server Iot Agent Iot Items

atc-kepware-configuration iot-gateway iot-item rest-client --help

USAGE:
    atc-kepware-configuration.exe iot-gateway iot-item rest-client [OPTIONS] <COMMAND>

EXAMPLES:
    atc-kepware-configuration.exe iot-gateway iot-item rest-client create -s [server-url] --iot-agent-name [
iotAgentName] --server-tag [serverTag] --scan-rate [scanRate]
    atc-kepware-configuration.exe iot-gateway iot-item rest-client get -s [server-url] --iot-agent-name [iotAgentName]
--server-tag [serverTag]
    atc-kepware-configuration.exe iot-gateway iot-item rest-client all -s [server-url]
    atc-kepware-configuration.exe iot-gateway iot-item rest-client enable -s [server-url] --iot-agent-name [
iotAgentName] --server-tag [serverTag]
    atc-kepware-configuration.exe iot-gateway iot-item rest-client disable -s [server-url] --iot-agent-name [
iotAgentName] --server-tag [serverTag]

OPTIONS:
    -h, --help    Prints help information

COMMANDS:
    create     Create an iot item on a rest-client iot agent
    get        Get a single rest-client iot agent iot item
    all        Get all rest-client iot agent iot items
    enable     Enable a single rest-client iot agent iot item
    disable    Disable a single rest-client iot agent iot item
    update     Update a rest-client iot agent iot item (if exists)
    delete     Delete a rest-client iot agent iot item (if exists)

atc-kepware-configuration iot-gateway iot-item rest-client create --help

USAGE:
    atc-kepware-configuration.exe iot-gateway iot-item rest-client create [OPTIONS] <COMMAND>

EXAMPLES:
    atc-kepware-configuration.exe iot-gateway iot-item rest-client create -s [server-url] --iot-agent-name [iotAgentName] --server-tag [serverTag]
--scan-rate [scanRate]

OPTIONS:
    -h, --help    Prints help information
        --iot-agent-name <IOT-AGENT-NAME>          Iot Agent Name
        --server-tag <SERVER-TAG>                  The server tag the Iot Item is pointing to
        --scan-rate <SCAN-RATE>                    Specifies the frequency, in milliseconds, at which the iot item should be scanned (default: 10000)
        --send-every-scan                          Specifies if the tag should be published on every scan or only on data changes (default: false)
        --dead-band-percent [DEAD-BAND-PERCENT]    Specifies the DeadBand (%) when SendEveryScan is false (default: 0)
        --enabled                                  Indicates whether the Iot Item is enabled (default: true)

COMMANDS:
    create    Create an iot item on a rest-client iot agent

Requirements

How to contribute

Contribution Guidelines

Coding Guidelines

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

Version Downloads Last updated
1.1.26 117 6/24/2024
1.1.24 108 6/20/2024
1.1.22 110 6/20/2024
1.1.20 111 6/14/2024
1.1.18 96 6/13/2024
1.0.170 449 11/7/2022
1.0.166 442 10/25/2022
1.0.162 482 10/21/2022
1.0.160 473 10/21/2022
1.0.99 491 4/24/2022
1.0.94 452 4/22/2022
1.0.85 457 4/6/2022
1.0.79 442 3/28/2022
1.0.75 435 3/28/2022