README
¶
plc4go
plc4go module
To use plc4go import "github.com/apache/plc4x/plc4go/pkg/api" and use the driver manager
driverManager := plc4go.NewPlcDriverManager() to register a driver e.g.
drivers.RegisterKnxDriver(driverManager).
plc4go tools
plc4xpcapanalyzer
plc4xpcapanalyzer is a small tool to evaluate the plc4x parsing against a pcap and report the success rate.
To install plc4xpcapanalyzer run:
go install github.com/apache/plc4x-extras/plc4go/tools/plc4xpcapanalyzer@latest
plc4xbrowser
plc4xbrowser is a terminal application to run REPL-commands against a PLC using plc4x (plc4go)
To install plc4xbrowser run:
go install github.com/apache/plc4x-extras/plc4go/tools/plc4xbrowser@latest
plc4xLicencer
plc4xLicencer is a generator to add the Apache licence to files
To install plc4xLicencer run:
go install github.com/apache/plc4x-extras/plc4go/tools/plc4xLicencer@latest
plc4xGenerator
plc4xGenerator is a generator to generate Serializable and String methods
To install plc4xGenerator run:
go install github.com/apache/plc4x-extras/plc4go/tools/plc4xGenerator@latest
Documentation
¶
Overview ¶
Package plc4go contains all code to get started with plc4x in go. The api can be found in pkg/api
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package internal contains the plc4go implementation
|
Package internal contains the plc4go implementation |
|
pkg
|
|
|
api
Package plc4go contains the main API for plc4go (go part of plc4x)
|
Package plc4go contains the main API for plc4go (go part of plc4x) |
|
api/logging
Deprecated: use options to configure logging
|
Deprecated: use options to configure logging |
|
Package protocols contains generated model classes for the protocols.
|
Package protocols contains generated model classes for the protocols. |
|
ads/discovery/readwrite/model
* Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements.
|
* Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. |
|
ads/readwrite/model
* Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements.
|
* Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. |
|
bacnetip/readwrite/model
* Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements.
|
* Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. |
|
cbus/readwrite/model
* Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements.
|
* Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. |
|
eip/readwrite/model
* Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements.
|
* Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. |
|
modbus/readwrite/model
* Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements.
|
* Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. |
|
Package spi is meant for internal plc4x driver development.
|
Package spi is meant for internal plc4x driver development. |
|
default
Package _default contains default implementations for interfaces defined within the spi
|
Package _default contains default implementations for interfaces defined within the spi |
|
errors
Package errors provides error-handling primitives compatible with the now-archived github.com/pkg/errors.
|
Package errors provides error-handling primitives compatible with the now-archived github.com/pkg/errors. |
|
testutils/xmldom
Package xmldom provides a tiny DOM tree over encoding/xml for the test harness.
|
Package xmldom provides a tiny DOM tree over encoding/xml for the test harness. |
|
transports/serial/serialport
Package serialport provides access to serial ports (RS-232/RS-485 style UART devices) with net.Conn-like read/write deadline semantics.
|
Package serialport provides access to serial ports (RS-232/RS-485 style UART devices) with net.Conn-like read/write deadline semantics. |
|
Package tests contains random tests for plc4go
|
Package tests contains random tests for plc4go |
|
Package tools various tools for working with plc4x
|
Package tools various tools for working with plc4x |
|
plc4xGenerator
command
|
|
|
plc4xLicencer
command
|