Code Monkey home page Code Monkey logo

rv-bridge's Introduction

RV-Bridge: HomeKit to RV-C Adapter

RV-Bridge


  1. Features
  2. Background
  3. Current Project State
  4. To-Do
  5. Hardware
  6. Wiring
  7. Firmware Setup
  8. Finding Output Numbers
  9. Supported RVs
  10. 3D Printing
  11. Notes and Tips
  12. Links

Features

  • Connects to the RV-C network in many modern RVs.
    • RV-C is a subset of CAN-Bus running at 250kbps.
  • Uses an ESP32 with a CAN-Bus interface.
  • Connects lights, fans, switches, and thermostats to HomeKit.
  • Fits inside the RV wiring panel.
  • Plugs into an unused CAN-Bus socket for power and data.
  • STL files for a 3D printed case are included.

Background

At the start of the pandemic we realized that international travel was going to be off the table for a significant duration. We decided it was time to see more of the Western US so we bought a class-A motorhome which we call The Penguin Express. We've put almost 30k miles on it so far.

Penguin Express

In addition to a bunch of 3D printed upgrades (we travel with a Prusa MK3S on board), I've done some arduino powered electronics work: a water valve for a reverse osmosis water filter with an LCD control panel, a GPS based clock for the bedroom that knows the exact timezone boundaries so it never needs to be set, and a GPS based altimeter and tire pressure monitor with a 7" color touchscreen for the dash.

The RV's lights, fans, and climate are all controlled through a Firefly Integrations Vegatouch Spectrum multiplex system. A 7" LCD panel is used to control everything, in addition to wireless keypads around the RV. There is also a bluetooth module that connects to an iOS app for controlling via an iPhone.

Firefly Main Firefly Lights
Firefly Climate Firefly Fans

It's a great system and works really well for control of the RV devices, but the iOS app is a bit slow to load/connect and can only be used in proximity to the RV. Since we already have an Apple TV onboard driving our TVs which could double as a hub, I've always wondered if there was a way to control it all via HomeKit and the Home app.

Recently I came across some documentation for the bus protocol that's used by the Spectrum system, RV-C, a subset of CAN-Bus, as well as the open source project CoachProxyOS that documents getting a Raspberry Pi set up to host a web page for controlling an RV's network using RV-C.

I also recently started playing with HomeSpan, a library for implementing HomeKit accessories on an ESP32 microcontroller, for a HomeKit doorbell project.

RV-Bridge is the result of putting these pieces together.


Current Project State (v1.0.0)

  • Homespan pairing works, devices show up in the Home app.
  • CAN-Bus packet receiving works.
  • RV-C messages are routed correctly to the HomeKit tiles.
  • The correct RV-C packets are being sent over the bus based on changes made in the Home app for lights, switches, and fans.
  • The RV devices respond correctly.
  • Lights, switches, and fans are complete.
  • Temperature readings from thermostats are reflected in the Home app.
  • Thermostat control is complete.

