1
0
mirror of https://github.com/DCC-EX/CommandStation-EX.git synced 2025-04-21 12:31:19 +02:00

Compare commits

...

73 Commits

Author SHA1 Message Date
Travis Farmer
8303377137
Merge a6fcad2ecf0dc7fdd5d92730db6cb49f9ef7c738 into 818240b3496db750a485e08d06a1be26ebf79e8f 2024-12-28 13:22:26 -05:00
travis-farmer
a6fcad2ecf
increased task buffer size 2024-12-28 03:26:03 -05:00
travis-farmer
23eb35290f
code cleaned 2024-12-28 03:00:23 -05:00
travis-farmer
495c9407a8
works 2024-12-28 02:40:50 -05:00
travis-farmer
25c01e0ca4
update for better task handeling, untested 2024-12-26 17:21:02 -05:00
travis-farmer
51058a66f3
last working, full-duplex 2024-12-26 15:40:20 -05:00
travis-farmer
8a28cf1d21
rename driver class 2024-12-26 03:16:32 -05:00
travis-farmer
74cb0c12b0
saving: works 2024-12-23 08:43:12 -05:00
travis-farmer
250a34bc09
sorta works 2024-12-22 16:02:07 -05:00
travis-farmer
c151b52114
save current 2024-12-22 05:20:25 -05:00
travis-farmer
d892c27f3f
saving current 2024-12-21 11:42:24 -05:00
travis-farmer
da221eb9e7
passes CRC 2024-12-20 17:06:56 -05:00
travis-farmer
415dc2674a
save current 2024-12-19 17:28:54 -05:00
travis-farmer
8414ff737c
save current 2024-12-18 17:53:02 -05:00
travis-farmer
aa7cf84e2d
save current 2024-12-18 11:06:30 -05:00
travis-farmer
f0b3f5dc16
save current 2024-12-17 17:28:10 -05:00
travis-farmer
943eaa0484
made serial writes one operation 2024-12-16 12:33:44 -05:00
travis-farmer
8532517c4e
fixed return states 2024-12-16 10:21:47 -05:00
travis-farmer
e97830542e
change to full-duplex token ring style 2024-12-16 06:14:59 -05:00
travis-farmer
74bfb0ca6e
ready for hardware debugging 2024-12-15 16:43:26 -05:00
travis-farmer
0a6bc136b0
compiles! 2024-12-15 16:36:02 -05:00
travis-farmer
2d1f4ca108
saving current 2024-12-15 12:18:52 -05:00
travis-farmer
a11ebb3ed8
transmits but wont receive 2024-12-14 16:55:53 -05:00
travis-farmer
f22daf0914
Compiles!! 2024-12-13 17:19:45 -05:00
travis-farmer
e4ea6e5633
saving 2024-12-13 16:48:53 -05:00
travis-farmer
3b2ea6f337
does not compile, saving current 2024-12-13 16:46:17 -05:00
travis-farmer
577511f92f
rename branch, remove possible blockers 2024-12-13 09:04:12 -05:00
travis-farmer
428796fa9c
miss-spelled DIAG text 2024-12-13 05:22:28 -05:00
travis-farmer
cf833b3bb0
cleaning and debugging 2024-12-13 05:16:36 -05:00
travis-farmer
53d23770f6
tidy up and debug 2024-12-13 04:04:13 -05:00
travis-farmer
cd4230dafb
driver name change 2024-12-12 15:47:25 -05:00
travis-farmer
cd1afaf04d
now it is first prototype - forgot a few things 2024-12-12 15:22:07 -05:00
travis-farmer
523f2bd7ea
first untested prototype 2024-12-12 14:52:51 -05:00
travis-farmer
d105e0c607
save current 2024-12-12 12:17:23 -05:00
travis-farmer
9c8bdc7728
saving current 2024-12-12 10:31:32 -05:00
travis-farmer
77f1c3c99f
first prototype EX-MB-ioexpander, CS side 2024-12-11 14:21:04 -05:00
travis-farmer
3cb6a35dde
IO_Modbus: removed board limits. too annoying. 2024-12-02 14:15:06 -05:00
travis-farmer
4ad07e01ee
IO_Modbus: corrected attribution 2024-12-02 04:06:06 -05:00
travis-farmer
8137423325
IO_Modbus: board support limits 2024-12-01 12:26:12 -05:00
travis-farmer
f47e417c8f
IO_Modbus: tidy up some constant references 2024-12-01 09:42:55 -05:00
travis-farmer
7d0cfbc742
IO_Modbus: fixed odd bracket indentation 2024-12-01 00:43:55 -05:00
travis-farmer
72e2ec5433
IO_Modbus: Trying to improve error recovery 2024-12-01 00:40:04 -05:00
travis-farmer
f1217bf92f
IO_Modbus: slight change 2024-11-30 14:20:46 -05:00
travis-farmer
a31b671ea0
IO_Modbus: move next after failure 2024-11-30 14:06:23 -05:00
travis-farmer
9837cff4a5
IO_Modbus: works great now! 2024-11-30 13:33:28 -05:00
travis-farmer
a85fa6d9c2
Remove blocking behaviour? 2024-11-30 05:41:29 -05:00
travis-farmer
9e5b864055
IO_Modbus: commented out Mbed delay 2024-11-29 04:38:57 -05:00
travis-farmer
411d5c0087
IO_Modbus: Works! pending further tests... 2024-11-28 16:59:13 -05:00
travis-farmer
367b86cd09
Maybe fix? 2024-11-28 08:06:01 -05:00
travis-farmer
6551ce7b50
hardware test shows VPINs are off by one 2024-11-28 07:36:12 -05:00
travis-farmer
ad70456341
IO_Modbus: add status LEDs, STM32 2024-11-28 05:22:11 -05:00
travis-farmer
5d219044f2
tidy up IO_Modbus some more 2024-11-28 04:20:22 -05:00
travis-farmer
6df1774f17
cleaning up IO_Modbus 2024-11-28 04:17:30 -05:00
travis-farmer
d0bbdae714
seems to work, but need to test on hardware 2024-11-27 15:40:02 -05:00
travis-farmer
5c40577703
updating 2024-11-27 07:35:00 -05:00
travis-farmer
5a4b87846c
some type fixes 2024-11-27 04:57:47 -05:00
travis-farmer
83130f0c4a
fixed some errors 2024-11-26 17:18:14 -05:00
travis-farmer
8afb11f520
some interesting results... 2024-11-26 15:38:41 -05:00
travis-farmer
8624b0aa79
making current 2024-11-26 08:18:22 -05:00
travis-farmer
0b5aca43f8
still not working... 2024-11-25 17:13:51 -05:00
travis-farmer
efdc14539b
i don't know what was fixed 2024-11-25 13:23:44 -05:00
travis-farmer
44486605a5
fix vpin numbers 2024-11-25 10:43:17 -05:00
travis-farmer
62de9d9796
fix function names: getNumDiscreteInputs 2024-11-25 05:50:33 -05:00
travis-farmer
9ca731cecd
fix comment 2024-11-25 05:32:30 -05:00
travis-farmer
68a44037c5
move errorStrings 2024-11-25 05:28:49 -05:00
travis-farmer
75a00f776a
dereference errorStrings? 2024-11-25 05:26:46 -05:00
travis-farmer
6d2586f88e
added analog, though still no positive test 2024-11-25 05:18:16 -05:00
travis-farmer
9fc3d1484e
Merge branch 'devel' of https://github.com/travis-farmer/CommandStation-EX into devel-modbus 2024-11-24 15:34:01 -05:00
travis-farmer
406c057335
runs but does not work yet 2024-11-24 15:31:55 -05:00
travis-farmer
e01de49d36
Diag message fix 2024-11-24 05:33:10 -05:00
travis-farmer
56a68fd9af
possible flaboo fix 2024-11-24 05:23:43 -05:00
travis-farmer
755e6ab0cc
squish together IO_Modbus 2024-11-24 04:39:52 -05:00
travis-farmer
b39523bfa6
initial commit, compiles, but hangs STM32 2024-11-23 16:15:36 -05:00
2 changed files with 1036 additions and 0 deletions

