libplctag Namespace Reference

Classes

interface  INativeTag
 
interface  ITag
 An interface to represent any generic tag without exposing its value More...
 
class  LibPlcTag
 A static class used to access some additional features of the libplctag base library
 
class  LibPlcTagException
 An exception thrown by the underlying libplctag library More...
 
class  LogEventArgs
 
class  NativeTag
 
class  NativeTagWrapper
 
class  Tag
 
class  TagEventArgs
 

Enumerations

enum  DebugLevel {
  DebugLevel.None = DEBUG_LEVELS.PLCTAG_DEBUG_NONE, DebugLevel.Error = DEBUG_LEVELS.PLCTAG_DEBUG_ERROR, DebugLevel.Warn = DEBUG_LEVELS.PLCTAG_DEBUG_WARN, DebugLevel.Info = DEBUG_LEVELS.PLCTAG_DEBUG_INFO,
  DebugLevel.Detail = DEBUG_LEVELS.PLCTAG_DEBUG_DETAIL, DebugLevel.Spew = DEBUG_LEVELS.PLCTAG_DEBUG_SPEW
}
 Debug levels available in the base libplctag library More...
 
enum  Event {
  Event.ReadStarted = EVENT_CODES.PLCTAG_EVENT_READ_STARTED, Event.ReadCompleted = EVENT_CODES.PLCTAG_EVENT_READ_COMPLETED, Event.WriteStarted = EVENT_CODES.PLCTAG_EVENT_WRITE_STARTED, Event.WriteCompleted = EVENT_CODES.PLCTAG_EVENT_WRITE_COMPLETED,
  Event.Aborted = EVENT_CODES.PLCTAG_EVENT_ABORTED, Event.Destroyed = EVENT_CODES.PLCTAG_EVENT_DESTROYED
}
 Events returned by the base libplctag library More...
 
enum  PlcType {
  PlcType.ControlLogix, PlcType.Plc5, PlcType.Slc500, PlcType.LogixPccc,
  PlcType.Micro800, PlcType.MicroLogix, PlcType.Omron
}
 
enum  Protocol { Protocol.ab_eip, Protocol.modbus_tcp }
 
enum  Status {
  Status.Pending = STATUS_CODES.PLCTAG_STATUS_PENDING, Status.Ok = STATUS_CODES.PLCTAG_STATUS_OK, Status.ErrorAbort = STATUS_CODES.PLCTAG_ERR_ABORT, Status.ErrorBadConfig = STATUS_CODES.PLCTAG_ERR_BAD_CONFIG,
  Status.ErrorBadConnection = STATUS_CODES.PLCTAG_ERR_BAD_CONNECTION, Status.ErrorBadData = STATUS_CODES.PLCTAG_ERR_BAD_DATA, Status.ErrorBadDevice = STATUS_CODES.PLCTAG_ERR_BAD_DEVICE, Status.ErrorBadGateway = STATUS_CODES.PLCTAG_ERR_BAD_GATEWAY,
  Status.ErrorBadParam = STATUS_CODES.PLCTAG_ERR_BAD_PARAM, Status.ErrorBadReply = STATUS_CODES.PLCTAG_ERR_BAD_REPLY, Status.ErrorBadStatus = STATUS_CODES.PLCTAG_ERR_BAD_STATUS, Status.ErrorClose = STATUS_CODES.PLCTAG_ERR_CLOSE,
  Status.ErrorCreate = STATUS_CODES.PLCTAG_ERR_CREATE, Status.ErrorDuplicate = STATUS_CODES.PLCTAG_ERR_DUPLICATE, Status.ErrorEncode = STATUS_CODES.PLCTAG_ERR_ENCODE, Status.ErrorMutexDestroy = STATUS_CODES.PLCTAG_ERR_MUTEX_DESTROY,
  Status.ErrorMutexInit = STATUS_CODES.PLCTAG_ERR_MUTEX_INIT, Status.ErrorMutexLock = STATUS_CODES.PLCTAG_ERR_MUTEX_LOCK, Status.ErrorMutexUnlock = STATUS_CODES.PLCTAG_ERR_MUTEX_UNLOCK, Status.ErrorNotAllowed = STATUS_CODES.PLCTAG_ERR_NOT_ALLOWED,
  Status.ErrorNotFound = STATUS_CODES.PLCTAG_ERR_NOT_FOUND, Status.ErrorNotImplemented = STATUS_CODES.PLCTAG_ERR_NOT_IMPLEMENTED, Status.ErrorNoData = STATUS_CODES.PLCTAG_ERR_NO_DATA, Status.ErrorNoMatch = STATUS_CODES.PLCTAG_ERR_NO_MATCH,
  Status.ErrorNoMem = STATUS_CODES.PLCTAG_ERR_NO_MEM, Status.ErrorNoResources = STATUS_CODES.PLCTAG_ERR_NO_RESOURCES, Status.ErrorNullPtr = STATUS_CODES.PLCTAG_ERR_NULL_PTR, Status.ErrorOpen = STATUS_CODES.PLCTAG_ERR_OPEN,
  Status.ErrorOutOfBounds = STATUS_CODES.PLCTAG_ERR_OUT_OF_BOUNDS, Status.ErrorRead = STATUS_CODES.PLCTAG_ERR_READ, Status.ErrorRemoteErr = STATUS_CODES.PLCTAG_ERR_REMOTE_ERR, Status.ErrorThreadCreate = STATUS_CODES.PLCTAG_ERR_THREAD_CREATE,
  Status.ErrorThreadJoin = STATUS_CODES.PLCTAG_ERR_THREAD_JOIN, Status.ErrorTimeout = STATUS_CODES.PLCTAG_ERR_TIMEOUT, Status.ErrorTooLarge = STATUS_CODES.PLCTAG_ERR_TOO_LARGE, Status.ErrorTooSmall = STATUS_CODES.PLCTAG_ERR_TOO_SMALL,
  Status.ErrorUnsupported = STATUS_CODES.PLCTAG_ERR_UNSUPPORTED, Status.ErrorWinsock = STATUS_CODES.PLCTAG_ERR_WINSOCK, Status.ErrorWrite = STATUS_CODES.PLCTAG_ERR_WRITE, Status.ErrorPartial = STATUS_CODES.PLCTAG_ERR_PARTIAL,
  Status.ErrorBusy = STATUS_CODES.PLCTAG_ERR_BUSY
}
 