To-Do

  • Some RVs have AC units that can work as a heat pump; only the AC portion of these units is currently handled. (Ours only has a furnace so I don't currently have a way to implement this.)

Hardware

Uses an ESP32 with a CAN-Bus interface, either as separate components, or more easily, this board I found from skpang.co.uk:

ESP32 Module

In the U.S. it's available on the CopperHillTech Website:
ESP32 with WiFi, Bluetooth Classic, BLE, CAN Bus Module

This board has everything needed, including a regulator for powering the device off of the 12V provided by the RV-C connector.


Wiring

The connector used by the Firefly system is a 3M 37104-A165-00E MB which can be sourced from Digikey

Insert four 24AWG wires into the Can-Bus connector (I used silicone covered wire as they are much more flexible) and compress to make the connections. Twist the data and power pairs together and screw them into the terminal block on the CAN-Bus interface on the ESP32.

The CAN-Bus connector plugs into one of the available sockets inside the system wiring panel.


Cable Wiring
Can-Bus Connector Wiring
G7 Panel Home App

Firmware Setup

  • The project is set up for compilation with PlatformIO.
    • I use it via Microsoft's Visual Studio Code.
  • Pretty sure you could also use the Arduino IDE. You'd need to install the following libraries:
    • elapsedMillis
    • miwagner/ESP32CAN
    • homespan/HomeSpan
  • config.h
    • Duplicate config-sample.h to config.h. (Do not check this file into git, it will have your wifi passowrd in it)
    • Enter Wifi SSID and password for your RV network.
    • Include a definition file for your RV devices (see Miramar_2020_3202.h for an example).
      • Each switch has:
        • Output number.
        • Type: Lamp, DimmableLamp, or Switch.
        • Name.
      • Each fan has:
        • Output number for fan power.
        • Output number for up - optional, -1 if not used.
        • Output number for down - optional, -1 if not used.
        • Name.
      • Each thermostat has:
        • ID number, typically 0 based.
        • Output number for the A/C compressor.
        • Output number for low fan.
        • Output number for high fan.
        • Output number for furnace - optional, -1 if not present.
        • Name.
      • See Finding Output Numbers below for details on output numbers.
  • Flashing
    • If you are using an ESP32 with a USB-C connector and flashing from a Mac, you may need to connect it via a USB hub due to some timing weirdness around resetting the ESP32 into boot mode. I use a USB-C to 4 port USB-A hub with a USB-A to USB-C cable.
  • Startup
    • Connect to the ESP32 via the Serial Monitor.
    • You should see a bunch of startup logging.
    • Then a message about being connected to Wifi and not being paired.
    • HomeSpan provides a command line interface that you can access through the Serial Monitor. Type '?' to see the available comands.
  • Pairing
    • Be on the same wifi network and in close proximity to the ESP32.
    • In the Home app choose "Add Accessory".
    • Point the camera at this image:

      Pairing Code

    • Tap on RV-Bridge.
    • Accept that this is an "unsupported" device.
    • Add the bridge and all of your accessories, choosing appropriate rooms and names for them.
    • Done!
  • The status LED will flash based on what the bridge is doing:
    • 🟒 Green every 2 seconds as a heartbeat indicator.
    • πŸ”΄ Red when CAN-Bus packets are sent.
    • πŸ”΅ Blue when HomeKit messages are received.

Finding Output Numbers

The whole multiplex system connects back to a panel with outputs for all of the lights and fans. Each of these outputs has a unique number which may be printed on the panel's cover, and should also be found on a Network Diagnostic screen on the main LCD control screen.

G7 Outputs

*** USE EXTREME CAUTION WHEN ENTERING OUTPUT NUMBERS. THERE ARE OUTPUTS FOR THE RV SLIDES AND THINGS LIKE MOVEABLE BUNKS. YOU DO NOT WANT TO MISTAKENLY PICK ONE OF THOSE OUTPUTS FOR A LIGHT OR FAN! ***


Supported RV's

Currently the project includes definition files for these RVs in the RV folder:

Miramar_2020_3202.h - 2020 Thor Miramar 32.2
Aria_2019_3901.h - 2019 Thor Aria 39.1
Tiffin_2019_34PA.h - 2019 Tiffin Open Road 34PA
Jayco_2023_Terrain.h - 2023 Jayco Terrain 19Y

(Additional definition files are welcome!)


3D Printing

  • A case will keep the microcontroller isolated from any exposed contacts inside the wiring panel.
  • STL Files are in the 3D folder:
  • Slicer
    • I used Prusa Slicer 2.5.0
  • Build Plate
    • A textured build plate give a nice surface finish for the top and bottom of the box.
  • Filament
    • PETG - handles heat better than PLA and sticks to a textured build plate much better than PLA.
  • Settings to adjust:
    • Layer Height: 0.3mm (faster printing)
    • Extrusion Width: 0.55mm (eliminates tiny infill strips in the walls).
    • Perimeter Transitioning Threshold Angle: 20 (keeps the lettering connected).
    • Bridging Angle: 180ΒΊ (bridging in the layer above the lettering should be parallel to the baseline of the text.)

Notes and Tips

  • If the bridge seems to become unresponsive at some point, verify that the controlling device is on the RV's Wifi and not some other weak Wifi.
  • If the bridge doesn't seem available for pairing, it may already think it's paired. Try using the H command via the cli in the serial monitor, then reflash the ESP32 and try again.
  • If pairing fails, it seems that sometimes HomeKit gets fussy about a device changing it's properties too much and refuses to pair. You can change the MAC address of the wifi interface on the ESP32 by defining OVERRIDE_MAC_ADDRESS in config.h and re-flashing. Anecdotal evidence suggests that this can help.

Links:


Copyright Β© 2023 Randy Ubillos

rv-bridge's People

Contributors

rubillos avatar mkostersitz avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.