Atc.Kepware.Configuration.Contracts 1.0.99

.NET Standard 2.1 This package targets .NET Standard 2.1. 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 add package Atc.Kepware.Configuration.Contracts --version 1.0.99                

                    
                

            
NuGet\Install-Package Atc.Kepware.Configuration.Contracts -Version 1.0.99
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Atc.Kepware.Configuration.Contracts" Version="1.0.99" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Atc.Kepware.Configuration.Contracts --version 1.0.99                

                    
                

            
#r "nuget: Atc.Kepware.Configuration.Contracts, 1.0.99"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install Atc.Kepware.Configuration.Contracts as a Cake Addin
#addin nuget:?package=Atc.Kepware.Configuration.Contracts&version=1.0.99

// Install Atc.Kepware.Configuration.Contracts as a Cake Tool
#tool nuget:?package=Atc.Kepware.Configuration.Contracts&version=1.0.99

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.

Requirements

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:
    channels    Commands for channels
    devices     Commands for devices
    tags        Commands for tags
Command <span style="color:yellow">channels</span>
atc-kepware-configuration channels --help


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

EXAMPLES:
    atc-kepware-configuration.exe channels get all -s [server-url] 
    atc-kepware-configuration.exe channels get euromap63 -s [server-url] --name [channelName]
    atc-kepware-configuration.exe channels get opcuaclient -s [server-url] --name [channelName]
    atc-kepware-configuration.exe channels create euromap63 -s [server-url] --name [channelName] --description [description]
    atc-kepware-configuration.exe 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">devices</span>
atc-kepware-configuration devices --help


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

EXAMPLES:
    atc-kepware-configuration.exe devices get all -s [server-url] --channel-name [channelName]
    atc-kepware-configuration.exe devices get euromap63 -s [server-url] --channel-name [channelName] --device-name [deviceName]
    atc-kepware-configuration.exe devices get opcuaclient -s [server-url] --channel-name [channelName] --device-name [deviceName]
    atc-kepware-configuration.exe devices create euromap63 -s [server-url] --channel-name [channelName] --device-name [deviceName]
--description [description] --session-file-path [filePath]
    atc-kepware-configuration.exe 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">tags</span>
atc-kepware-configuration tags --help


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

EXAMPLES:
    atc-kepware-configuration.exe tags search -s [server-url] --search MyTag
    atc-kepware-configuration.exe tags search -s [server-url] --search *Tag
    atc-kepware-configuration.exe tags search -s [server-url] --search My*
    atc-kepware-configuration.exe tags search -s [server-url] --search *yt*
    atc-kepware-configuration.exe 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

How to contribute

Contribution Guidelines

Coding Guidelines

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  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. 
.NET Core netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.1 is compatible. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

  • .NETStandard 2.1

    • Atc (>= 2.0.147)

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Atc.Kepware.Configuration.Contracts:

Package Downloads
Atc.Kepware.Configuration

Atc.Kepware.Configuration is a collection of classes and clients for interacting with Kepware through REST API calls.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.1.26 124 6/24/2024
1.1.24 106 6/20/2024
1.1.22 113 6/20/2024
1.1.20 126 6/14/2024
1.1.18 116 6/13/2024
1.0.170 766 11/7/2022
1.0.166 485 10/25/2022
1.0.162 511 10/21/2022
1.0.160 490 10/21/2022
1.0.99 568 4/24/2022
1.0.94 558 4/22/2022