Enumeration Type Documentation

◆ DebugLevel

enum libplctag.DebugLevel
strong
Enumerator
None 
Error 
Warn 
Info 
Detail 
Spew 

◆ Event

enum libplctag.Event
strong
Enumerator
ReadStarted 
ReadCompleted 
WriteStarted 
WriteCompleted 
Aborted 
Destroyed 

◆ PlcType

enum libplctag.PlcType
strong
Enumerator
ControlLogix 

Control Logix-class PLC.

Synonym for lgx, logix, controllogix, contrologix, compactlogix, clgx.

Plc5 

PLC/5 PLC.

Synonym for plc5, plc.

Slc500 

SLC 500 PLC.

Synonym for slc500, slc.

LogixPccc 

Control Logix-class PLC using the PLC/5 protocol.

Synonym for lgxpccc, logixpccc, lgxplc5, lgx_pccc, logix_pccc, lgx_plc5.

Micro800 

Micro800-class PLC.

Synonym for micrologix800, mlgx800, micro800.

MicroLogix 

MicroLogix PLC.

Synonym for micrologix, mlgx.

Omron 

Omron PLC.

Synonym for omron-njnx, omron-nj, omron-nx, njnx, nx1p2

◆ Protocol

enum libplctag.Protocol
strong
Enumerator
ab_eip 

Allen-Bradley specific flavor of EIP

modbus_tcp 

A Modbus TCP implementation used by many PLCs

◆ Status

enum libplctag.Status
strong
Enumerator
Pending 
Ok 
ErrorAbort 
ErrorBadConfig 
ErrorBadConnection 
ErrorBadData 
ErrorBadDevice 
ErrorBadGateway 
ErrorBadParam 
ErrorBadReply 
ErrorBadStatus 
ErrorClose 
ErrorCreate 
ErrorDuplicate 
ErrorEncode 
ErrorMutexDestroy 
ErrorMutexInit 
ErrorMutexLock 
ErrorMutexUnlock 
ErrorNotAllowed 
ErrorNotFound 
ErrorNotImplemented 
ErrorNoData 
ErrorNoMatch 
ErrorNoMem 
ErrorNoResources 
ErrorNullPtr 
ErrorOpen 
ErrorOutOfBounds 
ErrorRead 
ErrorRemoteErr 
ErrorThreadCreate 
ErrorThreadJoin 
ErrorTimeout 
ErrorTooLarge 
ErrorTooSmall 
ErrorUnsupported 
ErrorWinsock 
ErrorWrite 
ErrorPartial 
ErrorBusy