plc4go/pkg/api/drivers/drivers.go

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package drivers

import (
	"github.com/apache/plc4x/plc4go/internal/ads"
	"github.com/apache/plc4x/plc4go/internal/bacnetip"
	"github.com/apache/plc4x/plc4go/internal/cbus"
	"github.com/apache/plc4x/plc4go/internal/eip"
	"github.com/apache/plc4x/plc4go/internal/knxnetip"
	modbus2 "github.com/apache/plc4x/plc4go/internal/modbus"
	"github.com/apache/plc4x/plc4go/internal/opcua"
	"github.com/apache/plc4x/plc4go/internal/s7"
	"github.com/apache/plc4x/plc4go/pkg/api"
	"github.com/apache/plc4x/plc4go/pkg/api/config"
	"github.com/apache/plc4x/plc4go/pkg/api/transports"
	"github.com/apache/plc4x/plc4go/spi/options/converter"
)

func RegisterAdsDriver(driverManager plc4go.PlcDriverManager, _options ...config.WithOption) plc4go.PlcDriver {
	driver := ads.NewDriver(converter.WithOptionToInternal(_options...)...)
	driverManager.RegisterDriver(driver)
	transports.RegisterTcpTransport(driverManager)
	return driver
}

func RegisterBacnetDriver(driverManager plc4go.PlcDriverManager, _options ...config.WithOption) plc4go.PlcDriver {
	driver := bacnetip.NewDriver(converter.WithOptionToInternal(_options...)...)
	driverManager.RegisterDriver(driver)
	transports.RegisterUdpTransport(driverManager)
	return driver
}

func RegisterCBusDriver(driverManager plc4go.PlcDriverManager, _options ...config.WithOption) plc4go.PlcDriver {
	driver := cbus.NewDriver(converter.WithOptionToInternal(_options...)...)
	driverManager.RegisterDriver(driver)
	transports.RegisterTcpTransport(driverManager)
	return driver
}

func RegisterEipDriver(driverManager plc4go.PlcDriverManager, _options ...config.WithOption) plc4go.PlcDriver {
	driver := eip.NewDriver(converter.WithOptionToInternal(_options...)...)
	driverManager.RegisterDriver(driver)
	transports.RegisterTcpTransport(driverManager)
	return driver
}

func RegisterKnxDriver(driverManager plc4go.PlcDriverManager, _options ...config.WithOption) plc4go.PlcDriver {
	driver := knxnetip.NewDriver(converter.WithOptionToInternal(_options...)...)
	driverManager.RegisterDriver(driver)
	transports.RegisterUdpTransport(driverManager)
	return driver
}

func RegisterModbusTcpDriver(driverManager plc4go.PlcDriverManager, _options ...config.WithOption) plc4go.PlcDriver {
	driver := modbus2.NewModbusTcpDriver(converter.WithOptionToInternal(_options...)...)
	driverManager.RegisterDriver(driver)
	transports.RegisterTcpTransport(driverManager)
	return driver
}

func RegisterModbusRtuDriver(driverManager plc4go.PlcDriverManager, _options ...config.WithOption) plc4go.PlcDriver {
	driver := modbus2.NewModbusRtuDriver(converter.WithOptionToInternal(_options...)...)
	driverManager.RegisterDriver(driver)
	transports.RegisterSerialTransport(driverManager)
	transports.RegisterTcpTransport(driverManager)
	return driver
}

func RegisterModbusAsciiDriver(driverManager plc4go.PlcDriverManager, _options ...config.WithOption) plc4go.PlcDriver {
	driver := modbus2.NewModbusAsciiDriver(converter.WithOptionToInternal(_options...)...)
	driverManager.RegisterDriver(driver)
	transports.RegisterSerialTransport(driverManager)
	transports.RegisterTcpTransport(driverManager)
	return driver
}

func RegisterOpcuaDriver(driverManager plc4go.PlcDriverManager, _options ...config.WithOption) plc4go.PlcDriver {
	driver := opcua.NewDriver(converter.WithOptionToInternal(_options...)...)
	driverManager.RegisterDriver(driver)
	transports.RegisterTcpTransport(driverManager)
	return driver
}

func RegisterS7Driver(driverManager plc4go.PlcDriverManager, _options ...config.WithOption) plc4go.PlcDriver {
	driver := s7.NewDriver(converter.WithOptionToInternal(_options...)...)
	driverManager.RegisterDriver(driver)
	transports.RegisterTcpTransport(driverManager)
	return driver
}