Initial commit

.clang-format

@@ -0,0 +1,100 @@
+---
+Language:        Cpp
+AccessModifierOffset: -1
+AlignAfterOpenBracket: DontAlign
+AlignConsecutiveAssignments: false
+AlignConsecutiveDeclarations: false
+AlignEscapedNewlines: Right
+AlignOperands:   false
+AlignTrailingComments: false
+AllowAllParametersOfDeclarationOnNextLine: true
+AllowShortBlocksOnASingleLine: false
+AllowShortCaseLabelsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: None
+AllowShortIfStatementsOnASingleLine: false
+AllowShortLambdasOnASingleLine: All
+AllowShortLoopsOnASingleLine: false
+AlwaysBreakAfterDefinitionReturnType: None
+AlwaysBreakAfterReturnType: None
+AlwaysBreakBeforeMultilineStrings: true
+AlwaysBreakTemplateDeclarations: false
+BinPackArguments: false
+BinPackParameters: false
+BraceWrapping:
+  AfterClass:      false
+  AfterControlStatement: false
+  AfterEnum:       false
+  AfterFunction:   true
+  AfterNamespace:  false
+  AfterObjCDeclaration: false
+  AfterStruct:     false
+  AfterUnion:      false
+  AfterExternBlock: false
+  BeforeCatch:     true
+  BeforeElse:      true
+  IndentBraces:    false
+  SplitEmptyFunction: true
+  SplitEmptyRecord: true
+  SplitEmptyNamespace: true
+  BeforeLambdaBody: false
+BreakBeforeBinaryOperators: None
+BreakBeforeBraces: Custom
+BreakBeforeInheritanceComma: false
+BreakBeforeTernaryOperators: true
+BreakConstructorInitializersBeforeComma: false
+BreakConstructorInitializers: BeforeColon
+BreakAfterJavaFieldAnnotations: false
+BreakStringLiterals: false
+ColumnLimit:     0
+CommentPragmas:  '^ IWYU pragma:'
+CompactNamespaces: false
+ConstructorInitializerAllOnOneLineOrOnePerLine: true
+ConstructorInitializerIndentWidth: 2
+ContinuationIndentWidth: 2
+Cpp11BracedListStyle: false
+DerivePointerAlignment: false
+DisableFormat:   false
+ExperimentalAutoDetectBinPacking: false
+FixNamespaceComments: false
+IncludeBlocks:   Preserve
+IncludeCategories:
+  - Regex:           '^<'
+    Priority:        -2
+  - Regex:           '.*'
+    Priority:        -1
+IncludeIsMainRegex: '(Test)?$'
+IndentCaseLabels: true
+IndentPPDirectives: None
+IndentWidth:     2
+IndentWrappedFunctionNames: true
+LambdaBodyIndentation: Signature
+KeepEmptyLinesAtTheStartOfBlocks: false
+MacroBlockBegin: ''
+MacroBlockEnd:   ''
+MaxEmptyLinesToKeep: 1
+NamespaceIndentation: All
+PenaltyBreakAssignment: 2
+PenaltyBreakBeforeFirstCallParameter: 19
+PenaltyBreakComment: 300
+PenaltyBreakFirstLessLess: 120
+PenaltyBreakString: 1000
+PenaltyExcessCharacter: 1000000
+PenaltyReturnTypeOnItsOwnLine: 60
+PointerAlignment: Left
+ReflowComments:  true
+SortIncludes:    true
+SortUsingDeclarations: true
+SpaceAfterCStyleCast: false
+SpaceAfterTemplateKeyword: true
+SpaceBeforeAssignmentOperators: true
+SpaceBeforeParens: Never
+SpaceInEmptyParentheses: false
+SpacesBeforeTrailingComments: 1
+SpacesInAngles:  false
+SpacesInContainerLiterals: true
+SpacesInCStyleCastParentheses: false
+SpacesInParentheses: false
+SpacesInSquareBrackets: false
+Standard:        Cpp11
+UseTab:          Never
+...

.github/workflows/test.yml

