-
Notifications
You must be signed in to change notification settings - Fork 423
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(plc4go/bacnet): initial implementation of discovery
- Loading branch information
Showing
10 changed files
with
348 additions
and
76 deletions.
There are no files selected for viewing
76 changes: 76 additions & 0 deletions
76
plc4go/examples/bacnet/discovery/hello_world_plc4go_bacnet_discovery.go
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| /* | ||
| * 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 main | ||
|
|
||
| import ( | ||
| "github.com/apache/plc4x/plc4go/pkg/api" | ||
| "github.com/apache/plc4x/plc4go/pkg/api/drivers" | ||
| "github.com/apache/plc4x/plc4go/pkg/api/logging" | ||
| "github.com/apache/plc4x/plc4go/pkg/api/model" | ||
| "github.com/rs/zerolog/log" | ||
| "os" | ||
| "time" | ||
| ) | ||
|
|
||
| // TODO: not yet finished... much c&p from knx atm | ||
| func main() { | ||
| // Set logging to INFO | ||
| logging.DebugLevel() | ||
|
|
||
| driverManager := plc4go.NewPlcDriverManager() | ||
| drivers.RegisterBacnetDriver(driverManager) | ||
|
|
||
| var connectionStrings []string | ||
| if len(os.Args) < 2 { | ||
| // Try to auto-find bacnet devices via broadcast-message discovery | ||
| if err := driverManager.Discover(func(event model.PlcDiscoveryEvent) { | ||
| connStr := event.GetProtocolCode() + "://" + event.GetTransportUrl().Host | ||
| log.Info().Str("connection string", connStr).Msg("Found Bacnet Gateway") | ||
|
|
||
| connectionStrings = append(connectionStrings, connStr) | ||
| }, | ||
| plc4go.WithDiscoveryOptionProtocolSpecific("who-is-low-limit", 0), | ||
| plc4go.WithDiscoveryOptionProtocolSpecific("who-is-high-limit", "255"), | ||
| ); err != nil { | ||
| panic(err) | ||
| } | ||
| // Wait for 5 seconds for incoming responses | ||
| time.Sleep(time.Second * 5) | ||
| } else { | ||
| connStr := "bacnet-ip://" + os.Args[1] + ":47808" | ||
| log.Info().Str("connection string", connStr).Msg("Using manually provided bacnet gateway") | ||
| connectionStrings = append(connectionStrings, connStr) | ||
| } | ||
|
|
||
| for _, connStr := range connectionStrings { | ||
| log.Info().Str("connection string", connStr).Msg("Connecting") | ||
| crc := driverManager.GetConnection(connStr) | ||
|
|
||
| // Wait for the driver to connect (or not) | ||
| connectionResult := <-crc | ||
| if connectionResult.GetErr() != nil { | ||
| log.Error().Msgf("error connecting to PLC: %s", connectionResult.GetErr().Error()) | ||
| return | ||
| } | ||
| log.Info().Str("connection string", connStr).Msg("Connected") | ||
| connection := connectionResult.GetConnection() | ||
| defer connection.BlockingClose() | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,224 @@ | ||
| /* | ||
| * 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 bacnetip | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "net" | ||
| "net/url" | ||
| "strconv" | ||
| "time" | ||
|
|
||
| "github.com/IBM/netaddr" | ||
| "github.com/pkg/errors" | ||
| "github.com/rs/zerolog/log" | ||
|
|
||
| "github.com/apache/plc4x/plc4go/internal/spi" | ||
| internalModel "github.com/apache/plc4x/plc4go/internal/spi/model" | ||
| "github.com/apache/plc4x/plc4go/internal/spi/options" | ||
| "github.com/apache/plc4x/plc4go/internal/spi/transports" | ||
| "github.com/apache/plc4x/plc4go/internal/spi/transports/udp" | ||
| apiModel "github.com/apache/plc4x/plc4go/pkg/api/model" | ||
| driverModel "github.com/apache/plc4x/plc4go/protocols/bacnetip/readwrite/model" | ||
| ) | ||
|
|
||
| type Discoverer struct { | ||
| messageCodec spi.MessageCodec | ||
| } | ||
|
|
||
| func NewDiscoverer() *Discoverer { | ||
| return &Discoverer{} | ||
| } | ||
|
|
||
| func (d *Discoverer) Discover(callback func(event apiModel.PlcDiscoveryEvent), discoveryOptions ...options.WithDiscoveryOption) error { | ||
| udpTransport := udp.NewTransport() | ||
|
|
||
| allInterfaces, err := net.Interfaces() | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| // If no device is explicitly selected via option, simply use all of them | ||
| // However if a discovery option is present to select a device by name, only | ||
| // add those devices matching any of the given names. | ||
| var interfaces []net.Interface | ||
| deviceNames := options.FilterDiscoveryOptionsDeviceName(discoveryOptions) | ||
| if len(deviceNames) > 0 { | ||
| for _, curInterface := range allInterfaces { | ||
| for _, deviceNameOption := range deviceNames { | ||
| if curInterface.Name == deviceNameOption.GetDeviceName() { | ||
| interfaces = append(interfaces, curInterface) | ||
| break | ||
| } | ||
| } | ||
| } | ||
| } else { | ||
| interfaces = allInterfaces | ||
| } | ||
|
|
||
| var whoIsLowLimit *uint | ||
| var whoIsHighLimit *uint | ||
| for _, protocolSpecificOption := range options.FilterDiscoveryOptionProtocolSpecific(discoveryOptions) { | ||
| switch protocolSpecificOption.GetKey() { | ||
| case "who-is-low-limit": | ||
| whoIsLowLimitParsed, err := strconv.ParseUint(fmt.Sprintf("%v", protocolSpecificOption.GetValue()), 10, 8) | ||
| if err != nil { | ||
| return errors.Wrap(err, "Error parsing option") | ||
| } | ||
| whoIsLowLimitParsedUint := uint(whoIsLowLimitParsed) | ||
| whoIsLowLimit = &whoIsLowLimitParsedUint | ||
| case "who-is-high-limit": | ||
| whoIsHighLimitParsed, err := strconv.ParseUint(fmt.Sprintf("%v", protocolSpecificOption.GetValue()), 10, 8) | ||
| if err != nil { | ||
| return errors.Wrap(err, "Error parsing option") | ||
| } | ||
| whoIsHighLimitParsedUint := uint(whoIsHighLimitParsed) | ||
| whoIsHighLimit = &whoIsHighLimitParsedUint | ||
| } | ||
| } | ||
| if whoIsLowLimit != nil && whoIsHighLimit == nil || whoIsLowLimit == nil && whoIsHighLimit != nil { | ||
| return errors.Errorf("who-is high-limit must be specified together") | ||
| } | ||
|
|
||
| var tranportInstances []transports.TransportInstance | ||
| // Iterate over all network devices of this system. | ||
| for _, networkInterface := range interfaces { | ||
| unicastInterfaceAddress, err := networkInterface.Addrs() | ||
| if err != nil { | ||
| return errors.Wrapf(err, "Error getting Addresses for %v", networkInterface) | ||
| } | ||
| // Iterate over all addresses the current interface has configured | ||
| for _, unicastAddress := range unicastInterfaceAddress { | ||
| var ipAddr net.IP | ||
| switch addr := unicastAddress.(type) { | ||
| // If the device is configured to communicate with a subnet | ||
| case *net.IPNet: | ||
| ipAddr = addr.IP.To4() | ||
| if ipAddr == nil { | ||
| ipAddr = addr.IP.To16() | ||
| } | ||
|
|
||
| // If the device is configured for a point-to-point connection | ||
| case *net.IPAddr: | ||
| ipAddr = addr.IP.To4() | ||
| if ipAddr == nil { | ||
| ipAddr = addr.IP.To16() | ||
| } | ||
| default: | ||
| continue | ||
| } | ||
|
|
||
| if !ipAddr.IsGlobalUnicast() { | ||
| continue | ||
| } | ||
| _, cidr, _ := net.ParseCIDR(unicastAddress.String()) | ||
| broadcastAddr := netaddr.BroadcastAddr(cidr) | ||
| udpAddr := &net.UDPAddr{IP: broadcastAddr, Port: 0xBAC0} | ||
| connectionUrl, err := url.Parse(fmt.Sprintf("udp://%s", udpAddr)) | ||
| if err != nil { | ||
| log.Debug().Err(err).Msg("error parsing url") | ||
| continue | ||
| } | ||
| localAddr := &net.UDPAddr{IP: ipAddr, Port: 0xBAC0} | ||
| transportInstance, err := | ||
| udpTransport.CreateTransportInstanceForLocalAddress(*connectionUrl, nil, localAddr) | ||
| if err != nil { | ||
| log.Debug().Err(err).Msg("error creating transport instance") | ||
| return err | ||
| } | ||
| tranportInstances = append(tranportInstances, transportInstance) | ||
| } | ||
| } | ||
|
|
||
| for _, transportInstance := range tranportInstances { | ||
| // Create a codec for sending and receiving messages. | ||
| codec := NewMessageCodec(transportInstance) | ||
| // Explicitly start the worker | ||
| if err := codec.Connect(); err != nil { | ||
| return errors.Wrap(err, "Error connecting") | ||
| } | ||
|
|
||
| // Cast to the UDP transport instance so we can access information on the local port. | ||
| udpTransportInstance, ok := transportInstance.(*udp.TransportInstance) | ||
| if !ok { | ||
| return errors.New("couldn't cast transport instance to UDP transport instance") | ||
| } | ||
| _ = udpTransportInstance | ||
|
|
||
| // Prepare the discovery packet data | ||
| var lowLimit driverModel.BACnetContextTagUnsignedInteger | ||
| if whoIsLowLimit != nil { | ||
| lowLimit = driverModel.CreateBACnetContextTagUnsignedInteger(0, *whoIsLowLimit) | ||
| } | ||
| var highLimit driverModel.BACnetContextTagUnsignedInteger | ||
| if whoIsHighLimit != nil { | ||
| highLimit = driverModel.CreateBACnetContextTagUnsignedInteger(1, *whoIsHighLimit) | ||
| } | ||
| requestWhoIs := driverModel.NewBACnetUnconfirmedServiceRequestWhoIs(lowLimit, highLimit, 0) | ||
| apdu := driverModel.NewAPDUUnconfirmedRequest(requestWhoIs, 0) | ||
|
|
||
| control := driverModel.NewNPDUControl(false, false, false, false, driverModel.NPDUNetworkPriority_NORMAL_MESSAGE) | ||
| npdu := driverModel.NewNPDU(1, control, nil, nil, nil, nil, nil, nil, nil, nil, apdu, 0) | ||
| bvlc := driverModel.NewBVLCOriginalUnicastNPDU(npdu, 0) | ||
|
|
||
| // Send the search request. | ||
| err = codec.Send(bvlc) | ||
| go func() { | ||
| // Keep on reading responses till the timeout is done. | ||
| // TODO: Make this configurable | ||
| timeout := time.NewTimer(time.Second * 1) | ||
| timeout.Stop() | ||
| for start := time.Now(); time.Since(start) < time.Second*5; { | ||
| timeout.Reset(time.Second * 1) | ||
| select { | ||
| case message := <-codec.GetDefaultIncomingMessageChannel(): | ||
| { | ||
| if !timeout.Stop() { | ||
| <-timeout.C | ||
| } | ||
| _ = message | ||
| deviceName := "todo" | ||
| remoteUrl, err := url.Parse("udp://todo") | ||
| if err != nil { | ||
| log.Debug().Err(err).Msg("Error parsing url") | ||
| continue | ||
| } | ||
| discoveryEvent := &internalModel.DefaultPlcDiscoveryEvent{ | ||
| ProtocolCode: "bacnet-ip", | ||
| TransportCode: "udp", | ||
| TransportUrl: *remoteUrl, | ||
| Options: nil, | ||
| Name: deviceName, | ||
| } | ||
| // Pass the event back to the callback | ||
| callback(discoveryEvent) | ||
| } | ||
| continue | ||
| case <-timeout.C: | ||
| { | ||
| timeout.Stop() | ||
| continue | ||
| } | ||
| } | ||
| } | ||
| }() | ||
| } | ||
| return nil | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.