414
IO_EXIO485.cpp Normal file
View File

@ -0,0 +1,414 @@
/*
* © 2024, Travis Farmer. All rights reserved.
*
* 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/>.
*/
#include "IO_EXIO485.h"
#include "defines.h"
static const byte PAYLOAD_FALSE = 0;
static const byte PAYLOAD_NORMAL = 1;
static const byte PAYLOAD_STRING = 2;
/************************************************************
* EXIO485 implementation
************************************************************/
// Constructor for EXIO485
EXIO485::EXIO485(uint8_t busNo, HardwareSerial &serial, unsigned long baud, int8_t txPin, int cycleTime) {
_serial = &serial;
_baud = baud;
_txPin = txPin;
_busNo = busNo;
_cycleTime = cycleTime * 1000UL;
bufferLength=0;
inCommandPayload=PAYLOAD_FALSE;
// Add device to HAL device chain
IODevice::addDevice(this);
// Add bus to EXIO485 chain.
_nextBus = _busList;
_busList = this;
}
// CRC-16 implementation
uint16_t EXIO485::crc16(uint8_t *data, uint16_t length) {
uint16_t crc = 0xFFFF;
for (uint16_t i = 0; i < length; i++) {
crc ^= data[i];
for (int j = 0; j < 8; j++) {
bool bit = ((crc & 0x0001) != 0);
crc >>= 1;
if (bit) {
crc ^= 0xA001;
}
}
}
return crc;
}
/* -= _loop =-
//
// Main loop function for EXIO485.
// Work through list of nodes. For each node, in separate loop entries
// When the slot time has finished, move on to the next device.
*/
void EXIO485::_loop(unsigned long currentMicros) {
_currentMicros = currentMicros;
if (_currentNode == NULL) _currentNode = _nodeListStart;
if (!hasTasks() && _currentNode->isInitialised()) { // no tasks? lets poll for data
uint8_t buffA[3];
buffA[0] = (_currentNode->getNodeID());
buffA[1] = (0);
buffA[2] = (EXIORDD);
addTask(buffA, 3, EXIORDD);
uint8_t buffB[3];
buffB[0] = (_currentNode->getNodeID());
buffB[1] = (0);
buffB[2] = (EXIORDAN);
addTask(buffB, 3, EXIORDAN);
_currentNode = _currentNode->getNext();
}
if ( hasTasks()){ // do we have any tasks on the docket
_cycleStartTimeA = _currentMicros;
if (CurrentTaskID == -1) CurrentTaskID = getNextTaskId();
Task* currentTask = getTaskById(CurrentTaskID);
if (!currentTask->rxMode) {
currentTask->crcPassFail = 0;
uint16_t response_crc = crc16((uint8_t*)currentTask->commandArray, currentTask->byteCount-1);
if (_txPin != -1) ArduinoPins::fastWriteDigital(_txPin,HIGH);
// Send response data with CRC
_serial->write(0xFE);
_serial->write(0xFE);
_serial->write(response_crc >> 8);
_serial->write(response_crc & 0xFF);
_serial->write(currentTask->byteCount);
for (int i = 0; i < currentTask->byteCount; i++) {
_serial->write(currentTask->commandArray[i]);
}
_serial->write(0xFD);
_serial->write(0xFD);
_serial->flush();
if (_txPin != -1) ArduinoPins::fastWriteDigital(_txPin,LOW);
// delete task command after sending, for now
currentTask->rxMode = true;
} else {
if ( _serial->available()) {
int curByte = _serial->read();
if (curByte == 0xFE && flagStart == false) flagStart = true;
else if ( curByte == 0xFE && flagStart == true) {
flagProc = false;
byteCounter = 0;
flagStarted = true;
flagStart = false;
flagEnded = false;
rxStart = true;
rxEnd = false;
crcPass = false;
memset(received_data, 0, ARRAY_SIZE);
}else if (flagStarted) {
crc[0] = curByte;
byteCounter++;
flagStarted = false;
} else if (byteCounter == 1) {
crc[1] = curByte;
received_crc = (crc[0] << 8) | crc[1];
byteCounter++;
} else if (byteCounter == 2) {
byteCount = curByte;
byteCounter++;
} else if (flagEnded == false && byteCounter >= 3) {
received_data[byteCounter-3] = curByte;
byteCounter++;
}
if (curByte == 0xFD && flagEnd == false) flagEnd = true;
else if ( curByte == 0xFD && flagEnd == true) {
flagEnded = true;
flagEnd = false;
rxEnd = true;
byteCount = byteCounter;
byteCounter = 0;
}
if (flagEnded) {
calculated_crc = crc16((uint8_t*)received_data, byteCount-6);
if (received_crc == calculated_crc) {
crcPass = true;
}
flagEnded = false;
}
}
// Check CRC validity
if (crcPass) {
// Data received successfully, process it (e.g., print)
int nodeTo = received_data[0];
if (nodeTo == 0) { // for master.
flagProc = true;
}
}
if (flagProc) {
crcPass = false;
int nodeFr = received_data[1];
EXIO485node *node = findNode(nodeFr);
int AddrCode = received_data[2];
switch (AddrCode) {
case EXIOPINS:
{node->setnumDigitalPins(received_data[3]);
node->setnumAnalogPins(received_data[4]);
// See if we already have suitable buffers assigned
if (node->getnumDigialPins()>0) {
size_t digitalBytesNeeded = (node->getnumDigialPins() + 7) / 8;
if (node->getdigitalPinBytes() < digitalBytesNeeded) {
// Not enough space, free any existing buffer and allocate a new one
if (node->cleandigitalPinStates(digitalBytesNeeded)) {
node->setdigitalPinBytes(digitalBytesNeeded);
} else {
DIAG(F("EX-IOExpander485 node:%d ERROR alloc %d bytes"), nodeFr, digitalBytesNeeded);
node->setdigitalPinBytes(0);
}
}
}
if (node->getnumAnalogPins()>0) {
size_t analogueBytesNeeded = node->getnumAnalogPins() * 2;
if (node->getanalogPinBytes() < analogueBytesNeeded) {
// Free any existing buffers and allocate new ones.
if (node->cleanAnalogStates(analogueBytesNeeded)) {
node->setanalogPinBytes(analogueBytesNeeded);
} else {
DIAG(F("EX-IOExpander485 node:%d ERROR alloc analog pin bytes"), nodeFr);
node->setanalogPinBytes(0);
}
}
}
markTaskCompleted(CurrentTaskID);
flagProc = false;
break;}
case EXIOINITA: {
for (int i = 0; i < node->getnumAnalogPins(); i++) {
node->setanalogPinMap(received_data[i+3], i);
}
markTaskCompleted(CurrentTaskID);
flagProc = false;
break;
}
case EXIOVER: {
node->setMajVer(received_data[3]);
node->setMinVer(received_data[4]);
node->setPatVer(received_data[5]);
DIAG(F("EX-IOExpander485: Found node %d v%d.%d.%d"),node->getNodeID(), node->getMajVer(), node->getMinVer(), node->getPatVer());
node->setInitialised();
markTaskCompleted(CurrentTaskID);
flagProc = false;
break;
}
case EXIORDY: {
markTaskCompleted(CurrentTaskID);
flagProc = false;
break;
}
case EXIOERR: {
markTaskCompleted(CurrentTaskID);
DIAG(F("EX-IOExplorer485: Some sort of error was received...")); // ;-)
flagProc = false;
break;
}
case EXIORDAN: {
for (int i = 0; i < node->_numAnaloguePins; i++) {
node->setanalogInputBuffer(received_data[i+3], i);
}
markTaskCompleted(CurrentTaskID);
flagProc = false;
break;
}
case EXIORDD: {
for (int i = 0; i < (node->_numDigitalPins+7)/8; i++) {
node->setdigitalInputStates(received_data[i+3], i);
}
markTaskCompleted(CurrentTaskID);
flagProc = false;
break;
}
}
}
}
}
}
// Link to chain of EXIO485 instances, left over from EXIO485 template.
EXIO485 *EXIO485::_busList = NULL;
/************************************************************
* EXIO485node implementation
************************************************************/
/* -= EXIO485node =-
//
// Constructor for EXIO485node object
*/
EXIO485node::EXIO485node(VPIN firstVpin, int nPins, uint8_t nodeID) {
_firstVpin = firstVpin;
_nPins = nPins;
_busNo = 0;
_nodeID = nodeID;
_initialised = false;
memset(resFlag, 0, 255);
if (_nodeID > 252) _nodeID = 252; // cannot have a node with the frame flags
if (_nodeID < 1) _nodeID = 1; // cannot have a node with the master ID
// Add this device to HAL device list
IODevice::addDevice(this);
_display();
// Add EXIO485node to EXIO485 object.
EXIO485 *bus = EXIO485::findBus(_busNo);
if (bus != NULL) {
bus->addNode(this);
return;
}
}
bool EXIO485node::_configure(VPIN vpin, ConfigTypeEnum configType, int paramCount, int params[]) {
if (paramCount != 1) return false;
int pin = vpin - _firstVpin;
uint8_t pullup = (uint8_t)params[0];
uint8_t buff[ARRAY_SIZE];
buff[0] = (_nodeID);
buff[1] = (0);
buff[2] = (EXIODPUP);
buff[3] = (pin);
buff[4] = (pullup);
EXIO485 *bus = EXIO485::findBus(0);
bus->setBusy();
bus->addTask(buff, 5, EXIODPUP);
return true;
}
int EXIO485node::_configureAnalogIn(VPIN vpin) {
int pin = vpin - _firstVpin;
uint8_t buff[ARRAY_SIZE];
buff[0] = (_nodeID);
buff[1] = (0);
buff[2] = (EXIOENAN);
buff[3] = (pin);
buff[4] = lowByte(_firstVpin);
buff[5] = highByte(_firstVpin);
EXIO485 *bus = EXIO485::findBus(0);
bus->setBusy();
bus->addTask(buff, 6, EXIOENAN);
return false;
}
void EXIO485node::_begin() {
uint8_t buff[ARRAY_SIZE];
buff[0] = (_nodeID);
buff[1] = (0);
buff[2] = (EXIOINIT);
buff[3] = (_nPins);
buff[4] = ((_firstVpin & 0xFF));
buff[5] = ((_firstVpin >> 8));
EXIO485 *bus = EXIO485::findBus(0);
bus->setBusy();
bus->addTask(buff, 6, EXIOINIT);
buff[0] = (_nodeID);
buff[1] = (0);
buff[2] = (EXIOINITA);
bus->setBusy();
bus->addTask(buff, 3, EXIOINITA);
buff[0] = (_nodeID);
buff[1] = (0);
buff[2] = (EXIOVER);
bus->setBusy();
bus->addTask(buff, 3, EXIOVER);
#ifdef DIAG_IO
_display();
#endif
}
int EXIO485node::_read(VPIN vpin) {
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 EXIO485node::_write(VPIN vpin, int value) {
if (_deviceState == DEVSTATE_FAILED) return;
int pin = vpin - _firstVpin;
uint8_t buff[ARRAY_SIZE];
buff[0] = (_nodeID);
buff[1] = (0);
buff[2] = (EXIOWRD);
buff[3] = (pin);
buff[4] = (value);
EXIO485 *bus = EXIO485::findBus(0);
bus->setBusy();
bus->addTask(buff, 5, EXIOWRD);
}
int EXIO485node::_readAnalogue(VPIN vpin) {
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 EXIO485node::_writeAnalogue(VPIN vpin, int value, uint8_t profile, uint16_t duration) {
int pin = vpin - _firstVpin;
uint8_t buff[ARRAY_SIZE];
buff[0] = (_nodeID);
buff[1] = (0);
buff[2] = (EXIOWRAN);
buff[3] = (pin);
buff[4] = lowByte(value);
buff[5] = highByte(value);
buff[6] = (profile);
buff[7] = lowByte(duration);
buff[8] = highByte(duration);
EXIO485 *bus = EXIO485::findBus(0);
bus->setBusy();
bus->addTask(buff, 9, EXIOWRAN);
}

622
IO_EXIO485.h Normal file
View File

@ -0,0 +1,622 @@
/*
* © 2024, Travis Farmer. All rights reserved.
*
* 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/>.
*/
/*
* EXIO485
* =======
* To define a EXIO485, example syntax:
* EXIO485::create(busNo, serial, baud[, TxPin]);
*
* busNo = the Bus no of the instance. should = 0, unless more than one bus configured for some reason.
* 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)
* TxPin = pin number connected to EXIO485 module's DE and !RE terminals for half-duplex operation (default -1)
* if omitted (default), hardware MUST support full-duplex opperation!
*
*
* EXIO485Node
* ========
* To define a EXIO485 node and associate it with a EXIO485 bus,
* EXIO485node::create(firstVPIN, numVPINs, nodeID);
*
* firstVPIN = first vpin in block allocated to this device
* numVPINs = number of vpins
* nodeID = 1-252
*/
#ifndef IO_EXIO485_H
#define IO_EXIO485_H
#include "IODevice.h"
class EXIO485;
class EXIO485node;
#ifndef COMMAND_BUFFER_SIZE
#define COMMAND_BUFFER_SIZE 900
#endif
/**********************************************************************
* Data Structure
*
* Data Frame:
* 0xFE : 0xFE : CRC : CRC : ByteCount : DataPacket : 0xFD : 0xFD
* --------------------------------------------------------------
* Start Frame : CRC Bytes : Data Size : Data : End Frame
*
* Data frame must always start with the Start Frame bytes (two Bytes),
* follow with the CRC bytes (two bytes), the data byte count
* (one byte), the Data Packet (variable bytes), and the end Frame
* Bytes.
*
*
* Data Packet:
* NodeTo : NodeFrom : AddrCode : ~Command Params~
* -----------------------------------------------
* NodeTo = where the packet is destined for.
* NodeFrom = where the packet came from.
* Address Code = from EXIO enumeration.
* Command Params:
*
* EXIOINIT:TX CS
* --------
* nPins : FirstPinL : FirstPinH
* -----------------------------
* nPins = Number of allocated pins.
* FirstPinL = First VPIN lowByte.
* FirstPinH = First VPIN highByte.
*
* Sends the allocated pins.
*
* EXIOINITA: Tx CS
* -=no parameters, just a header=-
*
* requests the analog pin map from the node.
*
* EXIOVER: Tx CS
* -=no parameters=-
*
* requests the node software version, but as yet to do anything with it
*
* EXIODPUP: Tx CS
* pin : pullup
*
* pin = VPIN number
* pullup = 1 - Pullup, 0 - no pullup
* configures a digital pin for input
*
* EXIOENAN: TX CS
* pin : FirstPinL : FirstPinH
*
* pin = VPIN number
* FirstPinL = first pin lowByte
* FirstPinH = first pin highByte
*
* EXIOWRD: TX CS
* pin : value
*
* pin = VPIN number
* value = 1 or 0
*
* EXIOWRAN: TX CS
* pin : valueL : valueH : profile : durationL : durationH
*
* pin = VPIN Number
* valueL = value lowByte
* valueH = value highByte
* profile = servo profile
* dueationL = duration lowByte
* durationH = duration highByte
*
* EXIORDD: TX CS
* -=No Parameters=-
*
* Requests digital pin states.
*
* EXIORDAN: TX CS
* -=no parameters=-
*
* Requests analog pin states.
*
* EXIOPINS: TX Node (EXIOINIT)
* numDigital : numAnalog
*
* numDigital = number of digital capable pins
* numAnalog = number of analog capable pins
*
* EXIOINITA: TX Node (EXIOINITA)
* ~analog pin map~
*
* each byte is a analog pin map value, variable length.
*
* EXIORDY/EXIOERR: TX Node (EXIODPUP, EXIOWRD, EXIOENAN, EXIOWRAN)
* -=no parameters=-
*
* Responds EXIORDY for OK, and EXIOERR for FAIL.
*
* EXIORDAN: TX Node (EXIORDAN)
* ~analog pin states~
*
* each byte is a pin state value, perhaps in lowByte/higeByte config.
*
* EXIORDD: TX Node (EXIORDD)
* ~digital pin states~
*
* each byte is a 8-bit grouping of pinstates.
*
* EXIOVER: TX Node (EXIOVER)
* Major Version : Minor Version : Patch Version
*
* each byte represents a numeric version value.
**********************************************************************/
/**********************************************************************
* EXIO485node class
*
* This encapsulates the state associated with a single EXIO485 node,
* which includes the nodeID, number of discrete inputs and coils, and
* the states of the discrete inputs and coils.
**********************************************************************/
class EXIO485node : public IODevice {
private:
uint8_t _busNo;
uint8_t _nodeID;
char _type;
EXIO485node *_next = NULL;
bool _initialised;
EXIO485 *bus;
HardwareSerial* _serial;
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
};
static const int ARRAY_SIZE = 254;
public:
static EXIO485node *_nodeList;
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 getnumDigialPins() {
return _numDigitalPins;
}
void setnumDigitalPins(uint8_t value) {
_numDigitalPins = value;
}
uint8_t _numAnaloguePins = 0;
uint8_t getnumAnalogPins() {
return _numAnaloguePins;
}
void setnumAnalogPins(uint8_t value) {
_numAnaloguePins = value;
}
uint8_t _majorVer = 0;
uint8_t getMajVer() {
return _majorVer;
}
void setMajVer(uint8_t value) {
_majorVer = value;
}
uint8_t _minorVer = 0;
uint8_t getMinVer() {
return _minorVer;
}
void setMinVer(uint8_t value) {
_minorVer = value;
}
uint8_t _patchVer = 0;
uint8_t getPatVer() {
return _patchVer;
}
void setPatVer(uint8_t value) {
_patchVer = value;
}
uint8_t* _digitalInputStates = NULL;
uint8_t getdigitalInputStates(int index) {
return _digitalInputStates[index];
}
void setdigitalInputStates(uint8_t value, int index) {
_digitalInputStates[index] = value;
}
bool cleandigitalPinStates(int size) {
if (_digitalPinBytes > 0) free(_digitalInputStates);
if ((_digitalInputStates = (byte*) calloc(size, 1)) != NULL) {
return true;
} else return false;
}
uint8_t* _analogueInputStates = NULL;
uint8_t getanalogInputStates(int index) {
return _analogueInputStates[index];
}
void setanalogInputStates(uint8_t value, int index) {
_analogueInputStates[index] = value;
}
uint8_t* _analogueInputBuffer = NULL; // buffer for I2C input transfers
uint8_t getanalogInpuBuffer(int index) {
return _analogueInputBuffer[index];
}
void setanalogInputBuffer(uint8_t value, int index) {
_analogueInputBuffer[index] = value;
memcpy(_analogueInputStates, _analogueInputBuffer, _analoguePinBytes);
}
uint8_t _readCommandBuffer[4]; // unused?
uint8_t _digitalPinBytes = 0; // Size of allocated memory buffer (may be longer than needed)
uint8_t getdigitalPinBytes() {
return _digitalPinBytes;
}
void setdigitalPinBytes(uint8_t value) {
_digitalPinBytes = value;
}
uint8_t _analoguePinBytes = 0; // Size of allocated memory buffer (may be longer than needed)
uint8_t getanalogPinBytes() {
return _analoguePinBytes;
}
void setanalogPinBytes(uint8_t value) {
_analoguePinBytes = value;
}
uint8_t* _analoguePinMap = NULL;
uint8_t getanalogPinMap(int index) {
return _analoguePinMap[index];
}
void setanalogPinMap(uint8_t value, int index) {
_analoguePinMap[index] = value;
}
bool cleanAnalogStates(int size) {
if (_analoguePinBytes > 0) {
free(_analogueInputBuffer);
free(_analogueInputStates);
free(_analoguePinMap);
}
_analogueInputStates = (uint8_t*) calloc(size, 1);
_analogueInputBuffer = (uint8_t*) calloc(size, 1);
_analoguePinMap = (uint8_t*) calloc(_numAnaloguePins, 1);
if (_analogueInputStates != NULL && _analogueInputBuffer != NULL && _analoguePinMap != NULL) return true;
else return false;
}
int resFlag[255];
bool _initalized;
static void create(VPIN firstVpin, int nPins, uint8_t nodeID) {
if (checkNoOverlap(firstVpin, nPins)) new EXIO485node(firstVpin, nPins, nodeID);
}
EXIO485node(VPIN firstVpin, int nPins, uint8_t nodeID);
uint8_t getNodeID() {
return _nodeID;
}
EXIO485node *getNext() {
return _next;
}
void setNext(EXIO485node *node) {
_next = node;
}
bool isInitialised() {
return _initialised;
}
void setInitialised() {
_initialised = true;
}
bool _configure(VPIN vpin, ConfigTypeEnum configType, int paramCount, int params[]) override;
int _configureAnalogIn(VPIN vpin) override;
void _begin() override;
int _read(VPIN vpin) override;
void _write(VPIN vpin, int value) override;
int _readAnalogue(VPIN vpin) override;
void _writeAnalogue(VPIN vpin, int value, uint8_t profile, uint16_t duration) override;
uint8_t getBusNumber() {
return _busNo;
}
void _display() override {
DIAG(F("EX-IOExpander485 node:%d Vpins %u-%u %S"), _nodeID, (int)_firstVpin, (int)_firstVpin+_nPins-1, _deviceState == DEVSTATE_FAILED ? F("OFFLINE") : F(""));
}
};
/**********************************************************************
* EXIO485 class
*
* This encapsulates the properties state of the bus and the
* transmission and reception of data across that bus. Each EXIO485
* object owns a set of EXIO485node objects which represent the nodes
* attached to that bus.
**********************************************************************/
class EXIO485 : public IODevice {
private:
// Here we define the device-specific variables.
uint8_t _busNo;
unsigned long _cycleStartTime = 0;
unsigned long _cycleStartTimeA = 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;
byte bufferLength;
static const int ARRAY_SIZE = 150;
int buffer[ARRAY_SIZE];
byte inCommandPayload;
static EXIO485 *_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
EXIO485node *_nodeListStart = NULL, *_nodeListEnd = NULL;
EXIO485node *_currentNode = NULL;
uint16_t _receiveDataIndex = 0; // Index of next data byte to be received.
EXIO485 *_nextBus = NULL; // Pointer to next bus instance in list.
int byteCounter = 0;
public:
struct Task {
static const int ARRAY_SIZE = 150;
long taskID;
uint8_t commandArray[ARRAY_SIZE];
int byteCount;
uint8_t retFlag;
bool gotCallback;
bool rxMode;
int crcPassFail;
bool completed;
bool processed;
};
static const int MAX_TASKS = 1000;
long taskIDCntr = 1;
long CurrentTaskID = -1;
int taskResendCount = 0;
Task taskBuffer[MAX_TASKS]; // Buffer to hold up to 100 tasks
int currentTaskIndex = 0;
void addTask(const uint8_t* cmd, int byteCount, uint8_t retFlag) {
// Find an empty slot in the buffer
int emptySlot = -1;
for (int i = 0; i < MAX_TASKS; i++) {
if (taskBuffer[i].completed) {
emptySlot = i;
break;
}
}
// If no empty slot found, return (buffer full)
if (emptySlot == -1) {
DIAG(F("Task Buffer Full!"));
return;
}
for (int i = 0; i < byteCount; i++) taskBuffer[emptySlot].commandArray[i] = cmd[i];
taskBuffer[emptySlot].byteCount = byteCount;
taskBuffer[emptySlot].retFlag = retFlag;
taskBuffer[emptySlot].rxMode = false;
taskBuffer[emptySlot].crcPassFail = 0;
taskBuffer[emptySlot].gotCallback = false;
taskBuffer[emptySlot].completed = false;
taskBuffer[emptySlot].processed = false;
taskIDCntr++;
if (taskIDCntr >= 5000000) taskIDCntr = 1;
taskBuffer[emptySlot].taskID = taskIDCntr;
currentTaskIndex = emptySlot;
}
bool hasTasks() {
for (int i = 0; i < MAX_TASKS; i++) {
if (!taskBuffer[i].completed) {
return true; // At least one task is not completed
}
}
return false; // All tasks are completed
}
// Function to get a specific task by ID
Task* getTaskById(int id) {
for (int i = 0; i < MAX_TASKS; i++) {
if (taskBuffer[i].taskID == id) {
return &taskBuffer[i]; // Return a pointer to the task
}
}
return nullptr; // Task not found
}
// Function to get the next task (optional)
long getNextTaskId() {
for (int i = 0; i < MAX_TASKS; i++) {
if (!taskBuffer[i].completed) {
return taskBuffer[i].taskID;
}
}
return -1; // No tasks available
}
// Function to mark a task as completed
void markTaskCompleted(int id) {
for (int i = 0; i < MAX_TASKS; i++) {
if (taskBuffer[i].taskID == id) {
taskBuffer[i].completed = true; // completed
taskBuffer[i].taskID = -1; // unassigned
CurrentTaskID = getNextTaskId();
break;
}
}
}
bool flagEnd = false;
bool flagEnded = false;
bool flagStart = false;
bool flagStarted = false;
bool rxStart = false;
bool rxEnd = false;
bool crcPass = false;
bool flagProc = false;
uint16_t calculated_crc;
int byteCount = 100;
uint8_t received_data[ARRAY_SIZE];
uint16_t received_crc;
uint8_t crc[2];
uint16_t crc16(uint8_t *data, uint16_t length);
// 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
};
static void create(uint8_t busNo, HardwareSerial &serial, unsigned long baud, int8_t txPin=-1, int cycleTime=500) {
new EXIO485(busNo, serial, baud, txPin, cycleTime);
}
HardwareSerial* _serial;
int _CommMode = 0;
int _opperation = 0;
uint16_t _pullup;
uint16_t _pin;
int8_t _txPin;
int8_t getTxPin() {
return _txPin;
}
bool _busy = false;
void setBusy() {
_busy = true;
}
void clearBusy() {
_busy = false;
}
bool getBusy() {
return _busy;
}
unsigned long _baud;
int taskCnt = 0;
uint8_t initBuffer[1] = {0xFE};
unsigned long taskCounter=0ul;
// Device-specific initialisation
void _begin() override {
_serial->begin(_baud, SERIAL_8N1);
if (_txPin >0) {
pinMode(_txPin, OUTPUT);
digitalWrite(_txPin, LOW);
}
#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 EXIO485node object with specified nodeID.
EXIO485node *findNode(uint8_t nodeID) {
for (EXIO485node *node = _nodeListStart; node != NULL; node = node->getNext()) {
if (node->getNodeID() == nodeID)
return node;
}
return NULL;
}
bool nodesInitialized() {
bool retval = true;
for (EXIO485node *node = _nodeListStart; node != NULL; node = node->getNext()) {
if (node->_initalized == false)
retval = false;
}
return retval;
}
// Add new EXIO485node to the list of nodes for this bus.
void addNode(EXIO485node *newNode) {
if (!_nodeListStart)
_nodeListStart = newNode;
if (!_nodeListEnd)
_nodeListEnd = newNode;
else
_nodeListEnd->setNext(newNode);
//DIAG(F("EXIO485: 260h nodeID:%d _nodeListStart:%d _nodeListEnd:%d"), newNode, _nodeListStart, _nodeListEnd);
}
protected:
EXIO485(uint8_t busNo, HardwareSerial &serial, unsigned long baud, int8_t txPin, int cycleTime);
public:
uint8_t getBusNumber() {
return _busNo;
}
EXIO485 *getNext() {
return _nextBus;
}
static EXIO485 *findBus(uint8_t busNo) {
for (EXIO485 *bus = _busList; bus != NULL; bus = bus->getNext()) {
if (bus->getBusNumber() == busNo)
return bus;
}
return NULL;
}
};
#endif // IO_EXIO485_H