@@ -0,0 +1,31 @@
+name: Tests
+
+on:
+  push:
+    branches:
+      - main
+
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        os: [ubuntu-22.04, ubuntu-24.04, macos-12, macos-13]
+
+    steps:
+    - name: Install CppUTest
+      uses: lyricwulf/abc@v1
+      with:
+        all: cpputest
+
+    - uses: SimenB/github-actions-cpu-cores@v1
+      id: cpu-cores
+
+    - uses: actions/checkout@v3
+      with:
+        submodules: 'recursive'
+
+    - run: make -j${{ steps.cpu-cores.outputs.count }}

.gitignore

@@ -0,0 +1,4 @@
+.pio
+.vscode/
+build
+.DS_Store

.gitmodules

@@ -0,0 +1,6 @@
+[submodule "lib/tiny"]
+	path = lib/tiny
+	url = https://github.com/ryanplusplus/tiny
+[submodule "lib/tiny-gea3-api"]
+	path = lib/tiny-gea3-api
+	url = https://github.com/geappliances/tiny-gea3-api

.rerun

@@ -0,0 +1,6 @@
+--quiet
+--ignore ./build/**/*
+--no-notify
+-c
+-w 1
+-p **/*.{c,cpp,h,hpp}

.vscode/launch.json

@@ -0,0 +1,33 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Debug",
+      "type": "cppdbg",
+      "request": "launch",
+      "preLaunchTask": "Build",
+      "program": "${workspaceFolder}/build/home-assistant-bridge_tests",
+      "args": [],
+      "stopAtEntry": true,
+      "cwd": "${workspaceFolder}",
+      "environment": [],
+      "externalConsole": false,
+      "linux": {
+        "MIMode": "gdb"
+      },
+      "osx": {
+        "MIMode": "lldb"
+      },
+      "setupCommands": [
+        {
+          "description": "Enable pretty-printing for gdb",
+          "text": "-enable-pretty-printing",
+          "ignoreFailures": true
+        }
+      ]
+    }
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,11 @@
+{
+  "[c]": {
+    "editor.tabSize": 2,
+    "editor.insertSpaces": true
+  },
+  "[cpp]": {
+    "editor.tabSize": 2,
+    "editor.insertSpaces": true
+  },
+  "editor.formatOnSave": true
+}

.vscode/tasks.json

@@ -0,0 +1,12 @@
+{
+  // See https://go.microsoft.com/fwlink/?LinkId=733558
+  // for the documentation about the tasks.json format
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "Build",
+      "type": "shell",
+      "command": "make build/home-assistant-bridge_tests"
+    }
+  ]
+}

LICENSE

@@ -0,0 +1,13 @@
+BSD 3-Clause License
+
+Copyright (c) 2024, GE Appliances
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+    Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+    Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+    Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Makefile

@@ -0,0 +1,72 @@
+TARGET := home-assistant-bridge_tests
+BUILD_DIR := ./build
+
+INC_DIRS := \
+  include \
+  lib/tiny/include \
+  lib/tiny/test/include \
+  lib/tiny-gea3-api/include \
+  lib/tiny-gea3-api/test/include \
+  test/include \
+
+SRC_DIRS := \
+  lib/tiny/src \
+  lib/tiny/test/src \
+  lib/tiny-gea3-api/src \
+  lib/tiny-gea3-api/test/src \
+  test \
+  test/src \
+  test/tests \
+
+SRC_FILES := \
+  src/mqtt_bridge.cpp \
+
+SRCS := $(SRC_FILES) $(shell find $(SRC_DIRS) -maxdepth 1 -name *.cpp -or -name *.c -or -name *.s)
+OBJS := $(SRCS:%=$(BUILD_DIR)/%.o)
+DEPS := $(OBJS:.o=.d)
+
+INC_DIRS += $(shell find $(SRC_DIRS) -type d)
+INC_FLAGS := $(addprefix -I,$(INC_DIRS))
+
+SANITIZE_FLAGS := -fsanitize=address -fsanitize=undefined
+
+CFLAGS += -std=c11 -pedantic
+CPPFLAGS += $(SANITIZE_FLAGS) -fno-omit-frame-pointer
+CPPFLAGS += $(INC_FLAGS) -MMD -MP -g -Wall -Wextra -Wcast-qual -Werror
+CXXFLAGS += -std=c++17
+LDFLAGS := $(SANITIZE_FLAGS)
+LDLIBS := -lstdc++ -lCppUTest -lCppUTestExt -lm
+
+BUILD_DEPS += $(MAKEFILE_LIST)
+
+.PHONY: test
+test: $(BUILD_DIR)/$(TARGET)
+	@echo Running tests...
+	@$(BUILD_DIR)/$(TARGET)
+
+$(BUILD_DIR)/$(TARGET): $(OBJS)
+	@echo Linking $@...
+	@mkdir -p $(dir $@)
+	@$(CC) $(LDFLAGS) $(OBJS) -o $@ $(LDLIBS)
+
+$(BUILD_DIR)/%.s.o: %.s $(BUILD_DEPS)
+	@echo Assembling $<...
+	@mkdir -p $(dir $@)
+	@$(AS) $(ASFLAGS) -c $< -o $@
+
+$(BUILD_DIR)/%.c.o: %.c $(BUILD_DEPS)
+	@echo Compiling $<...
+	@mkdir -p $(dir $@)
+	@$(CC) $(CPPFLAGS) $(CFLAGS) -c $< -o $@
+
+$(BUILD_DIR)/%.cpp.o: %.cpp $(BUILD_DEPS)
+	@echo Compiling $<...
+	@mkdir -p $(dir $@)
+	@$(CXX) $(CPPFLAGS) $(CXXFLAGS) -c $< -o $@
+
+.PHONY: clean
+clean:
+	@echo Cleaning...
+	@rm -rf $(BUILD_DIR)
+
+-include $(DEPS)

README.md

@@ -0,0 +1,6 @@
+# home-assistant-bridge
+[![Tests](https://github.com/geappliances/home-assistant-bridge/actions/workflows/test.yml/badge.svg)](https://github.com/geappliances/home-assistant-bridge/actions/workflows/test.yml)
+
+Subscribes to data hosted by a GE Appliances product using GEA3 and publishes it to an MQTT server under `/geappliances/<device ID>`. ERDs are identified by 16-bit identifiers and the raw binary data is published as a hex string to `/geappliances/<device ID>/erd/<ERD ID>/value`. Data can be written to an ERD by writing a hex string of the appropriate size to `/geappliances/<device ID>/erd/<ERD ID>/write`.
+
+This is intended to be used with the MQTT server provided by Home Assistant, but it should work with other MQTT servers.

examples/basic/basic.ino

@@ -0,0 +1,54 @@
+#include <Arduino.h>
+#include <PubSubClient.h>
+#include "HomeAssistantBridge.h"
+
+static WiFiClient wifiClient;
+static PubSubClient mqttClient(wifiClient);
+static HomeAssistantBridge bridge;
+
+static void configureWifi()
+{
+  Serial.println("Connecting to " + String(SSID));
+
+  WiFi.begin(SSID, PASSWORD);
+
+  while(WiFi.status() != WL_CONNECTED) {
+    delay(500);
+    Serial.print(".");
+  }
+
+  Serial.println("WiFi connected");
+}
+
+static void configureMqtt()
+{
+  mqttClient.setServer(MQTT_SERVER, MQTT_SERVER_PORT);
+}
+
+static void connectToMqtt()
+{
+  while(!mqttClient.connected()) {
+    Serial.print("Attempting MQTT connection...");
+    if(mqttClient.connect("", MQTT_USER, MQTT_PASSWORD)) {
+      Serial.println("connected");
+    }
+    else {
+      Serial.println("failed, rc=" + String(mqttClient.state()) + " will try again in 5 seconds");
+      delay(5000);
+    }
+  }
+}
+
+void setup()
+{
+  Serial.begin(115200);
+  configureWifi();
+  configureMqtt();
+  bridge.begin(mqttClient, Serial1, "some-device-id");
+}
+
+void loop()
+{
+  connectToMqtt();
+  bridge.loop();
+}