mirror of
https://github.com/DCC-EX/CommandStation-EX.git
synced 2025-04-21 12:31:19 +02:00
does not compile, saving current
This commit is contained in:
travis-farmer
parent
577511f92f
commit
3b2ea6f337
640
IO_RSproto.h
Normal file
640
IO_RSproto.h
Normal file
@ -0,0 +1,640 @@
|
||||
/*
|
||||
* © 2024, Travis Farmer. All rights reserved.
|
||||
* © 2024, Chris Bulliner. All rights reserved. https://github.com/CMB27
|
||||
*
|
||||
* This file is part of DCC++EX API
|
||||
*
|
||||
* This is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* It is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with CommandStation. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
/*
|
||||
* RSproto
|
||||
* =======
|
||||
* To define a RSproto, example syntax:
|
||||
* RSproto::create(serial, baud[, cycletime[, pin]]);
|
||||
*
|
||||
* serial = serial port to be used (e.g. Serial3)
|
||||
* baud = baud rate (9600, 19200, 28800, 57600 or 115200)
|
||||
* cycletime = minimum time between successive updates/reads of a node in millisecs (default 500ms)
|
||||
* pin = pin number connected to RSproto module's DE and !RE terminals for half-duplex operation (default VPIN_NONE)
|
||||
*
|
||||
*
|
||||
* RSprotoNode
|
||||
* ========
|
||||
* To define a RSproto node and associate it with a RSproto bus,
|
||||
* RSprotonode::create(firstVPIN, numVPINs, nodeID);
|
||||
*
|
||||
* firstVPIN = first vpin in block allocated to this device
|
||||
* numVPINs = number of vpins
|
||||
* nodeID = 0-254
|
||||
*/
|
||||
|
||||
#ifndef IO_RS485_H
|
||||
#define IO_RS485_H
|
||||
|
||||
#include "IODevice.h"
|
||||
|
||||
/**********************************************************************
|
||||
* RSprotonode class
|
||||
*
|
||||
* This encapsulates the state associated with a single RSproto node,
|
||||
* which includes the nodeID, number of discrete inputs and coils, and
|
||||
* the states of the discrete inputs and coils.
|
||||
**********************************************************************/
|
||||
class RSprotonode : public IODevice {
|
||||
private:
|
||||
uint8_t _busNo;
|
||||
uint8_t _nodeID;
|
||||
char _type;
|
||||
RSprotonode *_next = NULL;
|
||||
bool _initialised = false;
|
||||
RSproto* bus = NULL;
|
||||
// EX-IOExpander protocol flags
|
||||
enum {
|
||||
EXIOINIT = 0xE0, // Flag to initialise setup procedure
|
||||
EXIORDY = 0xE1, // Flag we have completed setup procedure, also for EX-IO to ACK setup
|
||||
EXIODPUP = 0xE2, // Flag we're sending digital pin pullup configuration
|
||||
EXIOVER = 0xE3, // Flag to get version
|
||||
EXIORDAN = 0xE4, // Flag to read an analogue input
|
||||
EXIOWRD = 0xE5, // Flag for digital write
|
||||
EXIORDD = 0xE6, // Flag to read digital input
|
||||
EXIOENAN = 0xE7, // Flag to enable an analogue pin
|
||||
EXIOINITA = 0xE8, // Flag we're receiving analogue pin mappings
|
||||
EXIOPINS = 0xE9, // Flag we're receiving pin counts for buffers
|
||||
EXIOWRAN = 0xEA, // Flag we're sending an analogue write (PWM)
|
||||
EXIOERR = 0xEF, // Flag we've received an error
|
||||
};
|
||||
|
||||
public:
|
||||
enum ProfileType : int {
|
||||
Instant = 0, // Moves immediately between positions (if duration not specified)
|
||||
UseDuration = 0, // Use specified duration
|
||||
Fast = 1, // Takes around 500ms end-to-end
|
||||
Medium = 2, // 1 second end-to-end
|
||||
Slow = 3, // 2 seconds end-to-end
|
||||
Bounce = 4, // For semaphores/turnouts with a bit of bounce!!
|
||||
NoPowerOff = 0x80, // Flag to be ORed in to suppress power off after move.
|
||||
};
|
||||
|
||||
uint8_t _numDigitalPins = 0;
|
||||
uint8_t _numAnaloguePins = 0;
|
||||
|
||||
uint8_t _majorVer = 0;
|
||||
uint8_t _minorVer = 0;
|
||||
uint8_t _patchVer = 0;
|
||||
|
||||
uint8_t* _digitalInputStates = NULL;
|
||||
uint8_t* _analogueInputStates = NULL;
|
||||
uint8_t* _analogueInputBuffer = NULL; // buffer for I2C input transfers
|
||||
uint8_t _readCommandBuffer[4];
|
||||
|
||||
uint8_t _digitalPinBytes = 0; // Size of allocated memory buffer (may be longer than needed)
|
||||
uint8_t _analoguePinBytes = 0; // Size of allocated memory buffer (may be longer than needed)
|
||||
uint8_t* _analoguePinMap = NULL;
|
||||
|
||||
static void create(VPIN firstVpin, int nPins, uint8_t nodeID) {
|
||||
if (checkNoOverlap(firstVpin, nPins)) new RSprotonode(firstVpin, nPins, nodeID);
|
||||
}
|
||||
RSprotonode(VPIN firstVpin, int nPins, uint8_t nodeID);
|
||||
|
||||
uint8_t getNodeID() {
|
||||
return _nodeID;
|
||||
}
|
||||
|
||||
RSprotonode *getNext() {
|
||||
return _next;
|
||||
}
|
||||
void setNext(RSprotonode *node) {
|
||||
_next = node;
|
||||
}
|
||||
bool isInitialised() {
|
||||
return _initialised;
|
||||
}
|
||||
void setInitialised() {
|
||||
_initialised = true;
|
||||
}
|
||||
|
||||
bool _configure(VPIN vpin, ConfigTypeEnum configType, int paramCount, int params[]) override {
|
||||
if (paramCount != 1) return false;
|
||||
int pin = vpin - _firstVpin;
|
||||
|
||||
uint16_t pullup = params[0];
|
||||
uint8_t outBuffer[6] = {EXIODPUP, _nodeID, pin, pullup};
|
||||
uint8_t responseBuffer[3];
|
||||
bus->_busy = true;
|
||||
bus->updateCrc(outBuffer,4);
|
||||
if (bus->_txPin != VPIN_NONE) ArduinoPins::fastWriteDigital(bus->_txPin, HIGH);
|
||||
bus->_serialD->write(outBuffer, 6);
|
||||
bus->_serialD->flush();
|
||||
if (bus->_txPin != VPIN_NONE) ArduinoPins::fastWriteDigital(bus->_txPin, LOW);
|
||||
unsigned long startMillis = millis();
|
||||
while (!bus->_serialD->available()) {
|
||||
if (millis() - startMillis > 500) return false;
|
||||
}
|
||||
uint16_t len = 0;
|
||||
unsigned long startMicros = micros();
|
||||
do {
|
||||
if (bus->_serialD->available()) {
|
||||
startMicros = micros();
|
||||
responseBuffer[len] = bus->_serialD->read();
|
||||
len++;
|
||||
}
|
||||
} while (micros() - startMicros <= 500 && len < 256);
|
||||
bus->_busy = false;
|
||||
if (bus->crcGood(responseBuffer,sizeof(responseBuffer)-2)) {
|
||||
if (!testAndStripMasterFlag(responseBuffer)) DIAG(F("Foreign RSproto Device! no master flag from node %d"),_nodeID);
|
||||
if (responseBuffer[0] == EXIORDY) {
|
||||
} else {
|
||||
DIAG(F("EX-IOExpander485 Vpin %u cannot be used as a digital input pin"), pin);
|
||||
}
|
||||
} else {
|
||||
DIAG(F("EX-IOExpander485 node %d CRC Error"), _nodeID);
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
int _configureAnalogIn(VPIN vpin) override {
|
||||
int pin = vpin - _firstVpin;
|
||||
//RSproto *mainrs = RSproto::findBus(_busNo);
|
||||
uint8_t commandBuffer[5] = {EXIOENAN, (uint8_t) _nodeID, (uint8_t) pin};
|
||||
uint8_t responseBuffer[3];
|
||||
bus->_busy = true;
|
||||
bus->updateCrc(commandBuffer,3);
|
||||
if (bus->_txPin != VPIN_NONE) ArduinoPins::fastWriteDigital(bus->_txPin, HIGH);
|
||||
bus->_serialD->write(commandBuffer, 5);
|
||||
bus->_serialD->flush();
|
||||
if (bus->_txPin != VPIN_NONE) ArduinoPins::fastWriteDigital(bus->_txPin, LOW);
|
||||
unsigned long startMillis = millis();
|
||||
while (!bus->_serialD->available()) {
|
||||
if (millis() - startMillis > 500) return 0;
|
||||
}
|
||||
uint16_t len = 0;
|
||||
unsigned long startMicros = micros();
|
||||
do {
|
||||
if (bus->_serialD->available()) {
|
||||
startMicros = micros();
|
||||
responseBuffer[len] = bus->_serialD->read();
|
||||
len++;
|
||||
}
|
||||
} while (micros() - startMicros <= 500 && len < 256);
|
||||
bus->_busy = false;
|
||||
if (bus->crcGood(responseBuffer,sizeof(responseBuffer)-2)) {
|
||||
if (!bus->testAndStripMasterFlag(responseBuffer)) DIAG(F("Foreign RSproto Device! no master flag from node %d"),_nodeID);
|
||||
if (responseBuffer[0] != EXIORDY) {
|
||||
DIAG(F("EX-IOExpander485: Vpin %u on node %d cannot be used as an analogue input pin"), (int) pin, (int) _nodeID);
|
||||
}
|
||||
} else {
|
||||
DIAG(F("EX-IOExpander485 node %d CRC Error"), (int) _nodeID);
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
void _begin() override {
|
||||
if (bus->_txPin != VPIN_NONE) {
|
||||
pinMode(bus->_txPin, OUTPUT);
|
||||
ArduinoPins::fastWriteDigital(bus->_txPin, LOW);
|
||||
}
|
||||
uint8_t receiveBuffer[5];
|
||||
uint8_t commandBuffer[7] = {EXIOINIT, _nodeID, (uint8_t)_nPins, (uint8_t)(_firstVpin & 0xFF), (uint8_t)(_firstVpin >> 8)};
|
||||
bus->updateCrc(commandBuffer,5);
|
||||
if (bus->_txPin != VPIN_NONE) ArduinoPins::fastWriteDigital(bus->_txPin, HIGH);
|
||||
bus->_serialD->write(commandBuffer, 7);
|
||||
bus->_serialD->flush();
|
||||
if (bus->_txPin != VPIN_NONE) ArduinoPins::fastWriteDigital(bus->_txPin, LOW);
|
||||
unsigned long startMillis = millis();
|
||||
while (!bus->_serialD->available()) {
|
||||
if (millis() - startMillis >= 500) return;
|
||||
}
|
||||
uint16_t len = 0;
|
||||
unsigned long startMicros = micros();
|
||||
do {
|
||||
if (bus->_serialD->available()) {
|
||||
startMicros = micros();
|
||||
receiveBuffer[len] = bus->_serialD->read();
|
||||
len++;
|
||||
}
|
||||
} while (micros() - startMicros <= 500 && len < 256);
|
||||
if (receiveBuffer[1] == EXIOPINS && bus->crcGood(receiveBuffer,sizeof(receiveBuffer)-2)) {
|
||||
if (!bus->testAndStripMasterFlag(receiveBuffer)) DIAG(F("Foreign RSproto Device! no master flag from node %d"),_nodeID);
|
||||
_numDigitalPins = receiveBuffer[1];
|
||||
_numAnaloguePins = receiveBuffer[2];
|
||||
|
||||
// See if we already have suitable buffers assigned
|
||||
if (_numDigitalPins>0) {
|
||||
size_t digitalBytesNeeded = (_numDigitalPins + 7) / 8;
|
||||
if (_digitalPinBytes < digitalBytesNeeded) {
|
||||
// Not enough space, free any existing buffer and allocate a new one
|
||||
if (_digitalPinBytes > 0) free(_digitalInputStates);
|
||||
if ((_digitalInputStates = (byte*) calloc(digitalBytesNeeded, 1)) != NULL) {
|
||||
_digitalPinBytes = digitalBytesNeeded;
|
||||
} else {
|
||||
DIAG(F("EX-IOExpander485 node:%d ERROR alloc %d bytes"), _nodeID, digitalBytesNeeded);
|
||||
_deviceState = DEVSTATE_FAILED;
|
||||
_digitalPinBytes = 0;
|
||||
return;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (_numAnaloguePins>0) {
|
||||
size_t analogueBytesNeeded = _numAnaloguePins * 2;
|
||||
if (_analoguePinBytes < analogueBytesNeeded) {
|
||||
// Free any existing buffers and allocate new ones.
|
||||
if (_analoguePinBytes > 0) {
|
||||
free(_analogueInputBuffer);
|
||||
free(_analogueInputStates);
|
||||
free(_analoguePinMap);
|
||||
}
|
||||
_analogueInputStates = (uint8_t*) calloc(analogueBytesNeeded, 1);
|
||||
_analogueInputBuffer = (uint8_t*) calloc(analogueBytesNeeded, 1);
|
||||
_analoguePinMap = (uint8_t*) calloc(_numAnaloguePins, 1);
|
||||
if (_analogueInputStates != NULL &&
|
||||
_analogueInputBuffer != NULL &&
|
||||
_analoguePinMap != NULL) {
|
||||
_analoguePinBytes = analogueBytesNeeded;
|
||||
} else {
|
||||
DIAG(F("EX-IOExpander485 node:%d ERROR alloc analog pin bytes"), _nodeID);
|
||||
_deviceState = DEVSTATE_FAILED;
|
||||
_analoguePinBytes = 0;
|
||||
return;
|
||||
}
|
||||
}
|
||||
}
|
||||
} else {
|
||||
DIAG(F("EX-IOExpander485 node:%d ERROR configuring device (CRC: %s)"), _nodeID, bus->crcGood(receiveBuffer,sizeof(receiveBuffer)-2)? "PASS":"FAIL");
|
||||
_deviceState = DEVSTATE_FAILED;
|
||||
return;
|
||||
}
|
||||
commandBuffer[0] = EXIOINITA;
|
||||
commandBuffer[1] = _nodeID;
|
||||
bus->updateCrc(commandBuffer,2);
|
||||
if (bus->_txPin != VPIN_NONE) ArduinoPins::fastWriteDigital(bus->_txPin, HIGH);
|
||||
bus->_serialD->write(commandBuffer, 4);
|
||||
bus->_serialD->flush();
|
||||
if (bus->_txPin != VPIN_NONE) ArduinoPins::fastWriteDigital(bus->_txPin, LOW);
|
||||
startMillis = millis();
|
||||
while (!bus->_serialD->available()) {
|
||||
if (millis() - startMillis >= 500) return;
|
||||
}
|
||||
len = 0;
|
||||
startMicros = micros();
|
||||
do {
|
||||
if (bus->_serialD->available()) {
|
||||
startMicros = micros();
|
||||
receiveBuffer[len] = bus->_serialD->read();
|
||||
len++;
|
||||
}
|
||||
} while (micros() - startMicros <= 500 && len < 256);
|
||||
if (bus->crcGood(receiveBuffer,sizeof(receiveBuffer)-2)) {
|
||||
if (!bus->testAndStripMasterFlag(receiveBuffer)) DIAG(F("Foreign RSproto Device! no master flag from node %d"),_nodeID);
|
||||
for (int i = 0; i < _numAnaloguePins; i++) {
|
||||
_analoguePinMap[i] = receiveBuffer[i];
|
||||
}
|
||||
}
|
||||
uint8_t versionBuffer[5];
|
||||
commandBuffer[0] = EXIOVER;
|
||||
commandBuffer[1] = _nodeID;
|
||||
bus->updateCrc(commandBuffer,2);
|
||||
if (bus->_txPin != VPIN_NONE) ArduinoPins::fastWriteDigital(bus->_txPin, HIGH);
|
||||
bus->_serialD->write(commandBuffer, 4);
|
||||
bus->_serialD->flush();
|
||||
if (bus->_txPin != VPIN_NONE) ArduinoPins::fastWriteDigital(bus->_txPin, LOW);
|
||||
startMillis = millis();
|
||||
while (!bus->_serialD->available()) {
|
||||
if (millis() - startMillis >= 500) return;
|
||||
}
|
||||
len = 0;
|
||||
startMicros = micros();
|
||||
do {
|
||||
if (bus->_serialD->available()) {
|
||||
startMicros = micros();
|
||||
versionBuffer[len] = bus->_serialD->read();
|
||||
len++;
|
||||
}
|
||||
} while (micros() - startMicros <= 500 && len < 256);
|
||||
if (bus->crcGood(versionBuffer,sizeof(versionBuffer)-2)) {
|
||||
if (!bus->testAndStripMasterFlag(versionBuffer)) DIAG(F("Foreign RSproto Device! no master flag from node %d"),_nodeID);
|
||||
_majorVer = versionBuffer[0];
|
||||
_minorVer = versionBuffer[1];
|
||||
_patchVer = versionBuffer[2];
|
||||
DIAG(F("EX-IOExpander485 device found, node:%d, Version v%d.%d.%d"), _nodeID, _majorVer, _minorVer, _patchVer);
|
||||
}
|
||||
#ifdef DIAG_IO
|
||||
_display();
|
||||
#endif
|
||||
_initialised = false;
|
||||
}
|
||||
|
||||
|
||||
int _read(VPIN vpin) override {
|
||||
if (_deviceState == DEVSTATE_FAILED) return 0;
|
||||
int pin = vpin - _firstVpin;
|
||||
uint8_t pinByte = pin / 8;
|
||||
bool value = bitRead(_digitalInputStates[pinByte], pin - pinByte * 8);
|
||||
return value;
|
||||
}
|
||||
|
||||
|
||||
void _write(VPIN vpin, int value) override {
|
||||
if (_deviceState == DEVSTATE_FAILED) return;
|
||||
int pin = vpin - _firstVpin;
|
||||
uint8_t digitalOutBuffer[6];
|
||||
uint8_t responseBuffer[3];
|
||||
digitalOutBuffer[0] = EXIOWRD;
|
||||
digitalOutBuffer[1] = (uint8_t) _nodeID;
|
||||
digitalOutBuffer[2] = (uint8_t) pin;
|
||||
digitalOutBuffer[3] = (uint8_t) value;
|
||||
bus->_busy = true;
|
||||
bus->updateCrc(digitalOutBuffer,4);
|
||||
if (bus->_txPin != VPIN_NONE) ArduinoPins::fastWriteDigital(bus->_txPin, HIGH);
|
||||
bus->_serialD->write(digitalOutBuffer, 6);
|
||||
bus->_serialD->flush();
|
||||
if (bus->_txPin != VPIN_NONE) ArduinoPins::fastWriteDigital(bus->_txPin, LOW);
|
||||
unsigned long startMillis = millis();
|
||||
while (!bus->_serialD->available()) {
|
||||
if (millis() - startMillis >= 500) return;
|
||||
}
|
||||
uint16_t len = 0;
|
||||
unsigned long startMicros = micros();
|
||||
do {
|
||||
if (bus->_serialD->available()) {
|
||||
startMicros = micros();
|
||||
responseBuffer[len] = bus->_serialD->read();
|
||||
len++;
|
||||
}
|
||||
} while (micros() - startMicros <= 500 && len < 256);
|
||||
bus->_busy = false;
|
||||
if (bus->crcGood(responseBuffer,sizeof(responseBuffer)-2)) {
|
||||
if (!testAndStripMasterFlag(responseBuffer)) DIAG(F("Foreign RSproto Device! no master flag from node %d"),_nodeID);
|
||||
if (responseBuffer[0] != EXIORDY) {
|
||||
DIAG(F("EX-IOExpander485 Vpin %u cannot be used as a digital output pin"), pin);
|
||||
}
|
||||
} else {
|
||||
DIAG(F("EX-IOExpander485 node %d CRC Error"), _nodeID);
|
||||
}
|
||||
}
|
||||
|
||||
bool testAndStripMasterFlag(uint8_t *buf) {
|
||||
if (buf[0] != 0xFF) return false; // why did we not get a master flag? bad node?
|
||||
for (int i = 0; i < sizeof(buf)-1; i++) buf[i] = buf[i+1]; // shift array to begining
|
||||
return true;
|
||||
}
|
||||
|
||||
int _readAnalogue(VPIN vpin) override {
|
||||
if (_deviceState == DEVSTATE_FAILED) return 0;
|
||||
int pin = vpin - _firstVpin;
|
||||
for (uint8_t aPin = 0; aPin < _numAnaloguePins; aPin++) {
|
||||
if (_analoguePinMap[aPin] == pin) {
|
||||
uint8_t _pinLSBByte = aPin * 2;
|
||||
uint8_t _pinMSBByte = _pinLSBByte + 1;
|
||||
return (_analogueInputStates[_pinMSBByte] << 8) + _analogueInputStates[_pinLSBByte];
|
||||
}
|
||||
}
|
||||
return -1; // pin not found in table
|
||||
}
|
||||
|
||||
void _writeAnalogue(VPIN vpin, int value, uint8_t profile, uint16_t duration) override {
|
||||
uint8_t servoBuffer[7];
|
||||
uint8_t responseBuffer[1];
|
||||
|
||||
if (_deviceState == DEVSTATE_FAILED) return;
|
||||
int pin = vpin - _firstVpin;
|
||||
servoBuffer[0] = EXIOWRAN;
|
||||
servoBuffer[1] = (uint8_t) _nodeID;
|
||||
servoBuffer[2] = (uint8_t) pin;
|
||||
servoBuffer[3] = (uint8_t) value & 0xFF;
|
||||
servoBuffer[4] = (uint8_t) value >> 8;
|
||||
servoBuffer[5] = (uint8_t) profile;
|
||||
servoBuffer[6] = (uint8_t) duration & 0xFF;
|
||||
servoBuffer[7] = (uint8_t) duration >> 8;
|
||||
bus->_busy = true;
|
||||
bus->updateCrc(servoBuffer,8);
|
||||
if (bus->_txPin != VPIN_NONE) ArduinoPins::fastWriteDigital(bus->_txPin, HIGH);
|
||||
bus->_serialD->write(servoBuffer, 10);
|
||||
bus->_serialD->flush();
|
||||
if (bus->_txPin != VPIN_NONE) ArduinoPins::fastWriteDigital(bus->_txPin, LOW);
|
||||
unsigned long startMillis = millis();
|
||||
while (!bus->_serialD->available()) {
|
||||
if (millis() - startMillis >= 500) return;
|
||||
}
|
||||
uint16_t len = 0;
|
||||
unsigned long startMicros = micros();
|
||||
do {
|
||||
if (bus->_serialD->available()) {
|
||||
startMicros = micros();
|
||||
responseBuffer[len] = bus->_serialD->read();
|
||||
len++;
|
||||
}
|
||||
} while (micros() - startMicros <= 500 && len < 256);
|
||||
bus->_busy = false;
|
||||
if (!bus->crcGood(responseBuffer,sizeof(responseBuffer)-2)) {
|
||||
DIAG(F("EX-IOExpander485 node %d CRC Error"), (int) _nodeID);
|
||||
//_deviceState = DEVSTATE_FAILED;
|
||||
} else {
|
||||
if (!bus->testAndStripMasterFlag(responseBuffer)) DIAG(F("Foreign RSproto Device! no master flag from node %d"),_nodeID);
|
||||
if (responseBuffer[0] != EXIORDY) {
|
||||
DIAG(F("EX-IOExpander485 Vpin %u cannot be used as a servo/PWM pin"), pin);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
uint8_t getBusNumber() {
|
||||
return _busNo;
|
||||
}
|
||||
|
||||
void _display() override {
|
||||
DIAG(F("EX-IOExpander485 node:%d v%d.%d.%d Vpins %u-%u %S"), _nodeID, _majorVer, _minorVer, _patchVer, (int)_firstVpin, (int)_firstVpin+_nPins-1, _deviceState == DEVSTATE_FAILED ? F("OFFLINE") : F(""));
|
||||
}
|
||||
|
||||
|
||||
};
|
||||
|
||||
/**********************************************************************
|
||||
* RSproto class
|
||||
*
|
||||
* This encapsulates the properties state of the bus and the
|
||||
* transmission and reception of data across that bus. Each RSproto
|
||||
* object owns a set of RSprotonode objects which represent the nodes
|
||||
* attached to that bus.
|
||||
**********************************************************************/
|
||||
class RSproto : public IODevice {
|
||||
private:
|
||||
// Here we define the device-specific variables.
|
||||
uint8_t _busNo;
|
||||
unsigned long _baud;
|
||||
unsigned long _cycleStartTime = 0;
|
||||
unsigned long _timeoutStart = 0;
|
||||
unsigned long _cycleTime; // target time between successive read/write cycles, microseconds
|
||||
unsigned long _timeoutPeriod; // timeout on read responses, in microseconds.
|
||||
unsigned long _currentMicros; // last value of micros() from _loop function.
|
||||
unsigned long _postDelay; // delay time after transmission before switching off transmitter (in us)
|
||||
unsigned long _byteTransmitTime; // time in us for transmission of one byte
|
||||
int _operationCount = 0;
|
||||
int _refreshOperation = 0;
|
||||
|
||||
static RSproto *_busList; // linked list of defined bus instances
|
||||
bool waitReceive = false;
|
||||
int _waitCounter = 0;
|
||||
int _waitCounterB = 0;
|
||||
int _waitA;
|
||||
unsigned long _charTimeout;
|
||||
unsigned long _frameTimeout;
|
||||
enum {RDS_IDLE, RDS_DIGITAL, RDS_ANALOGUE}; // Read operation states
|
||||
uint8_t _readState = RDS_IDLE;
|
||||
|
||||
unsigned long _lastDigitalRead = 0;
|
||||
unsigned long _lastAnalogueRead = 0;
|
||||
const unsigned long _digitalRefresh = 10000UL; // Delay refreshing digital inputs for 10ms
|
||||
const unsigned long _analogueRefresh = 50000UL; // Delay refreshing analogue inputs for 50ms
|
||||
|
||||
// EX-IOExpander protocol flags
|
||||
enum {
|
||||
EXIOINIT = 0xE0, // Flag to initialise setup procedure
|
||||
EXIORDY = 0xE1, // Flag we have completed setup procedure, also for EX-IO to ACK setup
|
||||
EXIODPUP = 0xE2, // Flag we're sending digital pin pullup configuration
|
||||
EXIOVER = 0xE3, // Flag to get version
|
||||
EXIORDAN = 0xE4, // Flag to read an analogue input
|
||||
EXIOWRD = 0xE5, // Flag for digital write
|
||||
EXIORDD = 0xE6, // Flag to read digital input
|
||||
EXIOENAN = 0xE7, // Flag to enable an analogue pin
|
||||
EXIOINITA = 0xE8, // Flag we're receiving analogue pin mappings
|
||||
EXIOPINS = 0xE9, // Flag we're receiving pin counts for buffers
|
||||
EXIOWRAN = 0xEA, // Flag we're sending an analogue write (PWM)
|
||||
EXIOERR = 0xEF, // Flag we've received an error
|
||||
};
|
||||
uint16_t _calculateCrc(uint8_t *buf, uint16_t len);
|
||||
|
||||
RSprotonode *_nodeListStart = NULL, *_nodeListEnd = NULL;
|
||||
RSprotonode *_currentNode = NULL;
|
||||
uint8_t _exceptionResponse = 0;
|
||||
uint8_t getExceptionResponse();
|
||||
uint16_t _receiveDataIndex = 0; // Index of next data byte to be received.
|
||||
RSproto *_nextBus = NULL; // Pointer to next bus instance in list.
|
||||
void setTimeout(unsigned long timeout);
|
||||
|
||||
// Helper function for error handling
|
||||
void reportError(uint8_t status, bool fail=true) {
|
||||
DIAG(F("EX-IOExpander485 Node:%d Error"), _currentNode->getNodeID());
|
||||
if (fail)
|
||||
_deviceState = DEVSTATE_FAILED;
|
||||
}
|
||||
|
||||
public:
|
||||
int _CommMode = 0;
|
||||
int _opperation = 0;
|
||||
uint16_t _pullup;
|
||||
uint16_t _pin;
|
||||
int8_t _txPin;
|
||||
bool _busy = false;
|
||||
|
||||
int taskCnt = 0;
|
||||
HardwareSerial *_serialD;
|
||||
bool testAndStripMasterFlag(uint8_t *buf) {
|
||||
if (buf[0] != 0xFF) return false; // why did we not get a master flag? bad node?
|
||||
for (int i = 0; i < sizeof(buf)-1; i++) buf[i] = buf[i+1]; // shift array to begining
|
||||
return true;
|
||||
}
|
||||
|
||||
|
||||
void updateCrc(uint8_t *buf, uint16_t len);
|
||||
bool crcGood(uint8_t *buf, uint16_t len);
|
||||
void clearRxBuffer();
|
||||
static void create(HardwareSerial& serial, unsigned long baud, uint16_t cycleTimeMS=500, int8_t txPin=-1, int waitA=10) {
|
||||
new RSproto(serial, baud, cycleTimeMS, txPin, waitA);
|
||||
}
|
||||
|
||||
// Device-specific initialisation
|
||||
void _begin() override {
|
||||
_serialD->begin(_baud, SERIAL_8N1);
|
||||
unsigned long bitsPerChar = 10;
|
||||
if (_baud <= 19200) {
|
||||
_charTimeout = (bitsPerChar * 2500000) / _baud;
|
||||
_frameTimeout = (bitsPerChar * 4500000) / _baud;
|
||||
}
|
||||
else {
|
||||
_charTimeout = (bitsPerChar * 1000000) / _baud + 750;
|
||||
_frameTimeout = (bitsPerChar * 1000000) / _baud + 1750;
|
||||
}
|
||||
clearRxBuffer();
|
||||
#if defined(RSproto_STM_OK)
|
||||
pinMode(RSproto_STM_OK, OUTPUT);
|
||||
ArduinoPins::fastWriteDigital(RSproto_STM_OK,LOW);
|
||||
#endif
|
||||
#if defined(RSproto_STM_FAIL)
|
||||
pinMode(RSproto_STM_FAIL, OUTPUT);
|
||||
ArduinoPins::fastWriteDigital(RSproto_STM_FAIL,LOW);
|
||||
#endif
|
||||
#if defined(RSproto_STM_COMM)
|
||||
pinMode(RSproto_STM_COMM, OUTPUT);
|
||||
ArduinoPins::fastWriteDigital(RSproto_STM_COMM,LOW);
|
||||
#endif
|
||||
|
||||
#if defined(DIAG_IO)
|
||||
_display();
|
||||
#endif
|
||||
}
|
||||
|
||||
|
||||
// Loop function (overriding IODevice::_loop(unsigned long))
|
||||
void _loop(unsigned long currentMicros) override;
|
||||
|
||||
// Display information about the device
|
||||
void _display() override {
|
||||
DIAG(F("EX-IOExpander485 Configured on Vpins:%d-%d %S"), _firstVpin, _firstVpin+_nPins-1,
|
||||
_deviceState == DEVSTATE_FAILED ? F("OFFLINE") : F("OK"));
|
||||
}
|
||||
|
||||
// Locate RSprotonode object with specified nodeID.
|
||||
RSprotonode *findNode(uint8_t nodeID) {
|
||||
for (RSprotonode *node = _nodeListStart; node != NULL; node = node->getNext()) {
|
||||
if (node->getNodeID() == nodeID)
|
||||
return node;
|
||||
}
|
||||
return NULL;
|
||||
}
|
||||
|
||||
|
||||
// Add new RSprotonode to the list of nodes for this bus.
|
||||
void addNode(RSprotonode *newNode) {
|
||||
if (!_nodeListStart)
|
||||
_nodeListStart = newNode;
|
||||
if (!_nodeListEnd)
|
||||
_nodeListEnd = newNode;
|
||||
else
|
||||
_nodeListEnd->setNext(newNode);
|
||||
//DIAG(F("RSproto: 260h nodeID:%d _nodeListStart:%d _nodeListEnd:%d"), newNode, _nodeListStart, _nodeListEnd);
|
||||
}
|
||||
|
||||
protected:
|
||||
RSproto(HardwareSerial &serial, unsigned long baud, uint16_t cycleTimeMS, int8_t txPin, int waitA);
|
||||
|
||||
public:
|
||||
|
||||
uint8_t getBusNumber() {
|
||||
return _busNo;
|
||||
}
|
||||
RSproto *getNext() {
|
||||
return _nextBus;
|
||||
}
|
||||
static RSproto *findBus(uint8_t busNo) {
|
||||
for (RSproto *bus = _busList; bus != NULL; bus = bus->getNext()) {
|
||||
if (bus->getBusNumber() == busNo)
|
||||
return bus;
|
||||
}
|
||||
return NULL;
|
||||
}
|
||||
};
|
||||
|
||||
|
||||
#endif // IO_RSproto_H
|
||||
Loading…
x
Reference in New Issue
Block a user