Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jorticus/umate
Arduino library for the Outback MATE protocol
https://github.com/jorticus/umate
arduino arduino-library avr
Last synced: 4 months ago
JSON representation
Arduino library for the Outback MATE protocol
- Host: GitHub
- URL: https://github.com/jorticus/umate
- Owner: jorticus
- License: gpl-2.0
- Created: 2019-05-29T05:22:35.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-07-03T11:35:36.000Z (over 3 years ago)
- Last Synced: 2023-04-08T09:24:48.992Z (almost 2 years ago)
- Topics: arduino, arduino-library, avr
- Language: C++
- Size: 304 KB
- Stars: 7
- Watchers: 6
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# μMATE
An Arduino library for the Outback MATE protocol.
Also see [pyMATE](https://github.com/jorticus/pymate), my Python implementation of the MATE protocol.
You will need a simple adapter circuit and a TTL serial port. For more details, see [jared.geek.nz/pymate](http://jared.geek.nz/pymate)
You will also need my [9-bit HW Serial library](https://github.com/jorticus/Arduino-Serial9b), or your own implementation. Your device MUST have at least 2 hardware serial ports! The Sparkfun Pro Micro works, since it has 1 USB serial port and 1 HW serial port. The Arduino Uno will NOT work as it only has 1 port!
## Installation
Simply clone to your Arduino libraries folder (eg. Documents\Arduino\libraries\uMATE)
Several examples are included with this library, and were built for the Sparkfun Pro Micro:
## Bridge.ino
This bridges a MATEnet bus to a host computer via USB.
Packets are wrapped into an HLDC-encoded frame, and can be processed by my pyMate library.
This provides a more robust method for interfacing with the network, since Linux/Windows
struggles with 9-bit data.
## MXEmulator.ino
This emulates an Outback MX Charge Controller, with a hard-coded status packet.
## DeviceEmulator.ino
This emulates an Outback Hub with 3 attached devices on ports 1..3 (MX, FX, FlexnetDC).
Each child device spits out a hard-coded example status packet.
You should be able to plug a MATE directly to the arduino, with appropriate level conversion (the MATE expects 0V/24V logic), or you can connect it to your computer via a USB<>UART adapter and communicate via [pyMATE](https://github.com/jorticus/pymate).
## DeviceScan.ino
This scans the mate bus for attached devices.
You can connect this with the DeviceEmulator example above, or with a real Outback MATE network with attached devices (with appropriate level conversion!)
## Sniffer.ino
Platform: Arduino Mega 2560 (Needs 3x Hardware Serial ports)
This allows you to tap an Outback MATE bus and intercept traffic between two devices. There is a python script that forwards this captured data to Wireshark for further analysis.
Unlike the other sketches, this just captures low-level packet data and does not decode them using the uMATE library.
```
[MATE] --------\ /-------- [MX/FX/DC]
| |
[ Arduino ]
|
[ Tap.py ]
|
[ Wireshark ]
```
You should use opto-isolators to convert the +24V serial logic of the MATE bus to +5V logic of the Arduino, and provide isolation between your analysis PC and the main system wiring.
## Footnotes
Pull-requests are welcome.
The Outback bus operates at your battery's supply voltage (which could be 24 or 48V), so you MUST have appropriate level conversion AND isolation, or you risk damage to your Arduino and/or computer! Use this library at your own risk!