From d2cf8549c83af0fb8441f49dcaa5fa45ffc1efdf Mon Sep 17 00:00:00 2001 From: Carsten Schmiemann Date: Thu, 7 Feb 2019 01:13:58 +0100 Subject: [PATCH] First Test --- .DS_Store | Bin 6148 -> 8196 bytes lib/.DS_Store | Bin 0 -> 6148 bytes lib/SimpleModbusSlave/SimpleModbusSlave.cpp | 262 +++++++ lib/SimpleModbusSlave/SimpleModbusSlave.h | 63 ++ .../SimpleModbusSlaveArduino.ino | 107 +++ lib/SimpleModbusSlave/gpl-3.0.txt | 674 ++++++++++++++++++ lib/SimpleModbusSlave/keywords.txt | 2 + platformio.ini | 1 + src/main.cpp | 54 +- 9 files changed, 1161 insertions(+), 2 deletions(-) create mode 100644 lib/.DS_Store create mode 100755 lib/SimpleModbusSlave/SimpleModbusSlave.cpp create mode 100755 lib/SimpleModbusSlave/SimpleModbusSlave.h create mode 100755 lib/SimpleModbusSlave/examples/SimpleModbusSlaveArduino/SimpleModbusSlaveArduino.ino create mode 100755 lib/SimpleModbusSlave/gpl-3.0.txt create mode 100755 lib/SimpleModbusSlave/keywords.txt diff --git a/.DS_Store b/.DS_Store index f31aca1ae6eb801cbf262f28ee63c1fec15b2c81..7edc79b1eef6021d0657e231cc80e2dfe91303bb 100644 GIT binary patch delta 838 zcmZ8g&1(}u6n~RV?5s)6wux;jqLEPiph{}7SVSx-rR1OqO{pnujl0=tx^y$M?oJZh z7}G<&8}_8=NfA7jfFAq{#Itzw;?;u(K@T3B%_bIHc=LYqzJD`22kC?P1OT8+O`itv zAQs|jCER&1*12*HDTnzFQa6eJNUw%4?(7GV;zok*c?%3+V2V`(9SB(9WKCAqOs0A1 zLVgN)<30_(jxR0e(=~_N!VrWzph6Xhdnt6$y&M{9YYoThXMNNx({Ok?{RIW2VCa}= zh{JdoZx*&$qrg>Ob26&E?(Om_-`4tgg)#FVR<%`wG)hW*fl;m+l-RvwLnk6+wx=?&?%>c6P4SlJWTD^v&%3>h50i zQS0$DK}CEB`5K~qJy6dDko?mz%Jn`!^kl&A>wuqpyd91VpNJ|W(a~rurkos85)&mQ zrm5wfitUZLz)WUm%o-^vQAZHZmKn|4q%KGnIeEwn#-4DE{+F;!^m|99m0e53#E%TU zqDwX*biG}%4L!HD_G=!!drL;pWrimgYWPgArwGiG>pd3IGR9b&{@=P5E$IfDZkKQMdDu{ z+)h1Qu&K#tMVL@GA9^1++&_&*BtJG07JAWp4c!s^OLC*}tecBqEDC!M1-hlk3+XRz CxYW!5 delta 112 zcmZp1XfcprU|?W$DortDU=RQ@Ie-{Mvv5r;6q~50$jH4hU^g=(_hcS{$&;@NOr6{z yD8JcUWDC<`b`B0fW}r$S5a0$9t{_bt3%@f@=9lpV8Nt8=F%Dz{!{&INIm`fvz7u}{ diff --git a/lib/.DS_Store b/lib/.DS_Store new file mode 100644 index 0000000000000000000000000000000000000000..40e0b2522d2d17fac5ac07c777be3b409b21d4b4 GIT binary patch literal 6148 zcmeHKUrQT75TA|F?jgkpLff}}Y4ITsiHhiha7~j39}1;c^udbW^$tBaZ$s{4Xw#JY z9PKyiTc7%I+L_&rG(>mISonhPtXaImjC9HYaTq872Iwv*f zsUr$g<1O^|GyN&bbTk*uj)%wqeY+)i4?TDdU6}oTG%2=F*Z&wXKYtYhNZ|tdkU@g+ z8e)iG2nG5x2;mZve`Wwx_=WoFZWW?Y(RXv`XVlNqqHMK(i`qhcap{Saa#=o=$HBQC z1!Y(ci%vK=qTai(Jdd3HLF??w4x@uK8J#rN-srpx(>xiN@#M3Y?Y;fei_c%iUnk$b8-76G zKf%a~!zuhg;}+~)27^4)`58t}D@`jfG6T#2GjLxFxb;OY-&aAd!wfJ3kA?wS9~3H~ z@369HmJV#p6#$Wrkw(y_Lm%ZRhrYwgB95R4n~G>tg}Y)1n~r|v;(UjdMVk)7T|R_+ zvT!#PVV;ill?eyoTjZ7*UI2VcqUt#dC& vd#yq}MJ1uQ%HmZD8fGiTSlWu8qZ&cKA_LKPSXo353LgXv4cssT|CNEiqStpT literal 0 HcmV?d00001 diff --git a/lib/SimpleModbusSlave/SimpleModbusSlave.cpp b/lib/SimpleModbusSlave/SimpleModbusSlave.cpp new file mode 100755 index 0000000..f17cd9f --- /dev/null +++ b/lib/SimpleModbusSlave/SimpleModbusSlave.cpp @@ -0,0 +1,262 @@ +#include "SimpleModbusSlave.h" +#include "HardwareSerial.h" + + +#define BUFFER_SIZE 128 + +// frame[] is used to recieve and transmit packages. +// The maximum serial ring buffer size is 128 +unsigned char frame[BUFFER_SIZE]; +unsigned int holdingRegsSize; // size of the register array +unsigned int* regs; // user array address +unsigned char broadcastFlag; +unsigned char slaveID; +unsigned char function; +unsigned char TxEnablePin; +unsigned int errorCount; +unsigned int T1_5; // inter character time out +unsigned int T3_5; // frame delay +HardwareSerial* ModbusPort; + +// function definitions +void exceptionResponse(unsigned char exception); +unsigned int calculateCRC(unsigned char bufferSize); +void sendPacket(unsigned char bufferSize); + +void modbus_configure(HardwareSerial *SerialPort, + long baud, + unsigned char byteFormat, + unsigned char _slaveID, + unsigned char _TxEnablePin, + unsigned int _holdingRegsSize, + unsigned int* _regs) +{ + ModbusPort = SerialPort; + (*ModbusPort).begin(baud, byteFormat); + slaveID = _slaveID; + holdingRegsSize = _holdingRegsSize; + regs = _regs; + TxEnablePin = _TxEnablePin; + pinMode(TxEnablePin, OUTPUT); + digitalWrite(TxEnablePin, LOW); + errorCount = 0; // initialize errorCount + + // Modbus states that a baud rate higher than 19200 must use a fixed 750 us + // for inter character time out and 1.75 ms for a frame delay for baud rates + // below 19200 the timing is more critical and has to be calculated. + // E.g. 9600 baud in a 10 bit packet is 960 characters per second + // In milliseconds this will be 960characters per 1000ms. So for 1 character + // 1000ms/960characters is 1.04167ms per character and finally modbus states + // an inter-character must be 1.5T or 1.5 times longer than a character. Thus + // 1.5T = 1.04167ms * 1.5 = 1.5625ms. A frame delay is 3.5T. + + if (baud > 19200) + { + T1_5 = 750; + T3_5 = 1750; + } + else + { + T1_5 = 15000000/baud; // 1T * 1.5 = T1.5 + T3_5 = 35000000/baud; // 1T * 3.5 = T3.5 + } +} + +unsigned int modbus_update() +{ + if ((*ModbusPort).available()) + { + unsigned char buffer = 0; + unsigned char overflow = 0; + + while ((*ModbusPort).available()) + { + // The maximum number of bytes is limited to the serial buffer size of 128 bytes + // If more bytes is received than the BUFFER_SIZE the overflow flag will be set and the + // serial buffer will be red untill all the data is cleared from the receive buffer. + if (overflow) + (*ModbusPort).read(); + else + { + if (buffer == BUFFER_SIZE) + overflow = 1; + frame[buffer] = (*ModbusPort).read(); + buffer++; + } + delayMicroseconds(T1_5); // inter character time out + } + + // If an overflow occurred increment the errorCount + // variable and return to the main sketch without + // responding to the request i.e. force a timeout + if (overflow) + return errorCount++; + + // The minimum request packet is 8 bytes for function 3 & 16 + if (buffer > 7) + { + unsigned char id = frame[0]; + + broadcastFlag = 0; + + if (id == 0) + broadcastFlag = 1; + + if (id == slaveID || broadcastFlag) // if the recieved ID matches the slaveID or broadcasting id (0), continue + { + unsigned int crc = ((frame[buffer - 2] << 8) | frame[buffer - 1]); // combine the crc Low & High bytes + if (calculateCRC(buffer - 2) == crc) // if the calculated crc matches the recieved crc continue + { + function = frame[1]; + unsigned int startingAddress = ((frame[2] << 8) | frame[3]); // combine the starting address bytes + unsigned int no_of_registers = ((frame[4] << 8) | frame[5]); // combine the number of register bytes + unsigned int maxData = startingAddress + no_of_registers; + unsigned char index; + unsigned char address; + unsigned int crc16; + + // broadcasting is not supported for function 3 + if (!broadcastFlag && (function == 3)) + { + if (startingAddress < holdingRegsSize) // check exception 2 ILLEGAL DATA ADDRESS + { + if (maxData <= holdingRegsSize) // check exception 3 ILLEGAL DATA VALUE + { + unsigned char noOfBytes = no_of_registers * 2; + // ID, function, noOfBytes, (dataLo + dataHi)*number of registers, + // crcLo, crcHi + unsigned char responseFrameSize = 5 + noOfBytes; + frame[0] = slaveID; + frame[1] = function; + frame[2] = noOfBytes; + address = 3; // PDU starts at the 4th byte + unsigned int temp; + + for (index = startingAddress; index < maxData; index++) + { + temp = regs[index]; + frame[address] = temp >> 8; // split the register into 2 bytes + address++; + frame[address] = temp & 0xFF; + address++; + } + + crc16 = calculateCRC(responseFrameSize - 2); + frame[responseFrameSize - 2] = crc16 >> 8; // split crc into 2 bytes + frame[responseFrameSize - 1] = crc16 & 0xFF; + sendPacket(responseFrameSize); + } + else + exceptionResponse(3); // exception 3 ILLEGAL DATA VALUE + } + else + exceptionResponse(2); // exception 2 ILLEGAL DATA ADDRESS + } + else if (function == 16) + { + // Check if the recieved number of bytes matches the calculated bytes + // minus the request bytes. + // id + function + (2 * address bytes) + (2 * no of register bytes) + + // byte count + (2 * CRC bytes) = 9 bytes + if (frame[6] == (buffer - 9)) + { + if (startingAddress < holdingRegsSize) // check exception 2 ILLEGAL DATA ADDRESS + { + if (maxData <= holdingRegsSize) // check exception 3 ILLEGAL DATA VALUE + { + address = 7; // start at the 8th byte in the frame + + for (index = startingAddress; index < maxData; index++) + { + regs[index] = ((frame[address] << 8) | frame[address + 1]); + address += 2; + } + + // only the first 6 bytes are used for CRC calculation + crc16 = calculateCRC(6); + frame[6] = crc16 >> 8; // split crc into 2 bytes + frame[7] = crc16 & 0xFF; + + // a function 16 response is an echo of the first 6 bytes from + // the request + 2 crc bytes + if (!broadcastFlag) // don't respond if it's a broadcast message + sendPacket(8); + } + else + exceptionResponse(3); // exception 3 ILLEGAL DATA VALUE + } + else + exceptionResponse(2); // exception 2 ILLEGAL DATA ADDRESS + } + else + errorCount++; // corrupted packet + } + else + exceptionResponse(1); // exception 1 ILLEGAL FUNCTION + } + else // checksum failed + errorCount++; + } // incorrect id + } + else if (buffer > 0 && buffer < 8) + errorCount++; // corrupted packet + } + return errorCount; +} + +void exceptionResponse(unsigned char exception) +{ + // each call to exceptionResponse() will increment the errorCount + errorCount++; + if (!broadcastFlag) // don't respond if its a broadcast message + { + frame[0] = slaveID; + frame[1] = (function | 0x80); // set MSB bit high, informs the master of an exception + frame[2] = exception; + unsigned int crc16 = calculateCRC(3); // ID, function|0x80, exception code + frame[3] = crc16 >> 8; + frame[4] = crc16 & 0xFF; + // exception response is always 5 bytes + // ID, function + 0x80, exception code, 2 bytes crc + sendPacket(5); + } +} + +unsigned int calculateCRC(unsigned char bufferSize) +{ + unsigned int temp, temp2, flag; + temp = 0xFFFF; + for (unsigned char i = 0; i < bufferSize; i++) + { + temp = temp ^ frame[i]; + for (unsigned char j = 1; j <= 8; j++) + { + flag = temp & 0x0001; + temp >>= 1; + if (flag) + temp ^= 0xA001; + } + } + // Reverse byte order. + temp2 = temp >> 8; + temp = (temp << 8) | temp2; + temp &= 0xFFFF; + // the returned value is already swapped + // crcLo byte is first & crcHi byte is last + return temp; +} + +void sendPacket(unsigned char bufferSize) +{ + digitalWrite(TxEnablePin, HIGH); + + for (unsigned char i = 0; i < bufferSize; i++) + (*ModbusPort).write(frame[i]); + + (*ModbusPort).flush(); + + // allow a frame delay to indicate end of transmission + delayMicroseconds(T3_5); + + digitalWrite(TxEnablePin, LOW); +} \ No newline at end of file diff --git a/lib/SimpleModbusSlave/SimpleModbusSlave.h b/lib/SimpleModbusSlave/SimpleModbusSlave.h new file mode 100755 index 0000000..40c38d0 --- /dev/null +++ b/lib/SimpleModbusSlave/SimpleModbusSlave.h @@ -0,0 +1,63 @@ +#ifndef SIMPLE_MODBUS_SLAVE_H +#define SIMPLE_MODBUS_SLAVE_H + +// SimpleModbusSlaveV7 + +/* + SimpleModbusSlave allows you to communicate + to any slave using the Modbus RTU protocol. + + This implementation DOES NOT fully comply with the Modbus specifications. + + Specifically the frame time out have not been implemented according + to Modbus standards. The code does however combine the check for + inter character time out and frame time out by incorporating a maximum + time out allowable when reading from the message stream. + + SimpleModbusSlave implements an unsigned int return value on a call to modbus_update(). + This value is the total error count since the slave started. It's useful for fault finding. + + This code is for a Modbus slave implementing functions 3 and 16 + function 3: Reads the binary contents of holding registers (4X references) + function 16: Presets values into a sequence of holding registers (4X references) + + All the functions share the same register array. + + Note: + The Arduino serial ring buffer is 128 bytes or 64 registers. + Most of the time you will connect the arduino to a master via serial + using a MAX485 or similar. + + In a function 3 request the master will attempt to read from your + slave and since 5 bytes is already used for ID, FUNCTION, NO OF BYTES + and two BYTES CRC the master can only request 122 bytes or 61 registers. + + In a function 16 request the master will attempt to write to your + slave and since a 9 bytes is already used for ID, FUNCTION, ADDRESS, + NO OF REGISTERS, NO OF BYTES and two BYTES CRC the master can only write + 118 bytes or 59 registers. + + Using a USB to Serial converter the maximum bytes you can send is + limited to its internal buffer which differs between manufactures. + + The functions included here have been derived from the + Modbus Specifications and Implementation Guides + + http://www.modbus.org/docs/Modbus_over_serial_line_V1_02.pdf + http://www.modbus.org/docs/Modbus_Application_Protocol_V1_1b.pdf + http://www.modbus.org/docs/PI_MBUS_300.pdf +*/ + +#include "Arduino.h" + +// function definitions +unsigned int modbus_update(); +void modbus_configure(HardwareSerial *SerialPort, + long baud, + unsigned char byteFormat, + unsigned char _slaveID, + unsigned char _TxEnablePin, + unsigned int _holdingRegsSize, + unsigned int* _regs); + +#endif diff --git a/lib/SimpleModbusSlave/examples/SimpleModbusSlaveArduino/SimpleModbusSlaveArduino.ino b/lib/SimpleModbusSlave/examples/SimpleModbusSlaveArduino/SimpleModbusSlaveArduino.ino new file mode 100755 index 0000000..139f46d --- /dev/null +++ b/lib/SimpleModbusSlave/examples/SimpleModbusSlaveArduino/SimpleModbusSlaveArduino.ino @@ -0,0 +1,107 @@ +#include + +/* This example code will receive the adc ch0 value from the arduino master. + It will then use this value to adjust the brightness of the led on pin 9. + The value received from the master will be stored in address 1 in its own + address space namely holdingRegs[]. + + In addition to this the slaves own adc ch0 value will be stored in + address 0 in its own address space holdingRegs[] for the master to + be read. The master will use this value to alter the brightness of its + own led connected to pin 9. + + The modbus_update() method updates the holdingRegs register array and checks + communication. + + Note: + The Arduino serial ring buffer is 128 bytes or 64 registers. + Most of the time you will connect the arduino to a master via serial + using a MAX485 or similar. + + In a function 3 request the master will attempt to read from your + slave and since 5 bytes is already used for ID, FUNCTION, NO OF BYTES + and two BYTES CRC the master can only request 122 bytes or 61 registers. + + In a function 16 request the master will attempt to write to your + slave and since a 9 bytes is already used for ID, FUNCTION, ADDRESS, + NO OF REGISTERS, NO OF BYTES and two BYTES CRC the master can only write + 118 bytes or 59 registers. + + Using a USB to Serial converter the maximum bytes you can send is + limited to its internal buffer which differs between manufactures. +*/ + +#define LED 9 + +// Using the enum instruction allows for an easy method for adding and +// removing registers. Doing it this way saves you #defining the size +// of your slaves register array each time you want to add more registers +// and at a glimpse informs you of your slaves register layout. + +//////////////// registers of your slave /////////////////// +enum +{ + // just add or remove registers and your good to go... + // The first register starts at address 0 + ADC_VAL, + PWM_VAL, + HOLDING_REGS_SIZE // leave this one + // total number of registers for function 3 and 16 share the same register array + // i.e. the same address space +}; + +unsigned int holdingRegs[HOLDING_REGS_SIZE]; // function 3 and 16 register array +//////////////////////////////////////////////////////////// + +void setup() +{ + /* parameters(HardwareSerial* SerialPort, + long baudrate, + unsigned char byteFormat, + unsigned char ID, + unsigned char transmit enable pin, + unsigned int holding registers size, + unsigned int* holding register array) + */ + + /* Valid modbus byte formats are: + SERIAL_8N2: 1 start bit, 8 data bits, 2 stop bits + SERIAL_8E1: 1 start bit, 8 data bits, 1 Even parity bit, 1 stop bit + SERIAL_8O1: 1 start bit, 8 data bits, 1 Odd parity bit, 1 stop bit + + You can obviously use SERIAL_8N1 but this does not adhere to the + Modbus specifications. That said, I have tested the SERIAL_8N1 option + on various commercial masters and slaves that were suppose to adhere + to this specification and was always able to communicate... Go figure. + + These byte formats are already defined in the Arduino global name space. + */ + + modbus_configure(&Serial, 9600, SERIAL_8N2, 2, 2, HOLDING_REGS_SIZE, holdingRegs); + + pinMode(LED, OUTPUT); +} + +void loop() +{ + // modbus_update() is the only method used in loop(). It returns the total error + // count since the slave started. You don't have to use it but it's useful + // for fault finding by the modbus master. + + modbus_update(); + + holdingRegs[ADC_VAL] = analogRead(A0); // update data to be read by the master to adjust the PWM + + analogWrite(LED, holdingRegs[PWM_VAL]>>2); // constrain adc value from the arduino master to 255 + + /* Note: + The use of the enum instruction is not needed. You could set a maximum allowable + size for holdinRegs[] by defining HOLDING_REGS_SIZE using a constant and then access + holdingRegs[] by "Index" addressing. + I.e. + holdingRegs[0] = analogRead(A0); + analogWrite(LED, holdingRegs[1]/4); + */ + +} + diff --git a/lib/SimpleModbusSlave/gpl-3.0.txt b/lib/SimpleModbusSlave/gpl-3.0.txt new file mode 100755 index 0000000..94a9ed0 --- /dev/null +++ b/lib/SimpleModbusSlave/gpl-3.0.txt @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program 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. + + This program 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 this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/lib/SimpleModbusSlave/keywords.txt b/lib/SimpleModbusSlave/keywords.txt new file mode 100755 index 0000000..c9762fe --- /dev/null +++ b/lib/SimpleModbusSlave/keywords.txt @@ -0,0 +1,2 @@ +modbus_configure KEYWORD2 +modbus_update KEYWORD2 diff --git a/platformio.ini b/platformio.ini index 2199eda..d1fad94 100644 --- a/platformio.ini +++ b/platformio.ini @@ -12,3 +12,4 @@ platform = atmelavr board = pro16MHzatmega328 framework = arduino +lib_deps = PMS Library, TaskScheduler \ No newline at end of file diff --git a/src/main.cpp b/src/main.cpp index 58b344c..3b2a43d 100644 --- a/src/main.cpp +++ b/src/main.cpp @@ -1,9 +1,59 @@ #include +#include +#include +#include +#include + +SoftwareSerial pms7003(11, 12); // RX, TX +SoftwareSerial mhz19(9, 10); // RX, TX +PMS pms(pms7003); +PMS::DATA data; +Scheduler runner; + +void sensor_pms(); +Task t1(5000, TASK_FOREVER, &sensor_pms); + +//////////////// MODBUS Registers /////////////////// +enum +{ + R00_OneWireSensors_Anzahl, + R01_DHT22Sensors_Anzahl, + R02_Temp00, + R03_Temp01, + R04_Temp02, + R05_Temp03, + R06_Temp04, + R07_Temp05, + TOTAL_ERRORS, + TOTAL_REGS_SIZE +}; +unsigned int holdingRegs[TOTAL_REGS_SIZE]; // function 3 and 16 register array +////////////////////////////////////////////////////// void setup() { - // put your setup code here, to run once: + Serial.begin(57600); + Serial.print("Starting up..."); + mhz19.begin(9600); + pms7003.begin(9600); + pinMode(8, OUTPUT); //MAX485 Tranmit Enable + //modbus_configure(&Serial, 9600, SERIAL_8N1, 6, 8, TOTAL_REGS_SIZE, 0); //Modbus via MAX485 + runner.init(); + runner.addTask(t1); + t1.enable(); } void loop() { - // put your main code here, to run repeatedly: + runner.execute(); +} + +void sensor_pms() { + if (pms.read(data)) { + Serial.print("PM 1.0 (ug/m3): "); + Serial.println(data.PM_AE_UG_1_0); + Serial.print("PM 2.5 (ug/m3): "); + Serial.println(data.PM_AE_UG_2_5); + Serial.print("PM 10.0 (ug/m3): "); + Serial.println(data.PM_AE_UG_10_0); + Serial.println(); + } } \ No newline at end of file