diff --git a/.github/workflows/workflow.yaml b/.github/workflows/workflow.yaml new file mode 100644 index 0000000..5f9fd64 --- /dev/null +++ b/.github/workflows/workflow.yaml @@ -0,0 +1,49 @@ +name: workflow + +on: + pull_request: + release: + types: [created] + +env: + REGISTRY: ghcr.io + +jobs: + build: + runs-on: ubuntu-latest + permissions: + contents: read + packages: write + pull-requests: read + + steps: + - + name: Checkout + uses: actions/checkout@v3 + - + name: Set up Docker Buildx + uses: docker/setup-buildx-action@v2 + - + name: Docker meta + id: meta + uses: docker/metadata-action@v4 + with: + images: ${{ env.REGISTRY }}/${{ github.repository }} + - + name: Login to GitHub Container Registry + uses: docker/login-action@v2 + with: + registry: ${{ env.REGISTRY }} + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + - + name: Build and push + uses: docker/build-push-action@v4 + with: + context: . + push: true + tags: ${{ steps.meta.outputs.tags }} + labels: ${{ steps.meta.outputs.labels }} + platforms: linux/arm/v7,linux/arm64 + cache-from: type=gha + cache-to: type=gha,mode=max diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..1e9acb2 --- /dev/null +++ b/.gitignore @@ -0,0 +1,22 @@ +# If you prefer the allow list template instead of the deny list, see community template: +# https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore +# +# Binaries for programs and plugins +*.exe +*.exe~ +*.dll +*.so +*.dylib + +# Test binary, built with `go test -c` +*.test + +# Output of the go coverage tool, specifically when used with LiteIDE +*.out + +# Dependency directories (remove the comment below to include it) +# vendor/ + +# Go workspace file +go.work +cmd/meross-lan-api/meross-lan-api \ No newline at end of file diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..50518ea --- /dev/null +++ b/Dockerfile @@ -0,0 +1,15 @@ +FROM golang:1.20-alpine AS build_base +WORKDIR /build +COPY go.mod . +COPY go.sum . +RUN go mod download +COPY . . +RUN cd cmd/meross-lan-api && \ + go build -o /build/out/my-app . + +# Start fresh from a smaller image +FROM alpine:3.17.2 +RUN apk add ca-certificates +COPY --from=build_base /build/out/my-app /app/meross-lan-api +WORKDIR /app +CMD ["/app/meross-lan-api"] diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..b09cd78 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ +Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed 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 + + http://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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..285e18c --- /dev/null +++ b/README.md @@ -0,0 +1,63 @@ +# meross-lan-api + Allows control of meross devices over LAN via Rest API + + +## Configuration +Setup devices within `configuration.yaml`, see example. +Also an environment variable is required for `KEY` which is your meross device key. + +## API Endpoints + +`/deviceList` +`/status/` +`/turnOn/` +`/turnOff/` + +## Meross commands via Curl + +`MessageId` - Random hex string characters in length. +`Sign` - Sign is an MD5 hash of (MessageId + Your Key + Timestamp). + +**GET** +``` +curl -X POST -H "Content-Type: application/json; charset=UTF-8" http://192.168.1.175/config \ + -d '{ + "header": { + "messageId": "af3fc9534c0e4727b5816bd5470fbb51", + "namespace": "Appliance.System.All", + "method": "GET", + "payloadVersion": 1, + "from": "Meross", + "timestamp": 1678292549, + "timestampMs": 0, + "sign": "lll51743a3c75528k097ebfa921e0790" + }, + "payload": { + "all": {} + } + }' +``` + +**SET** +``` +curl -X POST -H "Content-Type: application/json; charset=UTF-8" http://192.168.1.45/config \ + -d '{ + "header": { + "messageId": "a3c648b943cfbbd4c00b4800ce367c91", + "method": "SET", + "namespace": "Appliance.Control.ToggleX", + "payloadVersion": 1, + "sign": "h0436f1fe4523a5609623e3b9f881e61", + "timestamp": 1678279320 + }, + "payload": { + "togglex": { + "channel": 0, + "onoff": 0 + } + } + }' +``` + +## References +https://github.com/arandall/meross/blob/main/doc/protocol.md#headers diff --git a/cmd/meross-lan-api/apiserver.go b/cmd/meross-lan-api/apiserver.go new file mode 100644 index 0000000..2e6d466 --- /dev/null +++ b/cmd/meross-lan-api/apiserver.go @@ -0,0 +1,107 @@ +package main + +import ( + "fmt" + "log" + "net/http" + "strconv" + "strings" + "sync" +) + +type APIServer struct{} + +type ErrorResponse struct { + Error string +} + +type SuccessResponse struct { + Message string +} + +func (apiServer APIServer) Start() { + var wg sync.WaitGroup + log.Println("Starting API server...") + http.HandleFunc("/", apiServer.Endpoint) + wg.Add(1) + go http.ListenAndServe(":8080", nil) + log.Println("API Server started...") + wg.Wait() +} + +func (apiServer APIServer) Endpoint(w http.ResponseWriter, r *http.Request) { + switch path := r.URL.Path[1:]; { + case path == "deviceList" || path == "": + apiServer.deviceList(w) + case strings.HasPrefix(path, "status/"): + apiServer.deviceStatus(w, strings.Split(path, "status/")[1]) + case strings.HasPrefix(path, "turnOn/"): + apiServer.turnOn(w, strings.Split(path, "turnOn/")[1]) + case strings.HasPrefix(path, "turnOff/"): + apiServer.turnOff(w, strings.Split(path, "turnOff/")[1]) + case path == "health/live" || path == "health/ready": + fmt.Fprintf(w, "ok") + } +} + +func getDevice(name string) (Device, ErrorResponse) { + var device Device + var err ErrorResponse + for _, d := range config.Devices { + if d.Name == name { + return d, err + } + } + err.Error = "Device not found." + return device, err +} + +func getStatusString(device Device) string { + status := getStatus(device.IP, device.Channel, config.Key) + if status == 1 { + return "on" + } else if status == 0 { + return "off" + } else { + return "Unknown status: " + strconv.Itoa(status) + } +} + +func (apiServer APIServer) deviceList(w http.ResponseWriter) { + var devices []Device + for _, d := range config.Devices { + d.Status = getStatusString(d) + devices = append(devices, d) + } + writeResponse(w, devices) +} + +func (apiServer APIServer) deviceStatus(w http.ResponseWriter, deviceName string) { + device, err := getDevice(deviceName) + if err.Error != "" { + writeResponse(w, err) + return + } + device.Status = getStatusString(device) + writeResponse(w, device) +} + +func (apiServer APIServer) turnOn(w http.ResponseWriter, deviceName string) { + device, err := getDevice(deviceName) + if err.Error != "" { + writeResponse(w, err) + return + } + turnOn(device.IP, device.Channel, config.Key) + apiServer.deviceStatus(w, device.Name) +} + +func (apiServer APIServer) turnOff(w http.ResponseWriter, deviceName string) { + device, err := getDevice(deviceName) + if err.Error != "" { + writeResponse(w, err) + return + } + turnOff(device.IP, device.Channel, config.Key) + apiServer.deviceStatus(w, device.Name) +} diff --git a/cmd/meross-lan-api/config.go b/cmd/meross-lan-api/config.go new file mode 100644 index 0000000..0d6db8a --- /dev/null +++ b/cmd/meross-lan-api/config.go @@ -0,0 +1,61 @@ +package main + +import ( + "io/ioutil" + "log" + "os" + "strings" + + "gopkg.in/yaml.v2" +) + +type Config struct { + Debug bool + File string + Devices []Device `yaml:"devices"` + Key string +} + +type Device struct { + Name string `yaml:"name"` + IP string `yaml:"ip"` + Channel int `yaml:"channel"` + Status string +} + +func (config Config) Load() Config { + log.Println("Loading configuration...") + + // debug + if strings.ToLower(os.Getenv("DEBUG")) == "true" { + config.Debug = true + } else { + config.Debug = false + } + + // config file path + config.File = os.Getenv("CONFIG_FILE") + if config.File == "" { + config.File = "configuration.yaml" + } + + // secret key + config.Key = os.Getenv("KEY") + if config.Key == "" { + log.Fatal("Environment variable 'KEY' must be specified.") + } + + // load yaml from file + yamlFile, err := ioutil.ReadFile(config.File) + if err != nil { + log.Fatal(err) + } + err = yaml.Unmarshal(yamlFile, &config) + if err != nil { + log.Fatal(err) + } + + log.Println("Configuration loaded...") + + return config +} diff --git a/cmd/meross-lan-api/configuration.yaml b/cmd/meross-lan-api/configuration.yaml new file mode 100644 index 0000000..ee7c84c --- /dev/null +++ b/cmd/meross-lan-api/configuration.yaml @@ -0,0 +1,7 @@ +devices: + - name: porch + ip: 192.168.1.45 + channel: 0 + - name: fly-heater + ip: 192.168.1.107 + channel: 2 diff --git a/cmd/meross-lan-api/functions.go b/cmd/meross-lan-api/functions.go new file mode 100644 index 0000000..ce0198e --- /dev/null +++ b/cmd/meross-lan-api/functions.go @@ -0,0 +1,20 @@ +package main + +import ( + "encoding/json" + "fmt" + "log" + "net/http" +) + +// writes api response to webpage and app log +func writeResponse(w http.ResponseWriter, response any) { + responseString, err := json.Marshal(response) + if err != nil { + log.Printf("Error writing API response: %v", err) + fmt.Fprintf(w, "Error writing API response: %v", err) + return + } + log.Println(string(responseString)) + json.NewEncoder(w).Encode(response) +} diff --git a/cmd/meross-lan-api/main.go b/cmd/meross-lan-api/main.go new file mode 100644 index 0000000..f1c6b7f --- /dev/null +++ b/cmd/meross-lan-api/main.go @@ -0,0 +1,17 @@ +package main + +import ( + "log" +) + +var ( + config Config + apiServer APIServer +) + +func main() { + log.Println("Starting...") + + config = config.Load() + apiServer.Start() +} diff --git a/cmd/meross-lan-api/meross.go b/cmd/meross-lan-api/meross.go new file mode 100644 index 0000000..85e2614 --- /dev/null +++ b/cmd/meross-lan-api/meross.go @@ -0,0 +1,169 @@ +package main + +import ( + "bytes" + "crypto/md5" + "crypto/rand" + "encoding/hex" + "encoding/json" + "fmt" + "io/ioutil" + "log" + "net/http" + "net/http/httputil" + "strconv" + "time" +) + +type Request struct { + Header Header `json:"header"` + Payload RequestPayload `json:"payload"` +} + +type Header struct { + // MessageID is used to identify a request/response pair. + From string `json:"from,omnitempty"` + MessageID string `json:"messageId,omitempty"` + Method string `json:"method,omitempty"` + Namespace string `json:"namespace,omitempty"` + PayloadVersion int `json:"payloadVersion,omitempty"` + Signature string `json:"sign,omitempty"` + Timestamp int64 `json:"timestamp,omitempty"` + TimestampMs int64 `json:"timestampMs,omitempty"` +} + +type RequestPayload struct { + ToggleX struct { + Channel int `json:"channel,omitempty"` + OnOff int `json:"onoff,omitempty"` + } + All struct{} +} + +type Response struct { + Header Header `json:"header"` + Payload ResponsePayload `json:"payload"` +} + +type ResponsePayload struct { + All struct { + System struct { + Type string `json:"type,omitempty"` + } + Digest struct { + Togglex []struct { + Channel int `json:"channel,omitempty"` + OnOff int `json:"onoff,omitempty"` + } + } + } +} + +func getStatus(deviceIp string, channel int, key string) int { + body := generateBody(key) + body.Header.Method = "GET" + body.Header.Namespace = "Appliance.System.All" + body.Header.From = "Meross" + response, err := sendRequest(deviceIp, body) + if err != nil { + log.Print(err) + } + + for i := 0; i < len(response.Payload.All.Digest.Togglex); i++ { + if response.Payload.All.Digest.Togglex[i].Channel == channel { + return response.Payload.All.Digest.Togglex[i].OnOff + } + } + + return 2 // should always return 0 or 1 so we'll class this as 'unknown' +} + +func turnOn(deviceIp string, channel int, key string) { + body := generateBody(key) + body.Header.Method = "SET" + body.Header.Namespace = "Appliance.Control.ToggleX" + body.Payload.ToggleX.Channel = channel + body.Payload.ToggleX.OnOff = 1 + _, err := sendRequest(deviceIp, body) + if err != nil { + log.Print(err) + } +} + +func turnOff(deviceIp string, channel int, key string) { + body := generateBody(key) + body.Header.Method = "SET" + body.Header.Namespace = "Appliance.Control.ToggleX" + body.Payload.ToggleX.Channel = channel + body.Payload.ToggleX.OnOff = 0 + _, err := sendRequest(deviceIp, body) + if err != nil { + log.Print(err) + } +} + +func sendRequest(deviceIp string, body Request) (Response, error) { + var result Response + // convert body to bytes + bodyJSON, _ := json.Marshal(body) + + // create and send request + req, err := http.NewRequest("POST", "http://"+deviceIp+"/config", bytes.NewBuffer(bodyJSON)) + req.Header.Add("Content-Type", "application/json; charset=UTF-8") + resp, err := http.DefaultClient.Do(req) + if err != nil { + return result, err + } + defer resp.Body.Close() + + // read response body + respBody, err := ioutil.ReadAll(resp.Body) + if err != nil { + return result, err + } + + // if non-200 status code or debug enabled then dump out request/response info + if config.Debug || resp.StatusCode != 200 { + requestDump, err := httputil.DumpRequest(req, true) + if err != nil { + fmt.Println(err) + } + fmt.Printf("Request\n: %v", string(requestDump)) + fmt.Printf("%+v\n\n", body) + + responseDump, err := httputil.DumpResponse(resp, true) + if err != nil { + fmt.Println(err) + } + fmt.Printf("Response\n: %v\n\n", string(responseDump)) + } + + // convert response to Response type + if err := json.Unmarshal(respBody, &result); err != nil { // Parse []byte to go struct pointer + fmt.Println(err) + } + return result, nil +} + +// random hex code string, length 32 +func generateMessageId() (string, error) { + bytes := make([]byte, 32) + if _, err := rand.Read(bytes); err != nil { + return "", err + } + return hex.EncodeToString(bytes)[:32], nil +} + +func generateBody(key string) Request { + var body Request + + body.Header.PayloadVersion = 1 + body.Header.MessageID, _ = generateMessageId() + body.Header.Timestamp = time.Now().Unix() + body.Header.Signature = fmt.Sprintf("%x", md5.Sum([]byte(body.Header.MessageID+key+strconv.Itoa(int(body.Header.Timestamp))))) + + if config.Debug { + log.Printf("Body: %+v\n", body) + } + return body +} diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..a8e9025 --- /dev/null +++ b/go.mod @@ -0,0 +1,5 @@ +module github.com/alec-pinson/meross-lan-api + +go 1.20 + +require gopkg.in/yaml.v2 v2.4.0 diff --git a/go.sum b/go.sum new file mode 100644 index 0000000..dd0bc19 --- /dev/null +++ b/go.sum @@ -0,0 +1,4 @@ +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY= +gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ=