├── README.md ├── .gitignore ├── go.mod ├── pkg └── transforms │ ├── conversion.go │ └── mqtt.go ├── examples └── ibm-export │ ├── res │ └── configuration.toml │ └── main.go └── LICENSE /README.md: -------------------------------------------------------------------------------- 1 | # app-functions-ibmiot 2 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | go.sum 2 | /log/ 3 | .vscode/* 4 | -------------------------------------------------------------------------------- /go.mod: -------------------------------------------------------------------------------- 1 | module github.com/edgexfoundry-holding/app-functions-ibmiot 2 | 3 | go 1.16 4 | 5 | require ( 6 | github.com/edgexfoundry/app-functions-sdk-go v0.2.1 7 | github.com/edgexfoundry/go-mod-core-contracts v0.2.1 8 | ) 9 | -------------------------------------------------------------------------------- /pkg/transforms/conversion.go: -------------------------------------------------------------------------------- 1 | package transforms 2 | 3 | import ( 4 | "encoding/json" 5 | "errors" 6 | "fmt" 7 | 8 | "github.com/edgexfoundry/app-functions-sdk-go/appcontext" 9 | "github.com/edgexfoundry/go-mod-core-contracts/models" 10 | ) 11 | 12 | // Conversion Struct 13 | type Conversion struct { 14 | } 15 | 16 | // NewConversion returns a conversion struct 17 | func NewConversion() Conversion { 18 | return Conversion{} 19 | } 20 | 21 | // TransformToIBMIoT converts the event into IBMIoT readable format 22 | func (f Conversion) TransformToIBMIoT(edgexcontext *appcontext.Context, params ...interface{}) (continuePipeline bool, stringType interface{}) { 23 | if len(params) < 1 { 24 | return false, errors.New("No Event Received") 25 | } 26 | 27 | edgexcontext.LoggingClient.Debug("Transforming to IBMIoT format") 28 | 29 | if event, ok := params[0].(models.Event); ok { 30 | readings := map[string]interface{}{} 31 | 32 | // IBMIoT MQTT Format requires { "d": {} } 33 | // { "d": {"_type": "event", "readingname":"readingvalue"} } 34 | for _, reading := range event.Readings { 35 | readings[reading.Name] = reading.Value 36 | } 37 | 38 | msg, err := json.Marshal(readings) 39 | if err != nil { 40 | return false, errors.New(fmt.Sprintf("Failed to transform IBMIoT data: %s", err)) 41 | } 42 | 43 | return true, string(msg) 44 | } 45 | 46 | return false, errors.New("Unexpected type received") 47 | } 48 | -------------------------------------------------------------------------------- /examples/ibm-export/res/configuration.toml: -------------------------------------------------------------------------------- 1 | [Writable] 2 | LogLevel = 'DEBUG' 3 | 4 | [Service] 5 | BootTimeout = 30000 6 | ClientMonitor = 15000 7 | CheckInterval = '10s' 8 | Host = 'localhost' 9 | Port = 48095 10 | Protocol = 'http' 11 | ReadMaxLimit = 100 12 | StartupMsg = 'IBM Watson IoT Export Service' 13 | Timeout = 5000 14 | 15 | [Registry] 16 | Host = 'localhost' 17 | Port = 8500 18 | Type = 'consul' 19 | 20 | [Clients] 21 | [Clients.CoreData] 22 | Protocol = 'http' 23 | Host = 'localhost' 24 | Port = 48080 25 | [Clients.Logging] 26 | Protocol = "http" 27 | Host = "localhost" 28 | Port = 48061 29 | 30 | [MessageBus] 31 | Type = 'zero' 32 | [MessageBus.PublishHost] 33 | Host = '*' 34 | Port = 5564 35 | Protocol = 'tcp' 36 | [MessageBus.SubscribeHost] 37 | Host = 'localhost' 38 | Port = 5563 39 | Protocol = 'tcp' 40 | 41 | [Logging] 42 | EnableRemote = false 43 | File = './logs/ibm-export.log' 44 | 45 | [Binding] 46 | Type="messagebus" 47 | SubscribeTopic="events" 48 | PublishTopic="" 49 | 50 | [ApplicationSettings] 51 | IBMIoTMQTTHost = ".messaging.internetofthings.ibmcloud.com" 52 | IBMIoTMQTTPort = "8883" 53 | IBMIoTOrg = "abc123" 54 | IBMIoTDeviceType = "testDeviceType" 55 | IBMIoTDeviceID = "testDeviceID" 56 | MQTTCert = "/path/to.cert.pem" 57 | MQTTKey = "/path/to.private.key" 58 | topic = "iot-2/evt/status/fmt/json" 59 | -------------------------------------------------------------------------------- /examples/ibm-export/main.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "fmt" 5 | "os" 6 | 7 | IBMIoTTransforms "github.com/edgexfoundry-holding/app-functions-ibmiot/pkg/transforms" 8 | "github.com/edgexfoundry/app-functions-sdk-go/appcontext" 9 | "github.com/edgexfoundry/app-functions-sdk-go/appsdk" 10 | "github.com/edgexfoundry/app-functions-sdk-go/pkg/transforms" 11 | ) 12 | 13 | const ( 14 | serviceKey = "IBMExport" 15 | ) 16 | 17 | func main() { 18 | 19 | // 1) First thing to do is to create an instance of the EdgeX SDK and initialize it. 20 | edgexSdk := &appsdk.AppFunctionsSDK{ServiceKey: serviceKey} 21 | if err := edgexSdk.Initialize(); err != nil { 22 | edgexSdk.LoggingClient.Error(fmt.Sprintf("SDK initialization failed: %v\n", err)) 23 | os.Exit(-1) 24 | } 25 | 26 | // 2) Since our DeviceNameFilter Function requires the list of device names we would 27 | // like to search for, we'll go ahead and define that now. 28 | deviceName := []string{"Random-Integer-Generator01"} 29 | 30 | // 3) This is our pipeline configuration, the collection of functions to 31 | // execute every time an event is triggered. 32 | 33 | // Load IBMIoT-specific MQTT configuration from App SDK 34 | // You can also create IBMIoTMQTTConfig struct yourself 35 | config, err := IBMIoTTransforms.LoadIBMIoTMQTTConfig(edgexSdk) 36 | if err != nil { 37 | edgexSdk.LoggingClient.Error(fmt.Sprintf("Failed to load IBMIoT MQTT configurations: %v\n", err)) 38 | os.Exit(-1) 39 | } 40 | 41 | edgexSdk.SetFunctionsPipeline( 42 | transforms.NewFilter(deviceName).FilterByDeviceName, 43 | IBMIoTTransforms.NewConversion().TransformToIBMIoT, 44 | printIBMIoTDataToConsole, 45 | IBMIoTTransforms.NewIBMIoTMQTTSender(edgexSdk.LoggingClient, config).MQTTSend, 46 | ) 47 | 48 | // 5) Lastly, we'll go ahead and tell the SDK to "start" and begin listening for events 49 | // to trigger the pipeline. 50 | err = edgexSdk.MakeItRun() 51 | if err != nil { 52 | edgexSdk.LoggingClient.Error("MakeItRun returned error: ", err.Error()) 53 | os.Exit(-1) 54 | } 55 | 56 | // Do any required cleanup here 57 | 58 | os.Exit(0) 59 | } 60 | 61 | func printIBMIoTDataToConsole(edgexcontext *appcontext.Context, params ...interface{}) (bool, interface{}) { 62 | 63 | if len(params) < 1 { 64 | // We didn't receive a result 65 | return false, nil 66 | } 67 | 68 | fmt.Println(params[0].(string)) 69 | 70 | // Leverage the built in logging service in EdgeX 71 | edgexcontext.LoggingClient.Debug("Printed to console") 72 | 73 | edgexcontext.Complete([]byte(params[0].(string))) 74 | return false, nil 75 | 76 | } 77 | -------------------------------------------------------------------------------- /pkg/transforms/mqtt.go: -------------------------------------------------------------------------------- 1 | package transforms 2 | 3 | import ( 4 | "crypto/tls" 5 | "errors" 6 | "fmt" 7 | "net/http" 8 | "strconv" 9 | "time" 10 | 11 | "github.com/edgexfoundry/app-functions-sdk-go/appsdk" 12 | sdkTransforms "github.com/edgexfoundry/app-functions-sdk-go/pkg/transforms" 13 | "github.com/edgexfoundry/go-mod-core-contracts/clients/logger" 14 | "github.com/edgexfoundry/go-mod-core-contracts/models" 15 | ) 16 | 17 | const ( 18 | IBMIoTMQTTHost = "IBMIoTMQTTHost" 19 | IBMIoTMQTTPort = "IBMIoTMQTTPort" 20 | IBMIoTDeviceType = "IBMIoTDeviceType" 21 | IBMIoTDeviceID = "IBMIoTDeviceID" 22 | IBMIoTRootCAFilename = "CaCertPath" 23 | IBMIoTCertFilename = "MQTTCert" 24 | IBMIoTPrivateKeyFilename = "MQTTKey" 25 | user = "use-token-auth" 26 | topic = "iot-2/evt/status/fmt/json" 27 | ) 28 | 29 | var log logger.LoggingClient 30 | 31 | // type certPair struct { 32 | // Cert string `json:"cert,omitempty"` 33 | // Key string `json:"key,omitempty"` 34 | // } 35 | 36 | // IBMIoTMQTTConfig holds IBM IoT specific information 37 | type IBMIoTMQTTConfig struct { 38 | MQTTConfig *sdkTransforms.MqttConfig 39 | IoTHost string 40 | IoTPort string 41 | IoTDevice string 42 | IoTTopic string 43 | KeyCertPair *sdkTransforms.KeyCertPair 44 | } 45 | 46 | func getNewClient(skipVerify bool) *http.Client { 47 | tr := &http.Transport{ 48 | TLSClientConfig: &tls.Config{InsecureSkipVerify: skipVerify}, 49 | } 50 | 51 | return &http.Client{Timeout: 10 * time.Second, Transport: tr} 52 | } 53 | 54 | func getAppSetting(settings map[string]string, name string) string { 55 | value, ok := settings[name] 56 | 57 | if ok { 58 | log.Debug(value) 59 | return value 60 | } 61 | log.Error(fmt.Sprintf("ApplicationName application setting %s not found", name)) 62 | return "" 63 | 64 | } 65 | 66 | // LoadAWSMQTTConfig Loads the mqtt configuration necessary to connect to AWS cloud 67 | func LoadIBMIoTMQTTConfig(sdk *appsdk.AppFunctionsSDK) (*IBMIoTMQTTConfig, error) { 68 | if sdk == nil { 69 | return nil, errors.New("Invalid AppFunctionsSDK") 70 | } 71 | 72 | log = sdk.LoggingClient 73 | 74 | var ioTHost, iotPort, iotDevice, mqttCert, mqttKey, ioTTopic string 75 | 76 | appSettings := sdk.ApplicationSettings() 77 | if appSettings != nil { 78 | ioTHost = getAppSetting(appSettings, IBMIoTMQTTHost) 79 | iotPort = getAppSetting(appSettings, IBMIoTMQTTPort) 80 | iotDevice = getAppSetting(appSettings, IBMIoTThingName) 81 | mqttCert = getAppSetting(appSettings, IBMIoTCertFilename) 82 | mqttKey = getAppSetting(appSettings, IBMIoTPrivateKeyFilename) 83 | ioTTopic = getAppSetting(appSettings, topic) 84 | } else { 85 | return nil, errors.New("No application-specific settings found") 86 | } 87 | 88 | config := IBMIoTMQTTConfig{} 89 | 90 | config.IoTHost = ioTHost 91 | config.IoTPort = iotPort 92 | config.IoTDevice = iotDevice 93 | config.IoTTopic = ioTTopic 94 | config.MQTTConfig = sdkTransforms.NewMqttConfig() 95 | 96 | pair := &sdkTransforms.KeyCertPair{ 97 | KeyFile: mqttKey, 98 | CertFile: mqttCert, 99 | } 100 | 101 | config.KeyCertPair = pair 102 | 103 | return &config, nil 104 | } 105 | 106 | // NewIBMIoTMQTTSender return a mqtt sender capable of sending the event's value to the given MQTT broker 107 | func NewIBMIoTMQTTSender(logging logger.LoggingClient, config *IBMIoTMQTTConfig) *sdkTransforms.MQTTSender { 108 | 109 | logging.Debug(config.IoTTopic) 110 | 111 | port, err := strconv.Atoi(config.IoTPort) 112 | if err != nil { 113 | // falling back to default IBM IoT port 114 | port = 8883 115 | } 116 | 117 | addressable := models.Addressable{ 118 | Address: config.IoTHost, 119 | Port: port, 120 | Protocol: "tls", 121 | Publisher: "d:org:devicetype:"+config.IoTDevice, 122 | User: "", 123 | Password: "", 124 | Topic: config.IoTTopic, 125 | } 126 | 127 | mqttSender := sdkTransforms.NewMQTTSender(logging, addressable, config.KeyCertPair, config.MQTTConfig) 128 | 129 | return mqttSender 130 | } 131 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------