MySensors API обрабатывает большую часть сообщений в фоновом режиме без особого вмешательства, необходимого от скетча программиста. Давайте начнем с небольшого примера датчика.
Сенсорные Узлы
Для того, чтобы создать программу Arduino (также известный как эскиз), который сообщает данные датчика по воздуху вам нужно только написать несколько строк кода. В следующем примере мы предположим, что у Вас есть RF24 радио, прикрепленную к Arduino и вы хотите послать определенный статус двери:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 |
#define MY_RADIO_NRF24 #include <MySensors.h> #include <SPI.h> #define OPEN 1 #define CLOSE 0 MyMessage msg(NODE_ID, V_TRIPPED); uint8_t value = OPEN; void presentation() { present(NODE_ID, S_DOOR); } void loop() { value = value == OPEN ? CLOSE : OPEN; send(msg.set(value)); sleep(10000); } |
ОК! Итак, что здесь происходит?
Инициализация
Библиотека MySensors автоматически запускается и представляет узел.
Если это первый раз, когда запускается узел он будет получать уникальный идентификатор узла от контроллера.
После того, как идентификатор получен от контроллера он будет сохранен в статической памяти EEPROM в Arduino. Идентификатор автоматически считывается из EEPROM каждый раз, когда узел перезагрузжается или отключается питание узла.
Инициализация также определяет кратчайший путь к сетевому шлюзу.
В этом примере #define MY_RADIO_NRF24 определяет, какой тип радио используется.
Презентация
Ваш датчик должен сначала представить себя контролеру. Представление необходимо чтобы контроллер подготовился к данным датчика, которые в конечном итоге придут. Это делается путем вызова present(child-sensor,id, sensor-type)
sensor-type Список поддерживаемых типов датчиков постоянно растет. Подробные объяснения типов поддерживаемых датчиков представлены в таблице.
Все present() должны быть помещены в функцию presentation(). Контроллер может позже повторно запросить эту информацию от узла.
|
1 2 3 |
typedef enum { S_DOOR, S_MOTION, S_SMOKE, S_LIGHT, S_DIMMER, S_COVER, S_TEMP, ... } sensor; |
Передача информации
Для передачи данных вы должны создать MyMessage контейнер для хранения информации. Создание контейнера выглядит следующим образом:
MyMessage msg(child-sensor-id, variable-type);
В методе loop() в приведенном выше примере мы делаем фактическую отправку вызовом send(msg.set(payload)). Это когда данные датчика передается в контроллер (или в другого место назначения).
child-sensor-id Здесь вы определяете датчик, который отправляет данные. В этом примере у нас есть только один датчик, таким образом мы выбираем 0.
variable-type При передаче данных в контроллер необходимо указать, какой тип данных вы сообщаете. Мы называем это variable-type. Часто тип датчика и тип переменной почти то же самое, но есть несколько датчиков, которые сообщают более чем один тип переменной. Например, измеритель мощности может сообщить как потребление за период, так и текущую мощность. Список типов переменных постоянно растет. Вы можете ознакомиться с таблицей типов переменных для более подробной информации.
|
1 2 3 |
typedef enum { V_TEMP, V_HUM, V_LIGHT, V_DIMMER, V_PRESSURE, V_FORECAST, V_RAIN, ... } variableType; |
Вы всегда найдете самый последний список поддерживаемых датчиков и типов переменных в MyMessage.h на GitHub:
GitHub | MyMessage.h
Приведенный выше пример был простым, потому что передает только OPEN / CLOSE значений каждые 10 секунд. Тем не менее, это должно помочь вам понять, как написать скетч сенсорного узла. Есть много более продвинутых примеров здесь на MySensors если вы любите программирование типа копировать-вставить ;).
Создание Репитера (повторителя, ретранслятора)
Если вы живете в клетке Фарадея или огромном особняке вам может понадобиться несколько ретрансляторов-узлов, чтобы покрыть всю площадь. Для этого есть встроенный функционал ретранслятора.
Для того, чтобы превратить узел в ретранслятор, вы должны помнить несколько вещей:
- Включить режим ретранслятора путем добавления следующей строки в начало скетча:
|
1 |
#define MY_REPEATER_FEATURE |
- Узел все время должен слушать эфир (быть не спящим!). Это означает, что ретранслятор не может работать с питанием от батареи (т.к. большой расход батареи).
Конфигурация
Конфигурация эскиза является очень важным шагом при создании узла MySensors. Она включает / отключает функции ядра во время компиляции, это также может быть сделано непосредственно в скетче источника с помощью #define-переменных.
Файл конфигурации MyConfig.h содержит много значений по умолчанию для конфигурирования. Они хорошо описаны, и вы можете посмотреть на него в этом файле.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 |
/* * The MySensors Arduino library handles the wireless radio link and protocol * between your home built sensors/actuators and HA controller of choice. * The sensors forms a self healing radio network with optional repeaters. Each * repeater and gateway builds a routing tables in RAM or EEPROM which keeps track of the * network topology allowing messages to be routed to nodes. * * Created by Henrik Ekblad <henrik.ekblad@mysensors.org> * Copyright (C) 2013-2019 Sensnology AB * Full contributor list: https://github.com/mysensors/MySensors/graphs/contributors * * Documentation: http://www.mysensors.org * Support Forum: http://forum.mysensors.org * * This program is free software; you can redistribute it and/or * modify it under the terms of the GNU General Public License * version 2 as published by the Free Software Foundation. */ /** * @file MyConfig.h * @ingroup MyConfigGrp * @brief MySensors specific configuration flags. * @{ * Set these in your sketch before including MySensors.h to customize the library to your needs. * If the sketch does not define these flags, they will get default values where applicable. */ #ifndef MyConfig_h #define MyConfig_h /** * @defgroup SerialDebugGrpPub Serial and debugging * @ingroup MyConfigGrp * @brief These options control serial and debugging features and functionalities in the library. * @{ */ /** * @def MY_DEBUG * @brief Define MY_DEBUG to show debug prints. * * This option will add a lot to the size of the final sketch but is helpful to see what is actually * is happening during development. * * @note Values in parenthesis indicate default values which will be used if you have not defined * the flag in your sketch. */ //#define MY_DEBUG /** * @def MY_DEBUGDEVICE * @brief Define MY_DEBUGDEVICE to redirect debug prints. * * If defined, MY_DEBUGDEVICE replaces MY_SERIALDEVICE for the purpose * of printing debug messages. This only applies to debugging. * * The intent is to provide the ability to send debugging messages * out a different serial port than what is being used for * communication between nodes or from gateway to controller when * this communication uses a serial interface. This assumes that * the MY_DEBUGDEVICE serial interface already exists. It can be a * hardware serial device or a software serial device. */ //#define MY_DEBUGDEVICE /** * @def MY_DEBUG_OTA * @brief Define MY_DEBUG_OTA to (nodeID) to redirect debug prints to given node ID * * Example: @code #define MY_DEBUG_OTA (0) @endcode will redirect debug prints to node ID 0. * * With this option debugging messages over serial are disabled. It's not possible to send debug * messages generated by the radio. All other debug messages redirected to the given Node ID. * The debug messages are sent without signing. * * This function allocates some additional memory for radio packet preparation and buffering. * Debug messages are sent to child ID 255 (NODE_SENSOR_ID) as I_LOG_MESSAGE type. * * You have to enable the @ref MY_OTA_LOG_RECEIVER_FEATURE on the target node. * Look into the LogOTAGateway and LogOTANode examples. * * The output buffer can be configured via @ref MY_SERIAL_OUTPUT_SIZE * Transport related debugging is disabled when MY_DEBUG_OTA is enabled. * */ //#define MY_DEBUG_OTA (0) /** * @def MY_DEBUG_OTA_DISABLE_ECHO * @brief Define MY_DEBUG_OTA_DISABLE_ECHO to send messages without requesting the * destination to echo the message. * * This option reduces the latency added by OTA debug messages by sending packages * only once. You can loose debug messages. * */ //#define MY_DEBUG_OTA_DISABLE_ECHO #if defined(MY_DEBUG_OTA_DISABLE_ACK) && !defined(DOXYGEN) #warning MY_DEBUG_OTA_DISABLE_ACK is deprecated, please use MY_DEBUG_OTA_DISABLE_ECHO instead #define MY_DEBUG_OTA_DISABLE_ECHO #endif /** * @def MY_OTA_LOG_RECEIVER_FEATURE * @brief Define this to enable printing of OTA logs. * * This option requires additional memory for buffering. The buffer size can be configured * via MY_SERIAL_OUTPUT_SIZE. */ //#define MY_OTA_LOG_RECEIVER_FEATURE /** * @def MY_OTA_LOG_SENDER_FEATURE * @brief Define this to enable printing of OTA logs. * * This option requires additional memory for buffering. The buffer size can be configured * via MY_SERIAL_OUTPUT_SIZE. */ //#define MY_OTA_LOG_SENDER_FEATURE /** * @def MY_SPECIAL_DEBUG * @brief Define MY_SPECIAL_DEBUG to enable support for I_DEBUG messages. * * I_DEBUG messages are sent from the controller to the node, which responds with the requested * data. The request can be one of the following: * - 'R': routing info (only repeaters): received msg XXYY (as stream), where XX is the node and YY * the routing node * - 'V': CPU voltage * - 'F': CPU frequency * - 'M': free memory * - 'E': clear MySensors EEPROM area and reboot (i.e. "factory" reset) */ //#define MY_SPECIAL_DEBUG /** * @def MY_DISABLED_SERIAL * @brief Define MY_DISABLED_SERIAL if you want to use the UART TX/RX pins as normal I/O pins. * * @note When defined, if you want to use the pins as a UART, you need to handle initialization and * configuration yourself. */ //#define MY_DISABLED_SERIAL /** * @def MY_SPLASH_SCREEN_DISABLED * @ingroup memorysavings * @brief If defined, will disable the MySensors splash screen. * * @note This saves 120 bytes of flash. */ //#define MY_SPLASH_SCREEN_DISABLED /** * @def MY_BAUD_RATE * @brief Serial output baud rate (debug prints and serial gateway speed). * * The baud rate configured here must match the baud rate at the "other" end. * * @warning Depending on your target device and clock speed, certain baud rates might not work well. */ #ifndef MY_BAUD_RATE #define MY_BAUD_RATE (115200ul) #endif /** * @def MY_SERIAL_OUTPUT_SIZE * @brief Maximum characters for serial output. * * If you are running extremely low on memory, reducing this size might just save your day. */ #ifndef MY_SERIAL_OUTPUT_SIZE #define MY_SERIAL_OUTPUT_SIZE (120u) #endif /** @}*/ // End of SerialDebugGrpPub group /** * @def MY_DEBUG_VERBOSE_OTA_UPDATE * @brief Define this for verbose debug prints related to FOTA updates. */ //#define MY_DEBUG_VERBOSE_OTA_UPDATE /** * @def MY_OTA_USE_I2C_EEPROM * @brief Define this if you want I2C EEPROM instead * of a SPI flash. Used EEPROM needs to be large enough, an 24(L)C256 will do as minimum. * HW I2C assumed. This will exclude the SPI flash code. * Note that you also need an updated DualOptiboot supporting I2C EEPROM! */ //#define MY_OTA_USE_I2C_EEPROM #ifdef MY_OTA_USE_I2C_EEPROM // I2C address of EEPROM. Wire will shift this left, i.e. 0x50->0xA0 #ifndef MY_OTA_I2C_ADDR #define MY_OTA_I2C_ADDR 0x50 #endif #endif /** * @defgroup TransportSettingGrpPub Transport selection * @ingroup MyConfigGrp * @brief These options control what transport type to use and various transport specific customisations. * @{ */ /** * @defgroup RS485SettingGrpPub RS485 * @ingroup TransportSettingGrpPub * @brief These options are specific to the RS485 wired transport. * @{ */ /** * @def MY_RS485 * @brief Define this to use the RS485 wired transport for sensor network communication. */ //#define MY_RS485 /** * @def MY_RS485_BAUD_RATE * @brief The RS485 BAUD rate. */ #ifndef MY_RS485_BAUD_RATE #define MY_RS485_BAUD_RATE (9600) #endif /** * @def MY_RS485_MAX_MESSAGE_LENGTH * @brief The maximum message length used for RS485. */ #ifndef MY_RS485_MAX_MESSAGE_LENGTH #define MY_RS485_MAX_MESSAGE_LENGTH (40) #endif /** * @def MY_RS485_SOH_COUNT * @brief Use this in case of collisions on the bus. 3 might be a good setting. */ #ifndef MY_RS485_SOH_COUNT #define MY_RS485_SOH_COUNT (1) #endif /** * @def MY_RS485_DE_PIN * @brief RS485 driver enable pin. */ //#define MY_RS485_DE_PIN (2) /** * @def MY_RS485_DE_INVERSE * @brief Define this if RS485 driver enable pin polarity is inverted (low-active). */ //#define MY_RS485_DE_INVERSE /** * @def MY_RS485_HWSERIAL * @brief Define this if RS485 is connected to a hardware serial port. * * Example: @code #define MY_RS485_HWSERIAL Serial1 @endcode */ //#define MY_RS485_HWSERIAL (Serial1) /** @}*/ // End of RS485SettingGrpPub group /** * @defgroup RF24SettingGrpPub RF24 * @ingroup TransportSettingGrpPub * @brief These options are specific to the RF24 family of wireless transport modules. * * The following chips are supported by this driver: * | Vendor | Chip * |--------------------------|---------- * | Nordic Semiconductor | nRF24L01 * | | nRF24L01+ * | Beken Corporation | BK2401 * | | BK2421 * | | BK2491 * | Hope Microelectronics | RFM70 * | | RFM73 * | Panchip Microelectronics | XN297 * | Silicon Labs(?) | SI24R1 * @{ */ // legacy - remove for 3.0.0 /** * @def MY_RADIO_NRF24 * @brief Define this to use a RF24-based radio transport for sensor network communication. * @deprecated This flag is deprecated and replaced by @ref MY_RADIO_RF24 */ #ifdef MY_RADIO_NRF24 #warning MY_RADIO_NRF24 is deprecated, use MY_RADIO_RF24 instead. #undef MY_RADIO_NRF24 #define MY_RADIO_RF24 #endif /** * @def MY_RADIO_RF24 * @brief Define this to use a RF24-based radio transport for sensor network communication. */ //#define MY_RADIO_RF24 /** * @def MY_RF24_ENABLE_ENCRYPTION * @brief Define this to enable software based %AES encryption. * * All nodes and gateway must have this enabled, and all must be personalized with the same %AES * key. * @see @ref personalization * * @warning This driver always sets the initialization vector to 0 so encryption is weak. */ //#define MY_RF24_ENABLE_ENCRYPTION /** * @def MY_DEBUG_VERBOSE_RF24 * @brief Define this for verbose debug prints related to the RF24 driver. */ //#define MY_DEBUG_VERBOSE_RF24 /** * @def MY_RF24_SPI_SPEED * @brief Define this if you need to run the SPI clock at a different frequency than the default. * * Default nRF24L01+ SPI speed, 2MHz should be safe for nRF24L01+ clones. */ #ifndef MY_RF24_SPI_SPEED #define MY_RF24_SPI_SPEED (2*1000000ul) #endif /** * @def MY_RF24_CE_PIN * @brief Define this to change the chip enable pin from the default. */ #ifndef MY_RF24_CE_PIN #define MY_RF24_CE_PIN (DEFAULT_RF24_CE_PIN) #endif /** * @def MY_RF24_CS_PIN * @brief Define this to change the chip select pin from the default. */ #ifndef MY_RF24_CS_PIN #define MY_RF24_CS_PIN (DEFAULT_RF24_CS_PIN) #endif /** * @def MY_RF24_IRQ_PIN * @brief Define this to use the IRQ pin of the RF24 module (optional). */ //#define MY_RF24_IRQ_PIN (2) /** * @def MY_RF24_POWER_PIN * @brief Define this to use the RF24 power pin (optional). */ //#define MY_RF24_POWER_PIN (3) /** * @def MY_RX_MESSAGE_BUFFER_FEATURE * @brief This enables the receiving buffer feature. * * This feature is currently not supported for anything but RF24. * Require @ref MY_RF24_IRQ_PIN to be set. * * Note: Not supported on ESP8266, ESP32, STM32, nRF5 and sketches * that use SoftSPI. See below issue for details * https://github.com/mysensors/MySensors/issues/1128 */ //#define MY_RX_MESSAGE_BUFFER_FEATURE /** * @def MY_RX_MESSAGE_BUFFER_SIZE * @brief Define this to change the incoming message buffer size from the default. * * Require @ref MY_RX_MESSAGE_BUFFER_FEATURE to be set. */ #ifdef MY_RX_MESSAGE_BUFFER_FEATURE #ifndef MY_RX_MESSAGE_BUFFER_SIZE #define MY_RX_MESSAGE_BUFFER_SIZE (20) #endif #endif /** * @def MY_RF24_PA_LEVEL * @brief Default RF24 PA level. Override in sketch if needed. * * - RF24_PA_MIN = -18dBm * - RF24_PA_LOW = -12dBm * - RF24_PA_HIGH = -6dBm * - RF24_PA_MAX = 0dBm */ #ifndef MY_RF24_PA_LEVEL #define MY_RF24_PA_LEVEL (RF24_PA_HIGH) #endif /** * @def MY_RF24_CHANNEL * @brief RF channel for the sensor net, 0-125. * * Frequencies: 2400 Mhz - 2525 Mhz * * Channels: 126 * @see https://www.nordicsemi.com/eng/nordic/download_resource/8765/2/42877161/2726 * * - 0 => 2400 Mhz (RF24 channel 1) * - 1 => 2401 Mhz (RF24 channel 2) * - 76 => 2476 Mhz (RF24 channel 77) * - 83 => 2483 Mhz (RF24 channel 84) * - 124 => 2524 Mhz (RF24 channel 125) * - 125 => 2525 Mhz (RF24 channel 126) * * In some countries there might be limitations, in Germany for example only the range * 2400,0 - 2483,5 Mhz is allowed. * @see http://www.bundesnetzagentur.de/SharedDocs/Downloads/DE/Sachgebiete/Telekommunikation/Unternehmen_Institutionen/Frequenzen/Allgemeinzuteilungen/2013_10_WLAN_2,4GHz_pdf.pdf */ #ifndef MY_RF24_CHANNEL #define MY_RF24_CHANNEL (76) #endif /** * @def MY_RF24_DATARATE * @brief RF24 data rate. * * - RF24_250KBPS for 250kbs * - RF24_1MBPS for 1Mbps * - RF24_2MBPS for 2Mbps. * * @note nRF24L01, BK2401, BK2421, BK2491 and XN297 does not support RF24_250KBPS * @note BK2401 does not support RF24_2MBPS */ #ifndef MY_RF24_DATARATE #define MY_RF24_DATARATE (RF24_250KBPS) #endif /** * @def MY_RF24_BASE_RADIO_ID * @brief RF24 radio network identifier. * * This acts as base value for sensor nodeId addresses. Change this (or channel) if you have more * than one sensor network. */ #ifndef MY_RF24_BASE_RADIO_ID #define MY_RF24_BASE_RADIO_ID 0x00,0xFC,0xE1,0xA8,0xA8 #endif /** * @def MY_RF24_ADDR_WIDTH * @brief RF24 base address width. */ #ifndef MY_RF24_ADDR_WIDTH #define MY_RF24_ADDR_WIDTH (5) #endif /** @}*/ // End of RF24SettingGrpPub group /** * @defgroup NRF5SettingGrpPub nRF5 * @ingroup TransportSettingGrpPub * @brief These options are specific to the nRF5 (with Enhanced ShockBurst) family of wireless * transport modules. * * The nRF5 driver is OTA compatible with the RF24 driver. * * The following chips are supported by this driver: * - nRF51x22 * - nRF52822 * * @{ */ /** * @def MY_RADIO_NRF5_ESB * @brief Define this to use nRF5 based radios for sensor network communication. * * @see ARDUINO_ARCH_NRF5 */ //#define MY_RADIO_NRF5_ESB /** * @def MY_NRF5_ESB_ENABLE_ENCRYPTION * @brief Define this to enable software based (RF24 compatible) %AES encryption. * * All nodes and gateway must have this enabled, and all must be personalized with the same %AES * key. * @see @ref personalization * * @warning This driver always sets the initialization vector to 0 so encryption is weak. */ //#define MY_NRF5_ESB_ENABLE_ENCRYPTION /** * @def MY_DEBUG_VERBOSE_NRF5_ESB * @brief Define this for verbose debug prints related to the nRF5 driver. */ //#define MY_DEBUG_VERBOSE_NRF5_ESB /** * @def MY_NRF5_ESB_PA_LEVEL * @brief Default nRF5 PA level. Override in sketch if needed. * * - NRF5_PA_MIN = -40dBm * - NRF5_PA_LOW = -16dBm * - NRF5_PA_HIGH = 0dBm * - NRF5_PA_MAX = 4dBm */ #ifndef MY_NRF5_ESB_PA_LEVEL #define MY_NRF5_ESB_PA_LEVEL (NRF5_PA_MAX) #endif /** * @def MY_NRF5_ESB_CHANNEL * @brief RF channel for the sensor net, 0-125. * * Frequencies: 2400 Mhz - 2525 Mhz * * Channels: 126 * @see https://www.nordicsemi.com/eng/nordic/download_resource/8765/2/42877161/2726 * * - 0 => 2400 Mhz (RF24 channel 1) * - 1 => 2401 Mhz (RF24 channel 2) * - 76 => 2476 Mhz (RF24 channel 77) * - 83 => 2483 Mhz (RF24 channel 84) * - 124 => 2524 Mhz (RF24 channel 125) * - 125 => 2525 Mhz (RF24 channel 126) * * In some countries there might be limitations, in Germany for example only the range * 2400,0 - 2483,5 Mhz is allowed. * @see http://www.bundesnetzagentur.de/SharedDocs/Downloads/DE/Sachgebiete/Telekommunikation/Unternehmen_Institutionen/Frequenzen/Allgemeinzuteilungen/2013_10_WLAN_2,4GHz_pdf.pdf */ #ifndef MY_NRF5_ESB_CHANNEL #define MY_NRF5_ESB_CHANNEL (76) #endif /** * @def MY_NRF5_ESB_MODE * @brief nRF5 mode. * * - NRF5_250KBPS for 250kbs (Deprecated) * - NRF5_1MBPS for 1Mbps * - NRF5_2MBPS for 2Mbps. * - NRF5_BLE_1MBPS for 1Mbps BLE modulation */ #ifndef MY_NRF5_ESB_MODE #define MY_NRF5_ESB_MODE (NRF5_250KBPS) #endif /** * @def MY_NRF5_ESB_BASE_RADIO_ID * @brief nRF5 radio network identifier. * * This acts as base value for sensor nodeId addresses. Change this (or channel) if you have more * than one sensor network. */ #ifndef MY_NRF5_ESB_BASE_RADIO_ID #define MY_NRF5_ESB_BASE_RADIO_ID 0x00, 0xFC, 0xE1, 0xA8, 0xA8 #endif /** * @def MY_NRF5_ESB_ADDR_WIDTH * @brief nRF5 base address width. */ #ifndef MY_NRF5_ESB_ADDR_WIDTH #define MY_NRF5_ESB_ADDR_WIDTH (5) #endif /** * @def MY_NRF5_ESB_RX_BUFFER_SIZE * @brief Declare the amount of incoming messages that can be buffered at driver level. */ #ifndef MY_NRF5_ESB_RX_BUFFER_SIZE #define MY_NRF5_ESB_RX_BUFFER_SIZE (20) #endif /** * @def MY_NRF5_ESB_REVERSE_ACK_TX * @brief Switch to SI24R1 or faked nRF24L01+ compatible ACK mode. ACK bit is reversed on TX side. */ //#define MY_NRF5_ESB_REVERSE_ACK_TX /** * @def MY_NRF5_ESB_REVERSE_ACK_RX * @brief Switch to SI24R1 or faked nRF24L01+ compatible ACK mode. ACK bit is reversed on RX side. */ //#define MY_NRF5_ESB_REVERSE_ACK_RX /** @}*/ // End of NRF5SettingGrpPub group /** * @defgroup RFM69SettingGrpPub RFM69 * @ingroup TransportSettingGrpPub * @brief These options are specific to the %RFM69 family of wireless transport modules. * * The following chips are supported by this driver: * - Semtech sx1231 * * If using the HW variant of the %RFM69 module, define @ref MY_IS_RFM69HW. * @{ */ /** * @def MY_RADIO_RFM69 * @brief Define this to use %RFM69 based radios for sensor network communication. */ //#define MY_RADIO_RFM69 /** * @def MY_DEBUG_VERBOSE_RFM69 * @brief Define this for verbose debug prints related to the %RFM69 driver. */ //#define MY_DEBUG_VERBOSE_RFM69 /** * @def MY_DEBUG_VERBOSE_RFM69_REGISTERS * @brief Define this for verbose dumping of the %RFM69 registers. */ //#define MY_DEBUG_VERBOSE_RFM69_REGISTERS /** * @def MY_RFM69_NEW_DRIVER * @brief Define this to enable the improved %RFM69 driver. * * @note This driver is not compatible with the old (=default) %RFM69 driver. */ //#define MY_RFM69_NEW_DRIVER /** * @def MY_RFM69_FREQUENCY * @brief The frequency to use. * * - RFM69_315MHZ * - RFM69_433MHZ * - RFM69_865MHZ * - RFM69_868MHZ * - RFM69_915MHZ * - Custom frequency in Hz (new %RFM69 driver only) * @see MY_RFM69_NEW_DRIVER * * This must match the hardware version of the %RFM69 radio. * Additional information: https://en.wikipedia.org/wiki/Short_Range_Devices */ #ifndef MY_RFM69_FREQUENCY #define MY_RFM69_FREQUENCY (RFM69_868MHZ) #endif /** * @def MY_IS_RFM69HW * @brief Define this if you are using the RFM69HW model. */ //#define MY_IS_RFM69HW /** * @def MY_RFM69HW * @brief Set to true if @ref MY_IS_RFM69HW is set. * * @todo Mark this internals */ #ifdef MY_IS_RFM69HW #define MY_RFM69HW true #else #define MY_RFM69HW false #endif /** * @def MY_RFM69_TX_POWER_DBM * @brief Set TX power level, default 5dBm (overridden if ATC mode enabled). */ #ifndef MY_RFM69_TX_POWER_DBM #define MY_RFM69_TX_POWER_DBM (5) #endif /** * @def MY_RFM69_ATC_TARGET_RSSI_DBM * @brief Target RSSI level (in dBm) for %RFM69 ATC mode. */ #ifndef MY_RFM69_ATC_TARGET_RSSI_DBM #define MY_RFM69_ATC_TARGET_RSSI_DBM (-80) #endif /** * @def MY_RFM69_ATC_MODE_DISABLED * @brief Define to disable ATC mode of %RFM69 driver. */ //#define MY_RFM69_ATC_MODE_DISABLED /** * @def MY_RFM69_MAX_POWER_LEVEL_DBM * @brief Set max TX power in dBm if local legislation requires this * * - 1mW = 0dBm * - 10mW = 10dBm * - 25mW = 14dBm * - 100mW = 20dBm * * See here: https://en.wikipedia.org/wiki/Short_Range_Devices */ //#define MY_RFM69_MAX_POWER_LEVEL_DBM (10u) /** * @def MY_RFM69_NETWORKID * @brief %RFM69 Network ID. Use the same for all nodes that will talk to each other. */ #ifndef MY_RFM69_NETWORKID #define MY_RFM69_NETWORKID (100) #endif /** * @def MY_RFM69_RST_PIN * @brief Define this to use the %RFM69 reset pin (optional). */ //#define MY_RFM69_RST_PIN (9) #ifdef MY_RF69_RESET #warning MY_RF69_RESET is depreciated, please use MY_RFM69_RST_PIN instead. #define MY_RFM69_RST_PIN MY_RF69_RESET #endif /** * @def MY_RFM69_POWER_PIN * @brief Define this to use the %RFM69 power pin (optional). */ //#define MY_RFM69_POWER_PIN (3) /** * @def MY_RFM69_IRQ_PIN * @brief Define this to override the default %RFM69 IRQ pin assignment. */ #ifndef MY_RFM69_IRQ_PIN #ifdef MY_RF69_IRQ_PIN #warning MY_RF69_IRQ_PIN is depreciated, please use MY_RFM69_IRQ_PIN instead. #define MY_RFM69_IRQ_PIN MY_RF69_IRQ_PIN #else #define MY_RFM69_IRQ_PIN DEFAULT_RFM69_IRQ_PIN #endif #endif /** * @def MY_RFM69_IRQ_NUM * @brief %RFM69 IRQ number. */ #ifndef MY_RFM69_IRQ_NUM #ifdef MY_RF69_IRQ_NUM #warning MY_RF69_IRQ_NUM is depreciated, please use MY_RFM69_IRQ_NUM instead. #define MY_RFM69_IRQ_NUM MY_RF69_IRQ_NUM #else #define MY_RFM69_IRQ_NUM digitalPinToInterrupt(MY_RFM69_IRQ_PIN) #endif #endif /** * @def MY_RFM69_CS_PIN * @brief %RFM69 SPI chip select pin. */ #ifndef MY_RFM69_CS_PIN #ifdef MY_RF69_SPI_CS #warning MY_RF69_SPI_CS is depreciated, please use MY_RFM69_CS_PIN instead. #define MY_RFM69_CS_PIN MY_RF69_SPI_CS #else #define MY_RFM69_CS_PIN DEFAULT_RFM69_CS_PIN #endif #endif /** * @def MY_RFM69_SPI_SPEED * @brief Set to overrule default RFM69 SPI speed. */ #ifndef MY_RFM69_SPI_SPEED #define MY_RFM69_SPI_SPEED (4*1000000ul) // datasheet says 10Mhz max. #endif /** * @def MY_RFM69_ENABLE_ENCRYPTION * @brief Define this to enable %AES encryption in the %RFM69 module. * * All nodes and gateway must have this enabled, and all must be personalized with the same %AES * key. * @see @ref personalization */ //#define MY_RFM69_ENABLE_ENCRYPTION /** * @def MY_RFM69_MODEM_CONFIGURATION * @brief %RFM69 modem configuration, default is %RFM69_FSK_BR55_5_FD50 * * | Configuration | Modulation (xxx) | Bit rate | FD | RXBW | Additional settings * |-------------------------|------------------|----------|--------|----------|--------------------------- * | RFM69_xxx_BR2_FD5 | FSK/GFSK/OOK | 2000 | 5000 | 111_24_4 | Whitening * | RFM69_xxx_BR2_4_FD4_8 | FSK/GFSK/OOK | 2400 | 4800 | 111_24_4 | Whitening * | RFM69_xxx_BR4_8_FD9_6 | FSK/GFSK/OOK | 4800 | 9600 | 111_24_4 | Whitening * | RFM69_xxx_BR9_6_FD19_2 | FSK/GFSK/OOK | 9600 | 19200 | 111_24_4 | Whitening * | RFM69_xxx_BR19_2_FD38_4 | FSK/GFSK/OOK | 19200 | 38400 | 111_24_3 | Whitening * | RFM69_xxx_BR38_4_FD76_8 | FSK/GFSK/OOK | 38400 | 76800 | 111_24_2 | Whitening * | RFM69_xxx_BR55_5_FD50 | FSK/GFSK/OOK | 55555 | 50000 | 111_16_2 | Whitening * | RFM69_xxx_BR57_6_FD120 | FSK/GFSK/OOK | 57600 | 120000 | 111_16_1 | Whitening * | RFM69_xxx_BR125_FD125 | FSK/GFSK/OOK | 125000 | 125000 | 010_16_2 | Whitening * | RFM69_xxx_BR250_FD250 | FSK/GFSK/OOK | 250000 | 250000 | 111_16_0 | Whitening * * https://www.semtech.com/uploads/documents/sx1231.pdf * */ //#define MY_RFM69_MODEM_CONFIGURATION (RFM69_FSK_BR55_5_FD50) /** @}*/ // End of RFM69SettingGrpPub group /** * @defgroup RFM95SettingGrpPub RFM95 * @ingroup TransportSettingGrpPub * @brief These options are specific to the %RFM95 family of wireless transport modules. * * The following chips are supported by this driver: * - Semtech sx1276 * @{ */ /** * @def MY_RADIO_RFM95 * @brief Define this to use RFM95 based radios for sensor network communication. */ //#define MY_RADIO_RFM95 /** * @def MY_DEBUG_VERBOSE_RFM95 * @brief Define this for verbose debug prints related to the RFM95 driver. */ //#define MY_DEBUG_VERBOSE_RFM95 /** * @def MY_RFM95_ENABLE_ENCRYPTION * @brief Define this to enable software based %AES encryption. * * All nodes and gateway must have this enabled, and all must be personalized with the same %AES * key. * @see @ref personalization * * @warning This driver always sets the initialization vector to 0 so encryption is weak. */ //#define MY_RFM95_ENABLE_ENCRYPTION /** * @def MY_RFM95_FREQUENCY * @brief The frequency to use. * * - RFM95_169MHZ * - RFM95_315MHZ * - RFM95_434MHZ * - RFM95_868MHZ * - RFM95_915MHZ * - Custom frequency in Hz * * This must match the hardware version of the RFM95 radio. * Additional information: https://en.wikipedia.org/wiki/Short_Range_Devices */ #ifndef MY_RFM95_FREQUENCY #define MY_RFM95_FREQUENCY (RFM95_868MHZ) #endif /** * @def MY_RFM95_MODEM_CONFIGRUATION * @brief RFM95 modem configuration. * * BW = Bandwidth in kHz * CR = Error correction code * SF = Spreading factor, chips / symbol * * | CONFIG | BW | CR | SF | Comment * |------------------------|-------|-----|------|----------------------------- * | RFM95_BW125CR45SF128 | 125 | 4/5 | 128 | Default, medium range * | RFM95_BW500CR45SF128 | 500 | 4/5 | 128 | Fast, short range * | RFM95_BW31_25CR48SF512 | 31.25 | 4/8 | 512 | Slow, long range * | RFM95_BW125CR48SF4096 | 125 | 4/8 | 4096 | Slow, long range * */ #ifndef MY_RFM95_MODEM_CONFIGRUATION #define MY_RFM95_MODEM_CONFIGRUATION RFM95_BW125CR45SF128 #endif /** * @def MY_RFM95_RST_PIN * @brief Define this to use the RFM95 reset pin (optional). */ //#define MY_RFM95_RST_PIN (9) /** * @def MY_RFM95_POWER_PIN * @brief Define this to use the RFM95 power pin (optional). */ //#define MY_RFM95_POWER_PIN (3) /** * @def MY_RFM95_IRQ_PIN * @brief Define this to use the RFM95 IRQ pin. */ #ifndef MY_RFM95_IRQ_PIN #define MY_RFM95_IRQ_PIN DEFAULT_RFM95_IRQ_PIN #endif /** * @def MY_RFM95_IRQ_NUM * @brief RFM95 IRQ number. */ #ifndef MY_RFM95_IRQ_NUM #define MY_RFM95_IRQ_NUM digitalPinToInterrupt(MY_RFM95_IRQ_PIN) #endif /** * @def MY_RFM95_CS_PIN * @brief RFM95 SPI chip select pin. */ #ifndef MY_RFM95_CS_PIN #define MY_RFM95_CS_PIN DEFAULT_RFM95_CS_PIN #endif /** * @def MY_RFM95_SPI_SPEED * @brief Set to overrule default RFM95 SPI speed. */ #ifndef MY_RFM95_SPI_SPEED #define MY_RFM95_SPI_SPEED (4*1000000ul) #endif /** * @def MY_RFM95_TX_POWER_DBM * @brief Set TX power level, default 13dBm (overridden if ATC mode enabled) * * See here https://en.wikipedia.org/wiki/Short_Range_Devices */ #ifndef MY_RFM95_TX_POWER_DBM #define MY_RFM95_TX_POWER_DBM (13u) // 20mW #endif /** * @def MY_RFM95_ATC_MODE_DISABLED * @brief Define to disable ATC mode of RFM95 driver. */ //#define MY_RFM95_ATC_MODE_DISABLED /** * @def MY_RFM95_ATC_TARGET_RSSI * @brief Target RSSI level (in dBm) for RFM95 ATC mode */ #ifndef MY_RFM95_ATC_TARGET_RSSI #define MY_RFM95_ATC_TARGET_RSSI (-70) #endif /** * @def MY_RFM95_MAX_POWER_LEVEL_DBM * @brief Set max TX power in dBm if local legislation requires this * * - 1mW = 0dBm * - 10mW = 10dBm * - 25mW = 14dBm * - 100mW = 20dBm * * See here: https://en.wikipedia.org/wiki/Short_Range_Devices */ //#define MY_RFM95_MAX_POWER_LEVEL_DBM (10u) /** * @def MY_RFM95_TCXO * @brief Enable to force your radio to use an external frequency source (e.g. TCXO, if present). * * This allows for better stability using SF 9 to 12. */ //#define MY_RFM95_TCXO /** @}*/ // End of RFM95SettingGrpPub group /** * @defgroup SoftSpiSettingGrpPub Soft SPI * @ingroup TransportSettingGrpPub * @brief These options are specific the soft SPI driver for certain radio transport drivers. * * The following transport drivers supported by this driver: * - The RF24 driver @see RF24SettingGrpPub * - The new %RFM69 driver @see RFM69SettingGrpPub @see MY_RFM69_NEW_DRIVER * - The RFM95 driver @see RFM95SettingGrpPub * @{ */ /** * @def MY_SOFTSPI * @brief Define this to use a software based SPI driver which allows more freedom in pin selection * for the (supported) radio module. */ //#define MY_SOFTSPI /** * @def MY_SOFT_SPI_SCK_PIN * @brief Soft SPI SCK pin. */ #ifndef MY_SOFT_SPI_SCK_PIN #define MY_SOFT_SPI_SCK_PIN (14) #endif /** * @def MY_SOFT_SPI_MISO_PIN * @brief Soft SPI MISO pin. */ #ifndef MY_SOFT_SPI_MISO_PIN #define MY_SOFT_SPI_MISO_PIN (16) #endif /** * @def MY_SOFT_SPI_MOSI_PIN * @brief Soft SPI MOSI pin. */ #ifndef MY_SOFT_SPI_MOSI_PIN #define MY_SOFT_SPI_MOSI_PIN (15) #endif /** @}*/ // End of SoftSpiSettingGrpPub group /** @}*/ // End of TransportSettingGrpPub group /** * @defgroup RoutingNodeSettingGrpPub Routing and node * @ingroup MyConfigGrp * @brief These options control message routing and node configurations. * @{ */ /** * @def MY_DISABLE_RAM_ROUTING_TABLE_FEATURE * @ingroup memorysavings * @brief If defined, routing table will not be kept in RAM. * @see MY_RAM_ROUTING_TABLE_FEATURE */ /** * @def MY_RAM_ROUTING_TABLE_FEATURE * @brief If enabled, the routing table is kept in RAM (if memory allows) and saved in regular * intervals. * @note Enabled by default on most platforms, but on AVR only for atmega1280, atmega1284 and * atmega2560. * @see MY_DISABLE_RAM_ROUTING_TABLE_FEATURE */ #ifndef MY_DISABLE_RAM_ROUTING_TABLE_FEATURE #define MY_RAM_ROUTING_TABLE_FEATURE #endif /** * @def MY_ROUTING_TABLE_SAVE_INTERVAL_MS * @brief Interval to dump content of routing table to EEPROM */ #ifndef MY_ROUTING_TABLE_SAVE_INTERVAL_MS #define MY_ROUTING_TABLE_SAVE_INTERVAL_MS (30*60*1000ul) #endif /** * @def MY_REPEATER_FEATURE * @brief Enables repeater functionality (relays messages from other nodes) * @note Repeaters need to be constantly kept awake to be useful. They are therefore not suitable * for battery powered operation. */ //#define MY_REPEATER_FEATURE /** * @def MY_PASSIVE_NODE * @brief If enabled, the node operates fully autonomously, i.e. messages are sent without ACKing. * * @note All transport-related checks and safety-mechanisms are disabled. * @note Requires that @ref MY_NODE_ID is set, @ref MY_PARENT_NODE_ID and * @ref MY_PARENT_NODE_IS_STATIC are optional. * @note Singing, registration, and OTA FW update are disabled. */ //#define MY_PASSIVE_NODE /** * @def MY_NODE_ID * @brief Node id defaults to AUTO (tries to fetch id from controller). */ #ifndef MY_NODE_ID #define MY_NODE_ID (AUTO) #endif /** * @def MY_PARENT_NODE_ID * @brief Node parent defaults to AUTO (tries to find a parent automatically). */ #ifndef MY_PARENT_NODE_ID #define MY_PARENT_NODE_ID (AUTO) #endif /** * @def MY_PARENT_NODE_IS_STATIC * @brief Define MY_PARENT_NODE_IS_STATIC to disable fall back if parent node fails */ //#define MY_PARENT_NODE_IS_STATIC /** * @def MY_TRANSPORT_SANITY_CHECK * @brief If defined, will cause node to check transport in regular intervals to detect HW issues * and re-initialize in case of failure. * @note This feature is enabled for all repeater nodes (incl. GW) */ //#define MY_TRANSPORT_SANITY_CHECK /** * @def MY_TRANSPORT_SANITY_CHECK_INTERVAL_MS * @brief Interval (in ms) for transport sanity checks */ #ifndef MY_TRANSPORT_SANITY_CHECK_INTERVAL_MS #define MY_TRANSPORT_SANITY_CHECK_INTERVAL_MS (15*60*1000ul) #endif /** * @def MY_TRANSPORT_DISCOVERY_INTERVAL_MS * @brief This is a gateway-only feature: Interval (in ms) to issue network discovery checks */ #ifndef MY_TRANSPORT_DISCOVERY_INTERVAL_MS #define MY_TRANSPORT_DISCOVERY_INTERVAL_MS (20*60*1000ul) #endif /** *@def MY_TRANSPORT_UPLINK_CHECK_DISABLED *@brief If defined, disables uplink check to GW during transport initialisation */ //#define MY_TRANSPORT_UPLINK_CHECK_DISABLED /** *@def MY_TRANSPORT_MAX_TX_FAILURES *@brief Define to override max. consecutive TX failures until SNP is initiated */ //#define MY_TRANSPORT_MAX_TX_FAILURES (10u) /** * @def MY_TRANSPORT_WAIT_READY_MS * @brief Timeout in ms until transport is ready during startup, set to 0 for no timeout */ #ifndef MY_TRANSPORT_WAIT_READY_MS #define MY_TRANSPORT_WAIT_READY_MS (0) #endif /** * @def MY_SIGNAL_REPORT_ENABLED * @brief Enables signal report functionality. * @note This feature adds ~1kB code to the sketch. */ //#define MY_SIGNAL_REPORT_ENABLED /** @}*/ // End of RoutingNodeSettingGrpPub group /** * @defgroup RegistrationSettingGrpPub Node registration * @ingroup MyConfigGrp * @brief These options control node registration configurations. * @{ */ /** * @def MY_REGISTRATION_FEATURE * @brief If enabled, node has to register to GW/controller before being allowed to send sensor * data. * @note Enabled by default. */ #define MY_REGISTRATION_FEATURE /** * @def MY_REGISTRATION_RETRIES * @brief Number of registration retries if no reply received from GW/controller. */ #ifndef MY_REGISTRATION_RETRIES #define MY_REGISTRATION_RETRIES (3u) #endif /** * @def MY_REGISTRATION_DEFAULT * @brief Node registration default - this applies if no registration response is received from * controller. */ #define MY_REGISTRATION_DEFAULT (true) /** * @def MY_REGISTRATION_CONTROLLER * @brief If defined, node registration request has to be handled by controller */ //#define MY_REGISTRATION_CONTROLLER /** @}*/ // End of RegistrationSettingGrpPub group /** * @defgroup CoreSettingGrpPub Core * @ingroup MyConfigGrp * @brief These options control the library core configurations. * @{ */ /** * @def MY_CORE_ONLY * @brief Define this if you want to use core functions without loading the framework. */ //#define MY_CORE_ONLY /** * @def MY_CORE_COMPATIBILITY_CHECK * @brief If defined, library compatibility is checked during node registration. * Incompatible libraries are unable to send sensor data. */ #define MY_CORE_COMPATIBILITY_CHECK /** @}*/ // End of CoreSettingGrpPub group /** * @defgroup SleepSettingGrpPub Sleep * @ingroup MyConfigGrp * @brief These options control sleep configurations. * @{ */ /** * @def MY_SLEEP_TRANSPORT_RECONNECT_TIMEOUT_MS * @brief Timeout (in ms) to re-establish link if node is send to sleep and transport is not ready. */ #ifndef MY_SLEEP_TRANSPORT_RECONNECT_TIMEOUT_MS #define MY_SLEEP_TRANSPORT_RECONNECT_TIMEOUT_MS (10*1000ul) #endif /** * @def MY_SMART_SLEEP_WAIT_DURATION_MS * @brief The wait period (in ms) before going to sleep when using smartSleep-functions. * * This period has to be long enough for controller to be able to send out * potential buffered messages. */ #ifndef MY_SMART_SLEEP_WAIT_DURATION_MS #define MY_SMART_SLEEP_WAIT_DURATION_MS (500ul) #endif /** @}*/ // End of SleepSettingGrpPub group /** * @defgroup OTASettingGrpPub Over The Air firmware * @ingroup MyConfigGrp * @brief These options control OTA firmware configurations. * @{ */ /** * @def MY_OTA_FIRMWARE_FEATURE * @brief Define this in sketch to allow safe over-the-air firmware updates. * * This feature requires external flash and the DualOptiBoot boot-loader. * @note You can still have OTA FW updates without external flash but it * requires the MYSBootloader and you must not define this flag. */ //#define MY_OTA_FIRMWARE_FEATURE /** * @def MY_OTA_FLASH_SS * @brief Slave select pin for external flash used for OTA. */ #ifndef MY_OTA_FLASH_SS #define MY_OTA_FLASH_SS (8) #endif /** * @def MY_OTA_FLASH_JDECID * @brief Flash JDECID used for OTA. Use (0x00) if unknown. */ #ifndef MY_OTA_FLASH_JDECID #define MY_OTA_FLASH_JDECID (0x1F65) #endif /** * @def MY_DISABLE_REMOTE_RESET * @brief Disables over-the-air reset of node */ //#define MY_DISABLE_REMOTE_RESET /** @}*/ // End of OTASettingGrpPub group /** * @defgroup GatewaySettingGrpPub Gateway * @ingroup MyConfigGrp * @brief These options control gateway specific configurations. * @{ */ /** * @def MY_GATEWAY_MAX_RECEIVE_LENGTH * @brief Max buffersize needed for messages coming from controller. */ #ifndef MY_GATEWAY_MAX_RECEIVE_LENGTH #define MY_GATEWAY_MAX_RECEIVE_LENGTH (100u) #endif /** * @def MY_GATEWAY_MAX_SEND_LENGTH * @brief Max buffer size when sending messages. */ #ifndef MY_GATEWAY_MAX_SEND_LENGTH #define MY_GATEWAY_MAX_SEND_LENGTH (120u) #endif /** * @def MY_GATEWAY_MAX_CLIENTS * @brief Max number of parallel clients (sever mode). */ #ifndef MY_GATEWAY_MAX_CLIENTS #define MY_GATEWAY_MAX_CLIENTS (1u) #endif /** * @def MY_INCLUSION_MODE_FEATURE * @brief Define this to enable the inclusion mode feature. */ //#define MY_INCLUSION_MODE_FEATURE /** * @def MY_INCLUSION_BUTTON_FEATURE * @brief Enables inclusion-mode button feature on the gateway device. * * With this defined, you can put the GW in inclusion mode by pressing a button attached to the GW. */ //#define MY_INCLUSION_BUTTON_FEATURE // Disable inclusion mode button if inclusion mode feature is not enabled #ifndef MY_INCLUSION_MODE_FEATURE #undef MY_INCLUSION_BUTTON_FEATURE #endif /** * @def MY_INCLUSION_LED_PIN * @brief Enables an inclusion mode LED indicator on the gateway device. * * With this defined, inclusion mode status (on or off) is indicated by the LED. * This feature obeys @ref MY_WITH_LEDS_BLINKING_INVERSE */ //#define MY_INCLUSION_LED_PIN (7) /** * @def MY_INCLUSION_MODE_BUTTON_PIN * @brief The default input pin used for the inclusion mode button. */ #ifndef MY_INCLUSION_MODE_BUTTON_PIN #if defined(ARDUINO_ARCH_ESP8266) #define MY_INCLUSION_MODE_BUTTON_PIN (5) #else #define MY_INCLUSION_MODE_BUTTON_PIN (3) #endif #endif /** * @def MY_INCLUSION_MODE_DURATION * @brief Number of seconds inclusion mode should be enabled. */ #ifndef MY_INCLUSION_MODE_DURATION #define MY_INCLUSION_MODE_DURATION (60) #endif /** * @def MY_INCLUSION_BUTTON_EXTERNAL_PULLUP * @brief Define this to change the default state for @ref MY_INCLUSION_BUTTON_PRESSED. */ /** * @def MY_INCLUSION_BUTTON_PRESSED * @brief The logical level indicating a pressed inclusion mode button. * * If @ref MY_INCLUSION_BUTTON_EXTERNAL_PULLUP is defined, this defaults to HIGH. */ #if defined(MY_INCLUSION_BUTTON_EXTERNAL_PULLUP) #define MY_INCLUSION_BUTTON_PRESSED (HIGH) #else #define MY_INCLUSION_BUTTON_PRESSED (LOW) #endif /************************************** * Ethernet Gateway Transport Defaults ***************************************/ /** * @def MY_GATEWAY_W5100 * @brief Define this for Ethernet GW based on the W5100 module. * @def MY_GATEWAY_ENC28J60 * @brief Define this for Ethernet GW based on the ENC28J60 module. * @def MY_GATEWAY_ESP8266 * @brief Define this for Ethernet GW based on the ESP8266. * @def MY_GATEWAY_ESP32 * @brief Define this for Ethernet GW based on the ESP32. * @def MY_GATEWAY_LINUX * @brief Define this for Ethernet GW based on Linux. * @def MY_GATEWAY_TINYGSM * @brief Define this for Ethernet GW based on GSM modems supported by TinyGSM library. * @def MY_GATEWAY_MQTT_CLIENT * @brief Define this for MQTT client GW. * @def MY_GATEWAY_SERIAL * @brief Define this for Serial GW. */ // The gateway options available //#define MY_GATEWAY_W5100 //#define MY_GATEWAY_ENC28J60 //#define MY_GATEWAY_ESP8266 //#define MY_GATEWAY_ESP32 //#define MY_GATEWAY_LINUX //#define MY_GATEWAY_TINYGSM //#define MY_GATEWAY_MQTT_CLIENT //#define MY_GATEWAY_SERIAL /** * @def MY_DEBUG_VERBOSE_GATEWAY * @brief Define this for verbose debug prints related to the gateway transport. */ //#define MY_DEBUG_VERBOSE_GATEWAY /** * @def MY_WIFI_SSID * @brief SSID of your WiFi network */ //#define MY_WIFI_SSID "MySSID" /** * @def MY_WIFI_BSSID * @brief BSSID of your WiFi network */ #ifndef MY_WIFI_BSSID #define MY_WIFI_BSSID NULL #endif /** * @def MY_WIFI_PASSWORD * @brief Password of your WiFi network */ //#define MY_WIFI_PASSWORD "MyVerySecretPassword" /** * @def MY_HOSTNAME * @brief Hostname of your device */ #ifndef MY_HOSTNAME #define MY_HOSTNAME "MYSENSORS_DEVICE" #endif /** * @def MY_PORT * @brief The Ethernet TCP/UDP port to open on controller or gateway. */ #ifndef MY_PORT #ifdef MY_GATEWAY_MQTT_CLIENT #define MY_PORT 1883 #else #define MY_PORT 5003 #endif #endif /** * @def MY_MQTT_CLIENT_PUBLISH_RETAIN * @brief Enables MQTT client to set the retain flag when publishing specific messages. */ //#define MY_MQTT_CLIENT_PUBLISH_RETAIN /** * @def MY_MQTT_PASSWORD * @brief Used for authenticated MQTT connections. * * Set if your MQTT broker requires username/password. * Example: @code #define MY_MQTT_PASSWORD "secretpassword" @endcode * @see MY_MQTT_USER */ //#define MY_MQTT_PASSWORD "secretpassword" /** * @def MY_MQTT_USER * @brief Used for authenticated MQTT connections. * * Set if your MQTT broker requires username/password. * Example: @code #define MY_MQTT_USER "username" @endcode * @see MY_MQTT_PASSWORD */ //#define MY_MQTT_USER "username" /** * @def MY_MQTT_CLIENT_ID * @brief Set client ID for MQTT connections * * This define is mandatory for all MQTT client gateways. * Example: @code #define MY_MQTT_CLIENT_ID "mysensors-1" @endcode */ //#define MY_MQTT_CLIENT_ID "mysensors-1" /** * @def MY_MQTT_PUBLISH_TOPIC_PREFIX * @brief Set prefix for MQTT topic to publish to. * * This define is mandatory for all MQTT client gateways. * Example: @code #define MY_MQTT_PUBLISH_TOPIC_PREFIX "mygateway1-out" @endcode */ //#define MY_MQTT_PUBLISH_TOPIC_PREFIX "mygateway1-out" /** * @def MY_MQTT_SUBSCRIBE_TOPIC_PREFIX * @brief Set prefix for MQTT topic to subscribe to. * * This define is mandatory for all MQTT client gateways. * Example: @code #define MY_MQTT_SUBSCRIBE_TOPIC_PREFIX "mygateway1-in" @endcode */ //#define MY_MQTT_SUBSCRIBE_TOPIC_PREFIX "mygateway1-in" /** * @def MY_IP_ADDRESS * @brief Static ip address of gateway. If not defined, DHCP will be used. * * Example: @code #define MY_IP_ADDRESS 192,168,178,66 @endcode */ //#define MY_IP_ADDRESS 192,168,178,66 /** * @def MY_IP_GATEWAY_ADDRESS * @brief IP address of your broadband router/gateway, if not using DHCP. * * Example: @code #define MY_IP_GATEWAY_ADDRESS 192,168,1,1 @endcode */ //#define MY_IP_GATEWAY_ADDRESS 192,168,1,1 /** * @def MY_IP_SUBNET_ADDRESS * @brief Subnet address of your local network, if not using DHCP. * * Example: @code #define MY_IP_SUBNET_ADDRESS 255,255,255,0 @endcode */ //#define MY_IP_SUBNET_ADDRESS 255,255,255,0 /** * @def MY_USE_UDP * @brief Enables UDP mode for Ethernet gateway. * @note This is not supported on ENC28J60 and Linux based GWs. */ //#define MY_USE_UDP /** * @def MY_IP_RENEWAL_INTERVAL_MS * @brief DHCP, default renewal setting in milliseconds. */ #ifndef MY_IP_RENEWAL_INTERVAL_MS #define MY_IP_RENEWAL_INTERVAL_MS (60*1000ul) #endif /** * @def MY_MAC_ADDRESS * @brief Ethernet MAC address. * @note This needs to be unique on the network. */ #ifndef MY_MAC_ADDRESS #define MY_MAC_ADDRESS 0xDE,0xAD,0xBE,0xEF,0xFE,0xED #endif /** * @def MY_CONTROLLER_IP_ADDRESS * @brief If this is defined, gateway will act as a client trying to contact controller on * @ref MY_PORT using this IP address. * * Example: @code #define MY_CONTROLLER_IP_ADDRESS 192,168,178,254 @endcode * * If left un-defined, gateway acts as server allowing incoming connections. * @see MY_CONTROLLER_URL_ADDRESS */ //#define MY_CONTROLLER_IP_ADDRESS 192,168,178,254 /** * @def MY_CONTROLLER_URL_ADDRESS * @brief If this is defined, gateway will act as a client (ethernet or MQTT) trying to * contact controller on the given URL. * * If left un-defined, gateway acts as server allowing incoming connections. * Example: @code #define MY_CONTROLLER_URL_ADDRESS "test.mosquitto.org" @endcode * @see MY_CONTROLLER_IP_ADDRESS * @see MY_GATEWAY_MQTT_CLIENT */ //#define MY_CONTROLLER_URL_ADDRESS "test.mosquitto.org" /** @}*/ // End of GatewaySettingGrpPub group /** * @defgroup GSMSettingGrpPub GSM * @ingroup MyConfigGrp * @brief These options control GSM specific configurations. * @{ */ /** * @def MY_GSM_APN * @brief APN from your cell carrier / mobile provider. Example: 4g.tele2.se */ //#define MY_GSM_APN /** * @def MY_GSM_BAUDRATE * @brief Baudrate for your GSM modem. If left undefined, TinyGSM will try to auto detect the correct rate */ //#define MY_GSM_BAUDRATE (9600u) /** * @def MY_GSM_PIN * @brief PIN code for your SIM card, if PIN lock is active. */ //#define MY_GSM_PIN /** * @def MY_GSM_PSW * @brief If using a GSM modem, this is the password supplied by your cell carrier / mobile provider. If using ESP8266 as a WiFi modem, this is your WiFi network password */ //#define MY_GSM_PSW /** * @def MY_GSM_RX * @brief If defined, uses softSerial using defined pins (must also define MY_GSM_TX) */ //#define MY_GSM_RX /** * @def MY_GSM_SSID * @brief If using ESP8266 as WiFi modem, this is your network SSID */ //#define MY_GSM_SSID /** * @def MY_GSM_TX * @brief If defined, uses softSerial using defined pins (must also define MY_GSM_RX) */ //#define MY_GSM_TX /** * @def MY_GSM_USR * @brief Supplied by your cell carrier / mobile operator. If not required, leave undefined. */ //#define MY_GSM_USR /** @}*/ // End of GSMSettingGrpPub group /** * @defgroup LEDSettingGrpPub LED * @ingroup MyConfigGrp * @brief These options control LED specific configurations. * @{ */ /** * @def MY_DEFAULT_ERR_LED_PIN * @brief Define this with a value that correspond to your placement of the error indication LED. * * @note This is optional. * @note On some platforms (for example sensebender GW) the hardware definitions can enable the LED * by default. That default can be overridden by defining this flag. */ //#define MY_DEFAULT_ERR_LED_PIN (6) /** * @def MY_DEFAULT_TX_LED_PIN * @brief Define this with a value that correspond to your placement of the TX indication LED. * * @note This is optional. * @note On some platforms (for example sensebender GW) the hardware definitions can enable the LED * by default. That default can be overridden by defining this flag. */ //#define MY_DEFAULT_TX_LED_PIN (7) /** * @def MY_DEFAULT_RX_LED_PIN * @brief Define this with a value that correspond to your placement of the RX indication LED. * * @note This is optional. * @note On some platforms (for example sensebender GW) the hardware definitions can enable the LED * by default. That default can be overridden by defining this flag. */ //#define MY_DEFAULT_RX_LED_PIN (8) /** * @def MY_WITH_LEDS_BLINKING_INVERSE * @brief Define this to inverse the LED blinking. * * When defined LEDs are normally turned on and switches off when blinking. */ //#define MY_WITH_LEDS_BLINKING_INVERSE /** * @def MY_INDICATION_HANDLER * @brief Define to use own indication handler. */ //#define MY_INDICATION_HANDLER /** * @def MY_DEFAULT_LED_BLINK_PERIOD * @brief Default LEDs blinking period in milliseconds. */ #ifndef MY_DEFAULT_LED_BLINK_PERIOD #define MY_DEFAULT_LED_BLINK_PERIOD 300 #endif /** @}*/ // End of LEDSettingGrpPub group /** * @defgroup SecuritySettingGrpPub Security * @ingroup MyConfigGrp * @brief These options control security related configurations. * * Overview over all security related settings and how/where to apply them: * | Setting | Description | Arduino | Raspberry PI @c configure argument * |--------------------------|-------------|---------|------------- * | @ref MY_SECURITY_SIMPLE_PASSWD | Enables security (signing and encryption) without the need for @ref personalization | "#define" in the top of your sketch | Not supported (use the other two "simple" options) * | @ref MY_SIGNING_SIMPLE_PASSWD | Enables signing without the need for @ref personalization | "#define" in the top of your sketch | @verbatim --my-signing=password --my-security-password=<PASSWORD> @endverbatim * | @ref MY_ENCRYPTION_SIMPLE_PASSWD | Enables encryption without the need for @ref personalization | "#define" in the top of your sketch | @verbatim --my-security-password=<PASSWORD> @endverbatim and encryption enabled on the chosen transport * | @ref MY_DEBUG_VERBOSE_SIGNING | Enables verbose signing debugging | "#define" in the top of your sketch | @verbatim --my-signing-debug @endverbatim * | @ref MY_SIGNING_ATSHA204 | Enables support to sign messages backed by ATSHA204A hardware | "#define" in the top of your sketch | Not supported * | @ref MY_SIGNING_SOFT | Enables support to sign messages backed by software | "#define" in the top of your sketch | @verbatim --my-signing=software @endverbatim * | @ref MY_SIGNING_REQUEST_SIGNATURES | Enables node/gw to require signed messages | "#define" in the top of your sketch | @verbatim --my-signing-request-signatures @endverbatim * | @ref MY_SIGNING_WEAK_SECURITY | Weakens signing security, useful for testing before deploying signing "globally" | "#define" in the top of your sketch | @verbatim --my-signing-weak_security @endverbatim * | @ref MY_VERIFICATION_TIMEOUT_MS | Change default signing timeout | "#define" in the top of your sketch | @verbatim --my-signing-verification-timeout-ms=<TIMEOUT> @endverbatim * | @ref MY_SIGNING_NODE_WHITELISTING | Defines a whitelist of trusted nodes | "#define" in the top of your sketch | @verbatim --my-signing-whitelist="<WHITELIST>" @endverbatim * | @ref MY_SIGNING_ATSHA204_PIN | Change default ATSHA204A communication pin | "#define" in the top of your sketch | Not supported * | @ref MY_SIGNING_SOFT_RANDOMSEED_PIN | Change default software RNG seed pin | "#define" in the top of your sketch | Not supported * | @ref MY_RF24_ENABLE_ENCRYPTION | Enables encryption on RF24 radios | "#define" in the top of your sketch | @verbatim --my-rf24-encryption-enabled @endverbatim * | @ref MY_RFM69_ENABLE_ENCRYPTION | Enables encryption on %RFM69 radios | "#define" in the top of your sketch | @verbatim --my-rfm69-encryption-enabled @endverbatim * | @ref MY_RFM95_ENABLE_ENCRYPTION | Enables encryption on %RFM95 radios | "#define" in the top of your sketch | @verbatim --my-rfm95-encryption-enabled @endverbatim * | @ref MY_NRF5_ESB_ENABLE_ENCRYPTION | Enables encryption on nRF5 radios | "#define" in the top of your sketch | Not supported * | @ref MY_NODE_LOCK_FEATURE | Enables the node locking feature | "#define" in the top of your sketch | Not supported * | @ref MY_NODE_UNLOCK_PIN | Change default unlock pin | "#define" in the top of your sketch | Not supported * | @ref MY_NODE_LOCK_COUNTER_MAX | Change default "malicious activity" counter max value | "#define" in the top of your sketch | Not supported * * @{ */ /** * @def MY_SECURITY_SIMPLE_PASSWD * @brief Enables SW backed signing functionality and encryption functionality in library and uses * provided password as key. * * Example: @code #define MY_SECURITY_SIMPLE_PASSWD "MyInsecurePassword" @endcode * * For details on the effects, see the references. * @see MY_SIGNING_SIMPLE_PASSWD, MY_ENCRYPTION_SIMPLE_PASSWD */ //#define MY_SECURITY_SIMPLE_PASSWD "MyInsecurePassword" #if defined(MY_SECURITY_SIMPLE_PASSWD) #define MY_SIGNING_SIMPLE_PASSWD MY_SECURITY_SIMPLE_PASSWD #define MY_ENCRYPTION_SIMPLE_PASSWD MY_SECURITY_SIMPLE_PASSWD #endif /** * @defgroup SigningSettingGrpPub Signing * @ingroup SecuritySettingGrpPub * @brief These options control signing related configurations. * * @see MySigninggrpPub * @{ */ /** * @def MY_DEBUG_VERBOSE_SIGNING * @brief Define this for verbose debug prints related to signing. */ //#define MY_DEBUG_VERBOSE_SIGNING /** * @def MY_SIGNING_SIMPLE_PASSWD * @brief Enables SW backed signing functionality in library and uses provided password as key. * * This flag is automatically set if @ref MY_SECURITY_SIMPLE_PASSWD is used. * * This flag will enable signing and signature requests. It has to be identical on ALL nodes in the * network. * * Whitelisting is supported and serial will be the first 8 characters of the password, the ninth * character will be the node ID (to make each node have a unique serial). * * As with the regular signing modes, whitelisting is only activated if a whitelist is specified in * the sketch. * * No @ref personalization is required for this mode. * * It is allowed to set @ref MY_SIGNING_WEAK_SECURITY for deployment purposes in this mode as it is * with the regular software and ATSHA204A based modes. * * If the provided password is shorter than the size of the HMAC key, it will be null-padded * to accommodate the key size in question. A 32 character password is the maximum length. Any * password longer than that will be truncated. * * Example: @code #define MY_SIGNING_SIMPLE_PASSWD "MyInsecurePassword" @endcode * * @see MY_SECURITY_SIMPLE_PASSWD * */ //#define MY_SIGNING_SIMPLE_PASSWD "MyInsecurePassword" #if defined(MY_SIGNING_SIMPLE_PASSWD) #define MY_SIGNING_SOFT #define MY_SIGNING_REQUEST_SIGNATURES #endif /** * @def MY_SIGNING_ATSHA204 * @brief Enables HW backed signing functionality in library. */ //#define MY_SIGNING_ATSHA204 /** * @def MY_SIGNING_SOFT * @brief Enables SW backed signing functionality in library. */ //#define MY_SIGNING_SOFT /** * @def MY_SIGNING_REQUEST_SIGNATURES * @brief Enable this to inform gateway to sign all messages sent to this node. * * If used for a gateway, gateway will by default require signatures from ALL nodes. This behavior * can be disabled by weakening security. * @see MY_SIGNING_WEAK_SECURITY */ //#define MY_SIGNING_REQUEST_SIGNATURES /** * @def MY_SIGNING_WEAK_SECURITY * @brief Enable this to permit downgrade of security preferences and relaxed gateway signing * requirements. * * Use this for evaluating security. It allows for gradual introduction of signing requirements in * a network. Nodes that present themselves as not requiring signing or whitelisting will be * cleared of this requirement at the receiving end. A gateway which require signatures will only do * so from nodes that in turn require signatures. * * When not set, any node that has presented themselves as a node that require signatures or * whitelisting, will be permanently remembered as doing so at the receiver until EEPROM is cleared * or the receiver is reconfigured with this flag set or has signing disabled alltogether. * * @warning This flag when set will weaken security significantly */ //#define MY_SIGNING_WEAK_SECURITY /** * @def MY_VERIFICATION_TIMEOUT_MS * @brief Define a suitable timeout for a signature verification session * * Consider the turnaround from a nonce being generated to a signed message being received * which might vary, especially in networks with many hops. * * Shorter time gives less time for an attacker to figure a way to hijack the nonce and attempt to * brute force attack the node. Longer time permits more network hops and node or GW processing * time. 5s ought to be enough for anyone. */ #ifndef MY_VERIFICATION_TIMEOUT_MS #define MY_VERIFICATION_TIMEOUT_MS (5*1000ul) #endif /** * @def MY_SIGNING_NODE_WHITELISTING * @brief Define to turn on whitelisting * * When defined, a verifying node will look up the sender in the whitelist and salt the received * signature with that information before validating the result. It will also inform GW (or other * node) through the signing presentation message about this requirement. * * The signing node will check the presentaiton lists to determine if the recipient require * whitelisting and salt the signature with it's unique signature and nodeId before transmitting * the signed message. * * It is legal to only have one node with a whitelist for this reason but it is not required. * * Example: @code #define MY_SIGNING_NODE_WHITELISTING {{.nodeId = GATEWAY_ADDRESS,.serial = {0x09,0x08,0x07,0x06,0x05,0x04,0x03,0x02,0x01}}} @endcode */ //#define MY_SIGNING_NODE_WHITELISTING {{.nodeId = GATEWAY_ADDRESS,.serial = {0x09,0x08,0x07,0x06,0x05,0x04,0x03,0x02,0x01}}} /** * @def MY_SIGNING_ATSHA204_PIN * @brief Atsha204a default pin setting. Set it to match the pin the device is attached to. */ #ifndef MY_SIGNING_ATSHA204_PIN #define MY_SIGNING_ATSHA204_PIN (17) #endif /** * @def MY_SIGNING_SOFT_RANDOMSEED_PIN * @brief Pin used for random seed generation in soft signing * @note Do not connect anything to this when soft signing is enabled, or the seed will be * predictable. */ #ifndef MY_SIGNING_SOFT_RANDOMSEED_PIN #define MY_SIGNING_SOFT_RANDOMSEED_PIN (7) #endif /** * @def MY_LOCK_DEVICE * @brief Enable read back protection * * Enable read back protection feature. Currently only supported by NRF51+NRF52. * Use this flag to protect signing and encryption keys stored in the MCU. * * Set this flag, when you use softsigning in MySensors. Don't set this * in SecurityPersonalizer. * * @warning YOU CAN BRICK YOUR DEVICE!!! * Don't set this flag without having an boot loader, OTA firmware update and * an Gateway connection. To reset an device, you can try >> * openocd -f interface/cmsis-dap.cfg -f target/nrf52.cfg -c "program dap apreg 1 0x04 0x01" */ //#define MY_LOCK_DEVICE /** * @def MY_SIGNING_FEATURE * @ingroup internals * @brief Helper flag to indicate that some signing feature is enabled, set automatically */ #if defined(MY_SIGNING_ATSHA204) || defined(MY_SIGNING_SOFT) #define MY_SIGNING_FEATURE #endif /** @}*/ // End of SigningSettingGrpPub group /** * @defgroup EncryptionSettingGrpPub Encryption * @ingroup SecuritySettingGrpPub * @brief These options control encryption related configurations. * * Note that encryption is toggled on a per-radio basis. * @see MY_RF24_ENABLE_ENCRYPTION, MY_RFM69_ENABLE_ENCRYPTION, MY_NRF5_ESB_ENABLE_ENCRYPTION, MY_RFM95_ENABLE_ENCRYPTION * @{ */ /** * @def MY_ENCRYPTION_SIMPLE_PASSWD * @brief Enables encryption on all radio transports that supports it and uses provided password as key. * * This flag is automatically set if @ref MY_SECURITY_SIMPLE_PASSWD is used. * * This flag will enable encryption. It has to be identical on ALL nodes in the network. * * No @ref personalization is required for this mode. * * If the provided password is shorter than the size of the %AES key, it will be null-padded * to accommodate the key size in question. A 16 character password is the maximum length. Any * password longer than that will be truncated. * * Example: @code #define MY_ENCRYPTION_SIMPLE_PASSWD "MyInsecurePassword" @endcode * * @see MY_SECURITY_SIMPLE_PASSWD */ //#define MY_ENCRYPTION_SIMPLE_PASSWD "MyInsecurePassword" #if defined(MY_ENCRYPTION_SIMPLE_PASSWD) #ifndef MY_RF24_ENABLE_ENCRYPTION #define MY_RF24_ENABLE_ENCRYPTION #endif #ifndef MY_RFM69_ENABLE_ENCRYPTION #define MY_RFM69_ENABLE_ENCRYPTION #endif #ifndef MY_NRF5_ESB_ENABLE_ENCRYPTION #define MY_NRF5_ESB_ENABLE_ENCRYPTION #endif #ifndef MY_RFM95_ENABLE_ENCRYPTION #define MY_RFM95_ENABLE_ENCRYPTION #endif #endif /** * @def MY_ENCRYPTION_FEATURE * @ingroup internals * @brief Helper flag to indicate that some encryption feature is enabled, set automatically * @see MY_RF24_ENABLE_ENCRYPTION, MY_RFM69_ENABLE_ENCRYPTION, MY_NRF5_ESB_ENABLE_ENCRYPTION, MY_RFM95_ENABLE_ENCRYPTION */ #if defined(MY_RF24_ENABLE_ENCRYPTION) || defined(MY_RFM69_ENABLE_ENCRYPTION) || defined(MY_NRF5_ESB_ENABLE_ENCRYPTION) || defined(MY_RFM95_ENABLE_ENCRYPTION) #define MY_ENCRYPTION_FEATURE #endif /** @}*/ // End of EncryptionSettingGrpPub group /** * @defgroup MyLockgrppub Node locking * @ingroup MyConfig * @brief These options control node lock related configurations. * * This feature locks a node that suspect itself for being under some form of attack. * * This is achieved by having a counter stored in EEPROM which decrements when suspicious activity * is detected. * * If the counter reaches 0, the node will not work anymore and will transmit a @ref I_LOCKED * message to the gateway/controller with 30 minute intervals. Payload is a string with a reason for * the locking. * * The string is abbreviated to accommodate a signature. The following abbreviations exist at the * moment: * - LDB (Locked During Boot) * - TMNR (Too Many Nonce Requests) * - TMFV (Too Many Failed Verifications) * * Typically, the counter only decrements when suspicious activity happens in a row. * It is reset if legit traffic is present. * * Examples of malicious activity are: * - Repeatedly incorrectly checksummed OTA firmware * - Repeated requests for signing nonces without properly signed messages arriving * - Repeatedly failed signature verifications * * If counter reaches zero, node locks down and EEPROM has to be erased/reset to reactivate node. * Node can also be unlocked by grounding a pin. * @see MY_NODE_UNLOCK_PIN * * The size of the counter can be adjusted using @ref MY_NODE_LOCK_COUNTER_MAX. * @{ */ /** * @def MY_NODE_LOCK_FEATURE * @brief Enable this to activate intrusion prevention mechanisms on the node. */ //#define MY_NODE_LOCK_FEATURE /** * @def MY_NODE_UNLOCK_PIN * @brief By grounding this pin during reset of a locked node, the node will unlock. * * If using a secure bootloader, grounding the pin is the only option to reactivate the node. * If using stock Android bootloader or a DualOptiBoot it is also possible to download a sketch * using serial protocol to erase EEPROM to unlock the node. */ #ifndef MY_NODE_UNLOCK_PIN #define MY_NODE_UNLOCK_PIN (14) #endif /** * @def MY_NODE_LOCK_COUNTER_MAX * @brief Maximum accepted occurrences of suspected malicious activity in a node. * * Counter decrements on reoccurring incidents but resets if legitimate behaviour is identified. */ #ifndef MY_NODE_LOCK_COUNTER_MAX #define MY_NODE_LOCK_COUNTER_MAX (5) #endif /** @}*/ // Node lock group /** @}*/ // End of SecuritySettingGrpPub group /** * @defgroup PlatformSettingGrpPub Platform specifics * @ingroup MyConfigGrp * @brief These options control platform specific configurations. * @{ */ /** * @defgroup ESP8266SettingGrpPub ESP8266 * @ingroup PlatformSettingGrpPub * @brief These options control ESP8266 specific configurations. * @{ */ /** * @def MY_ESP8266_SERIAL_MODE * @brief ESP8266 serial modes * * - SERIAL_FULL: Default mode. * - SERIAL_TX_ONLY: allows to use RX (GPIO3) as a general purpose input/output. * - SERIAL_RX_ONLY: allows to use TX (GPIO1) as a general purpose input/output. */ #ifndef MY_ESP8266_SERIAL_MODE #define MY_ESP8266_SERIAL_MODE SERIAL_FULL #endif /** @}*/ // End of ESP8266SettingGrpPub group /** * @defgroup ESP32SettingGrpPub ESP32 * @ingroup PlatformSettingGrpPub * @brief These options control ESP32 specific configurations. * @{ */ // // no ESP32 settings // /** @}*/ // End of ESP32SettingGrpPub group /** * @defgroup LinuxSettingGrpPub Linux * @ingroup PlatformSettingGrpPub * @brief These options control Linux specific configurations. * @{ */ /** * @def MY_LINUX_SERIAL_PORT * @brief Serial device port */ //#define MY_LINUX_SERIAL_PORT "/dev/ttyUSB0" /** * @def MY_LINUX_SERIAL_PTY * @brief deprecated option */ #ifdef MY_LINUX_SERIAL_PTY #warning MY_LINUX_SERIAL_PTY is deprecated, please use MY_LINUX_SERIAL_PORT #define MY_LINUX_SERIAL_PORT MY_LINUX_SERIAL_PTY #endif /** * @def MY_LINUX_IS_SERIAL_PTY * @brief deprecated option */ #ifdef MY_LINUX_IS_SERIAL_PTY #warning MY_LINUX_IS_SERIAL_PTY is deprecated, please use MY_LINUX_SERIAL_IS_PTY #define MY_LINUX_SERIAL_IS_PTY #endif /** * @def MY_LINUX_SERIAL_IS_PTY * @brief Set serial as a pseudo terminal. * * Enable this if you need to connect to a controller running on the same device. * You also need to define MY_LINUX_SERIAL_PORT with the symlink name for the PTY device. */ //#define MY_LINUX_SERIAL_IS_PTY /** * @def MY_LINUX_SERIAL_GROUPNAME * @brief Grant access to the specified system group for the serial device. */ //#define MY_LINUX_SERIAL_GROUPNAME "tty" /** * @def MY_LINUX_CONFIG_FILE * @brief Sets the filepath for the gateway config file. * * @note For now the configuration file is only used to store the emulated eeprom state. */ #ifndef MY_LINUX_CONFIG_FILE #define MY_LINUX_CONFIG_FILE "/etc/mysensors.conf" #endif /** @}*/ // End of LinuxSettingGrpPub group /** @}*/ // End of PlatformSettingGrpPub group /* * "Helper" definitions */ /* * Detect node type * MY_GATEWAY_FEATURE is set for gateway sketches. * MY_IS_GATEWAY is true when @ref MY_GATEWAY_FEATURE is set. * MY_NODE_TYPE contain a string describing the class of sketch/node (gateway/repeater/node). */ #if defined(MY_GATEWAY_SERIAL) || defined(MY_GATEWAY_W5100) || defined(MY_GATEWAY_ENC28J60) || defined(MY_GATEWAY_ESP8266) || defined(MY_GATEWAY_ESP32)|| defined(MY_GATEWAY_LINUX) || defined(MY_GATEWAY_MQTT_CLIENT) || defined(MY_GATEWAY_TINYGSM) #define MY_GATEWAY_FEATURE #define MY_IS_GATEWAY (true) #define MY_NODE_TYPE "GW" #elif defined(MY_REPEATER_FEATURE) #define MY_IS_GATEWAY (false) #define MY_NODE_TYPE "REPEATER" #elif defined(DOXYGEN) #define MY_IS_GATEWAY //!< true when configuration indicate a gateway device, @todo Mark these internals #define MY_NODE_TYPE //!< "GW" for gateways, REPEATER" for repeaters, "NODE" for nodes, @todo Mark these internals #else #define MY_IS_GATEWAY (false) #define MY_NODE_TYPE "NODE" #endif // DEBUG #if defined(MY_DISABLED_SERIAL) && !defined(MY_DEBUG_OTA) #undef MY_DEBUG #endif #if defined(MY_DEBUG) // standard debug output #define MY_DEBUG_VERBOSE_CORE //!< MY_DEBUG_VERBOSE_CORE #define MY_DEBUG_VERBOSE_TRANSPORT //!< MY_DEBUG_VERBOSE_TRANSPORT #define MY_DEBUG_VERBOSE_GATEWAY //!< MY_DEBUG_VERBOSE_GATEWAY #define MY_DEBUG_VERBOSE_OTA_UPDATE //!< MY_DEBUG_VERBOSE_OTA_UPDATE #endif #if defined(MY_DEBUG) || defined(MY_DEBUG_VERBOSE_CORE) || defined(MY_DEBUG_VERBOSE_TRANSPORT) || defined(MY_DEBUG_VERBOSE_GATEWAY) || defined(MY_DEBUG_VERBOSE_SIGNING) || defined(MY_DEBUG_VERBOSE_OTA_UPDATE) || defined(MY_DEBUG_VERBOSE_RF24) || defined(MY_DEBUG_VERBOSE_NRF5_ESB) || defined(MY_DEBUG_VERBOSE_RFM69) || defined(MY_DEBUG_VERBOSE_RFM95) || defined(MY_DEBUG_VERBOSE_TRANSPORT_HAL) #define DEBUG_OUTPUT_ENABLED //!< DEBUG_OUTPUT_ENABLED #ifndef MY_DEBUG_OTA #define DEBUG_OUTPUT(x,...) hwDebugPrint(x, ##__VA_ARGS__) //!< debug #else #ifndef MY_OTA_LOG_SENDER_FEATURE #define MY_OTA_LOG_SENDER_FEATURE #endif #ifndef MY_DEBUG_OTA_DISABLE_ECHO #define DEBUG_OUTPUT(x,...) OTALog((MY_DEBUG_OTA), true, x, ##__VA_ARGS__) //!< debug #else #define DEBUG_OUTPUT(x,...) OTALog((MY_DEBUG_OTA), false, x, ##__VA_ARGS__) //!< debug #endif // disable radio related debugging messages #undef MY_DEBUG_VERBOSE_RF24 #undef MY_DEBUG_VERBOSE_NRF5_ESB #undef MY_DEBUG_VERBOSE_RFM69 #undef MY_DEBUG_VERBOSE_RFM69_REGISTERS #undef MY_DEBUG_VERBOSE_RFM95 #endif #else #define DEBUG_OUTPUT(x,...) //!< debug NULL #endif // temp. workaround for nRF5 verifier: redirect RF24 to NRF_ESB #if defined(ARDUINO_ARCH_NRF5) && (defined(MY_RADIO_RF24) ) #undef MY_RADIO_RF24 #define MY_RADIO_NRF5_ESB #endif // Enable sensor network "feature" if one of the transport types was enabled #if defined(MY_RADIO_RF24) || defined(MY_RADIO_NRF5_ESB) || defined(MY_RADIO_RFM69) || defined(MY_RADIO_RFM95) || defined(MY_RS485) #define MY_SENSOR_NETWORK #endif // LEDS #if !defined(MY_DEFAULT_ERR_LED_PIN) && defined(MY_HW_ERR_LED_PIN) #define MY_DEFAULT_ERR_LED_PIN MY_HW_ERR_LED_PIN #endif #if !defined(MY_DEFAULT_TX_LED_PIN) && defined(MY_HW_TX_LED_PIN) #define MY_DEFAULT_TX_LED_PIN MY_HW_TX_LED_PIN #endif #if !defined(MY_DEFAULT_RX_LED_PIN) && defined(MY_HW_TX_LED_PIN) #define MY_DEFAULT_RX_LED_PIN MY_HW_TX_LED_PIN #endif #endif // MyConfig_h // Doxygen specific constructs, not included when built normally // This is used to enable disabled macros/definitions to be included in the documentation as well. #if DOXYGEN /** * @def ARDUINO_ARCH_SAMD * @brief Automatically set when building for SAMD targets */ #define ARDUINO_ARCH_SAMD /** * @def ARDUINO_ARCH_NRF5 * @brief Automatically set when building for nRF5 targets */ #define ARDUINO_ARCH_NRF5 /** * @def ARDUINO_ARCH_ESP8266 * @brief Automatically set when building for ESP8266 targets */ #define ARDUINO_ARCH_ESP8266 /** * @def ARDUINO_ARCH_ESP32 * @brief Automatically set when building for ESP32 targets */ #define ARDUINO_ARCH_ESP32 /** * @def ARDUINO_ARCH_AVR * @brief Automatically set when building for AVR targets */ #define ARDUINO_ARCH_AVR /** * @def ARDUINO_ARCH_STM32F1 * @brief Automatically set when building for STM32F1 targets */ #define ARDUINO_ARCH_STM32F1 /** * @def TEENSYDUINO * @brief Automatically set when building for Teensy targets */ #define TEENSYDUINO // debug #define MY_DEBUG #define MY_DEBUGDEVICE #define MY_DEBUG_OTA #define MY_DEBUG_OTA_DISABLE_ECHO #define MY_SPECIAL_DEBUG #define MY_DISABLED_SERIAL #define MY_SPLASH_SCREEN_DISABLED // linux #define MY_LINUX_SERIAL_PORT #define MY_LINUX_SERIAL_IS_PTY #define MY_LINUX_SERIAL_GROUPNAME #define MY_LINUX_SERIAL_PTY #define MY_LINUX_IS_SERIAL_PTY // inclusion mode #define MY_INCLUSION_MODE_FEATURE #define MY_INCLUSION_BUTTON_FEATURE // OTA logging and debug #define MY_OTA_LOG_RECEIVER_FEATURE #define MY_OTA_LOG_SENDER_FEATURE // transport #define MY_PARENT_NODE_IS_STATIC #define MY_REGISTRATION_CONTROLLER #define MY_TRANSPORT_UPLINK_CHECK_DISABLED #define MY_TRANSPORT_SANITY_CHECK #define MY_NODE_LOCK_FEATURE #define MY_REPEATER_FEATURE #define MY_PASSIVE_NODE #define MY_MQTT_CLIENT_PUBLISH_RETAIN #define MY_MQTT_PASSWORD #define MY_MQTT_USER #define MY_MQTT_CLIENT_ID #define MY_MQTT_PUBLISH_TOPIC_PREFIX #define MY_MQTT_SUBSCRIBE_TOPIC_PREFIX #define MY_SIGNAL_REPORT_ENABLED // general #define MY_WITH_LEDS_BLINKING_INVERSE #define MY_INDICATION_HANDLER #define MY_DISABLE_REMOTE_RESET #define MY_DISABLE_RAM_ROUTING_TABLE_FEATURE #define MY_LOCK_DEVICE // core #define MY_CORE_ONLY // GW #define MY_DEBUG_VERBOSE_GATEWAY #define MY_INCLUSION_BUTTON_EXTERNAL_PULLUP #define MY_INCLUSION_LED_PIN #define MY_GATEWAY_W5100 #define MY_GATEWAY_ENC28J60 #define MY_GATEWAY_ESP8266 #define MY_GATEWAY_ESP32 #define MY_WIFI_SSID #define MY_WIFI_BSSID #define MY_WIFI_PASSWORD #define MY_HOSTNAME #define MY_GATEWAY_LINUX #define MY_GATEWAY_TINYGSM #define MY_GATEWAY_MQTT_CLIENT #define MY_GATEWAY_SERIAL #define MY_IP_ADDRESS #define MY_IP_GATEWAY_ADDRESS #define MY_IP_SUBNET_ADDRESS #define MY_USE_UDP #define MY_CONTROLLER_IP_ADDRESS #define MY_CONTROLLER_URL_ADDRESS // TinyGSM #define MY_GSM_APN #define MY_GSM_BAUDRATE #define MY_GSM_PIN #define MY_GSM_PSW #define MY_GSM_RX #define MY_GSM_SSID #define MY_GSM_TX #define MY_GSM_USR // LED #define MY_DEFAULT_ERR_LED_PIN #define MY_DEFAULT_TX_LED_PIN #define MY_DEFAULT_RX_LED_PIN // signing #define MY_SECURITY_SIMPLE_PASSWD #define MY_SIGNING_SIMPLE_PASSWD #define MY_ENCRYPTION_SIMPLE_PASSWD #define MY_SIGNING_ATSHA204 #define MY_SIGNING_SOFT #define MY_SIGNING_REQUEST_SIGNATURES #define MY_SIGNING_WEAK_SECURITY #define MY_SIGNING_NODE_WHITELISTING #define MY_DEBUG_VERBOSE_SIGNING #define MY_SIGNING_FEATURE #define MY_ENCRYPTION_FEATURE // FOTA update #define MY_DEBUG_VERBOSE_OTA_UPDATE #define MY_OTA_USE_I2C_EEPROM // RS485 #define MY_RS485 #define MY_RS485_DE_PIN #define MY_RS485_DE_INVERSE #define MY_RS485_HWSERIAL // RF24 #define MY_RADIO_RF24 #define MY_RADIO_NRF24 //deprecated #define MY_DEBUG_VERBOSE_RF24 #define MY_RF24_POWER_PIN #define MY_RF24_IRQ_PIN #define MY_RF24_ENABLE_ENCRYPTION #define MY_RX_MESSAGE_BUFFER_FEATURE #define MY_RX_MESSAGE_BUFFER_SIZE // NRF5_ESB #define MY_RADIO_NRF5_ESB #define MY_NRF5_ESB_ENABLE_ENCRYPTION #define MY_DEBUG_VERBOSE_NRF5_ESB #define MY_NRF5_ESB_REVERSE_ACK_RX #define MY_NRF5_ESB_REVERSE_ACK_TX // RFM69 #define MY_RADIO_RFM69 #define MY_IS_RFM69HW #define MY_RFM69_NEW_DRIVER #define MY_RFM69_POWER_PIN #define MY_RFM69_MODEM_CONFIGURATION #define MY_RFM69_ENABLE_ENCRYPTION #define MY_RFM69_ATC_MODE_DISABLED #define MY_RFM69_MAX_POWER_LEVEL_DBM #define MY_RFM69_RST_PIN #define MY_DEBUG_VERBOSE_RFM69 #define MY_DEBUG_VERBOSE_RFM69_REGISTERS // RFM95 #define MY_RADIO_RFM95 #define MY_DEBUG_VERBOSE_RFM95 #define MY_RFM95_ENABLE_ENCRYPTION #define MY_RFM95_ATC_MODE_DISABLED #define MY_RFM95_RST_PIN #define MY_RFM95_MODEM_CONFIGRUATION #define MY_RFM95_POWER_PIN #define MY_RFM95_TCXO #define MY_RFM95_MAX_POWER_LEVEL_DBM // SOFT-SPI #define MY_SOFTSPI #endif /** @}*/ // End of MyConfig group |
Одно из наиболее часто используемых значений это MY_DEBUG, которое включает / отключает сообщения отладки. Можно настроить такие вещи, как тип радиомодуля, частота, канал, Led индикацию, опций подписи и т.д.
Не забудьте это настроить перед подключением библиотеки MySensors.h.
Вот все доступных опций. Примечание: Эта таблица будет обновляться в ближайшее время
| Name | Default Value | Comment |
| MY_NODE_ID | AUTO | ID ноды выдается автоматически, если статический адрес не указан в скетче (1-254). |
| MY_PARENT_NODE_ID | ID ноды родителя для данного узла. | |
| MY_PARENT_NODE_IS_STATIC | ID родителя постоянный | |
| MY_RADIO_NRF24 | Disabled | Добавьте в скетч если используете NRF24L01+ |
| MY_RADIO_RFM69 | Disabled | Добавьте в скетч если используете RFM69 |
| MY_RS485 | Disabled | Добавьте в скетч если используете serial |
| MY_REPEATER_FEATURE | Disabled | Включение функции репитера (повторителя, ретранслятора)(пересылаются сообщения других нод). Включать, если есть удаленные ноды на большом расстоянии от гейта. |
| MY_GATEWAY_SERIAL | ||
| MY_GATEWAY_W5100 | ||
| MY_GATEWAY_ENC28J60 | ||
| MY_GATEWAY_ESP8266 | ||
| MY_DEBUG | Disabled | Чтобы видеть сообщения в порту ноды добавить MY_DEBUG в скетче, но при включении увеличится размер скетча. |
| MY_SPECIAL_DEBUG | Disabled | Добавьте MY_SPECIAL_DEBUG в программу для активации I_DEBUG сообщений, если MY_DEBUG отключен. I_DEBUG запрашивает: R: routing info (only repeaters): received msg XXYY (as stream), where XX is the node and YY the routing node, V: CPU voltage //Напряжение на процессоре,F: CPU frequency // Частоту процессора (камня), M: free memory //Свободное место, E: clear MySensors EEPROM area and reboot (i.e. «factory» reset) //Очищает EEPROM и перезагружает ноду |
| MY_DEBUG_VERBOSE | Disabled | В консоль выводит подробные сообщения в части подписи сообщений |
| MY_DEBUG_VERBOSE_RF24 | Disabled | При включении выводит подробные сообщения касающиеся RF24 driver. DEBUG Должен быть включен. |
| MY_DEBUG_VERBOSE_SIGNING | Disabled | MY_DEBUG_VERBOSE_SIGNING в консоль выводит подробные сообщения в части подписи сообщений |
| MY_DISABLED_SERIAL | Disabled | Включить если необходимо использовать TX(1), RX(0) как обычные пины I/O pin |
| MY_WITH_LEDS_BLINKING_INVERSE | ||
| MY_DEFAULT_LED_BLINK_PERIOD | ||
| MY_DEFAULT_RX_LED_PIN | ||
| MY_DEFAULT_TX_LED_PIN | ||
| MY_DEFAULT_ERR_LED_PIN | ||
| MY_INCLUSION_MODE_FEATURE | ||
| MY_INCLUSION_BUTTON_FEATURE | ||
| MY_INCLUSION_MODE_BUTTON_PIN | ||
| MY_INCLUSION_MODE_DURATION | ||
| MY_INCLUSION_BUTTON_EXTERNAL_PULLUP | ||
| MY_SIGNING_ATSHA204 | ||
| MY_SIGNING_SOFT | ||
| MY_VERIFICATION_TIMEOUT_MS | ||
| MY_SIGNING_NODE_WHITELISTING | ||
| MY_SIGNING_ATSHA204_PIN | ||
| MY_SIGNING_SOFT_RANDOMSEED_PIN | ||
| MY_SIGNING_REQUEST_SIGNATURES | ||
| MY_RF24_ENABLE_ENCRYPTION | ||
| MY_RF24_SPI_MAX_SPEED | ||
| MY_RF24_CE_PIN | ||
| MY_RF24_CS_PIN | ||
| MY_RF24_PA_LEVEL | RF24_PA_MAX | Варианты усиления: RF24_PA_MIN, RF24_PA_LOW, RF24_PA_HIGH or RF24_PA_MAX. MAX По умолчанию используется максимальная мощность NRF24l01 |
| MY_RF24_CHANNEL | 76 | |
| MY_RF24_DATARATE | 256Kbps | |
| MY_RF24_BASE_RADIO_ID | ||
| MY_SOFTSPI | ||
| MY_SOFT_SPI_SCK_PIN | ||
| MY_SOFT_SPI_MISO_PIN | ||
| MY_SOFT_SPI_MOSI_PIN | ||
| MY_REGISTRATION_FEATURE | Enabled | Если функция включена, нода сначала регистрируется на гейте, а уже потом передает данные с сенсоров |
| MY_REGISTRATION_RETRIES | 3 | Количество попыток регистрации если гейт или контроллер не отвечают |
| MY_REGISTRATION_DEFAULT | true | Регистрация по умолчанию, если нода не получила ответ о регистрации от гейта |
| MY_REGISTRATION_CONTROLLER | Disabled | Если включено, то запрос на регистрацию должен быть обработан контроллером |
| MY_OTA_FIRMWARE_FEATURE | Disabled | Добавьте MY_OTA_FIRMWARE_FEATURE для обновления по воздуху. Данная функция требует наличия внешней памяти и загрузчика DualOptiBoot .Вы можете обновиться по воздуху и без внешней памяти, но это требует наличие MYSBootloader и отключить MY_OTA_FIRMWARE_FEATURE Подробнее https://www.mysensors.org/about/ota https://www.mysensors.org/about/ota |
| MY_OTA_FLASH_SS | 8 | Указать пин для внешней памяти |
| MY_OTA_FLASH_JDECID | 0x1F65 | Память jdecid. |
| MY_RFM69_FREQUENCY | RFM69_868MHZ | Для других частот измените это определение в эскизе на предпочтительное значение в RFM69_433MHZ, RFM69_868MHZ или RFM69_915MHZ |
| MY_IS_RFM69HW | Disabled | По умолчанию это определение комментируется в библиотеке. Если вы хотите использовать версию RFM69H (C) W, просто добавьте это определение в свой эскиз |
| MY_RFM69_NETWORKID | 100 | Вы можете изменить его, добавив это определение в свой эскиз и настройте его на свое предпочтительное значение. Пример: #define MY_RFM69_NETWORKID 101 |
| MY_RF69_IRQ_PIN | 2 | Если вам нужно изменить его, добавьте это определение в свой эскиз и установите его на свой предпочтительный вывод. Примечание для 328p uC (mini pro, nano, moteino и т. Д.), Mysensors обрабатывает только контакты D2 / D3. Последнее примечание: на данный момент вам также необходимо установить MY_RF69_IRQ_NUM. Смотри ниже |
| MY_RF69_IRQ_NUM | 0 | (будет удален в следующем выпуске). Нужно, если вы хотите изменить контакт IRQ, к которому подключено ваше радио. Итак, если ваше радио подключено к D3 / INT1, установите #define MY_RF69_IRQ_PIN 3, затем #define MY_RF69_IRQ_NUM 1 |
| MY_RF69_SPI_CS | 10 | Вы можете изменить его, добавив это определение в свой эскиз и установите его на свой предпочтительный вывод значения |
| MY_RFM69_ENABLE_ENCRYPTION | Disabled | Добавьте это определение в свой эскиз, если вы хотите включить шифрование |
| MY_RAM_ROUTING_TABLE_FEATURE | Enabled | Если этот параметр включен, то таблица маршрутизации хранится в оперативной памяти (если позволяет память) и сохраняются в регулярные промежутки времени. Примечание: AVR имеет ограниченную память, использовать с осторожностью |
| MY_ROUTING_TABLE_SAVE_INTERVAL_MS | 10 min (600000ms) | Интервал обновления таблицы маршрутизации |
| MY_CORE_ONLY | Disabled | Добавить в скетч MY_CORE_ONLY если желаете использовать функции без загрузки всей платформы |
| MY_BAUD_RATE | 115200 | Устанавливаем скорость порта для отладочных сообщений и для СериалГейта |
| MY_CORE_COMPATIBILITY_CHECK | Enabled | Если этот параметр включен, библиотека проверяет совместимость при регистрации узла. Несовместимые библиотеки не могут отправить данные датчика. |
| MY_TRANSPORT_SANITY_CHECK | Disabled | Если функция включена нода проверяет передачу с регулярным интервалом для обнаружения проблем, при сбое пытается снова инициализировать. Включена для всех нод-репитеров. |
| MY_TRANSPORT_SANITY_CHECK_INTERVAL | 60000 | Величина интервала проверки передачи в мс. |
| MY_TRANSPORT_DISCOVERY_INTERVAL_MS | 10 min (600000ms) | Этот параметр проверки сети только для гейта |
| MY_TRANSPORT_UPLINK_CHECK_DISABLED | Disabled | Если установлено, то проверка поднятия линии связи GW отключается во время инициализации транспорта. |
| MY_TRANSPORT_MAX_TX_FAILURES | 10 | Максимально количествонеудачных инициализаций |
| MY_SLEEP_TRANSPORT_RECONNECT_TIMEOUT_MS | 10000 | Таймаут для повторной передачи если нода спит. |
| MY_SMART_SLEEP_WAIT_DURATION_MS | 500 | Период ожидания (в мс) перед сном при использовании SmartSleep-функций. Этот период должен быть достаточно большим для контроллера, чтобы иметь возможность посылать буферизованные сообщения. |
| MY_MQTT_SUBSCRIBE_TOPIC_PREFIX | ||
| MY_MQTT_PUBLISH_TOPIC_PREFIX | ||
| MY_MQTT_CLIENT_ID | ||
| MY_GATEWAY_MQTT_CLIENT | ||
| MY_NODE_LOCK_FEATURE | ||
| MY_NODE_UNLOCK_PIN | ||
| MY_NODE_LOCK_COUNTER_MAX | ||
| MY_ESP8266_SSID | ||
| MY_ESP8266_PASSWORD | ||
| MY_ESP8266_HOSTNAME | ||
| MY_PORT | ||
| MY_IP_ADDRESS | ||
| MY_USE_UDP | ||
| MY_IP_RENEWAL_INTERVAL | ||
| MY_MAC_ADDRESS | ||
| MY_CONTROLLER_IP_ADDRESS | ||
| MY_IP_GATEWAY_ADDRESS | ||
| MY_IP_SUBNET_ADDRESS | ||
| MY_GATEWAY_MAX_CLIENTS | 1 | Максимальное количество клиентов (режим сервера) |
| MY_GATEWAY_MAX_SEND_LENGTH | 120 | Максимальный размер буфера для отправки сообщений. |
| MY_GATEWAY_MAX_RECEIVE_LENGTH | 100 | Максимальный размер буфера сообщений приходящих от контроллера |
| MY_W5100_SPI_EN | ||
| MY_RS485_BAUD_RATE | ||
| MY_RS485_MAX_MESSAGE_LENGTH | ||
| MY_RS485_DE_PIN | ||
| MY_DISABLE_REMOTE_RESET | Disabled | Отключение удаленной перезагрузки ноды |
| MY_SMART_SLEEP_WAIT_DURATION | ||
| MY_SPIFLASH_SST25TYPE | ||
Запуск библиотеки
Библиотека запускается автоматически и перехватывает себя до вашего основного цикла.
Получение идентификатора узла
При включении режима автоматического ID (по умолчанию), датчик автоматически получает уникальный идентификатор узла. Идентификатор может быть получен с помощью вызова этого метода.
|
1 |
uint8_t getNodeId (); |
Презентация
Датчики должны представить себя, прежде чем они начнут передавать данные контроллеру. Делайте эти вызовы в функции presentation()
|
1 |
void present(uint8_t childSensorId, uint8_t sensorType, const char *description, bool ack); |
childSensorId — Уникальный идентификатор для датчика, подключенного к данному Arduino. Диапазон 0-254.
sensorType — тип датчика .
Description— Необязательное текстовое описание подключенного датчика.
ack — Установите true, если хотите чтобы конечный узел подтвердил получение сообщения. По умолчанию отключено.
Вы также можете отправить какую-то дополнительную мета-информацию для данного датчика узла.
|
1 |
void sendSketchInfo(const char *name, const char *version, bool ack); |
name — строка, содержащая краткое имя эскиза или NULL. Не более 25 символов.
version — строка, содержащая краткий эскиз версии или NULL, если не применимо.
ack — Установите true, если хотите чтобы конечный узел подтвердил получение сообщения. По умолчанию отключено.
Отправка данных
Можно отправлять данные в контроллер или другой узел, используя метод Send (msg).
|
1 |
bool send(MyMessage &msg, bool ack); |
msg — Сообщение, которое вы хотите отправить. См MyMessage для уточнения.
ack — Установите true, если хотите чтобы конечный узел подтвердил получение сообщения. По умолчанию отключено.
Если ваш узел работает от батареи, и вы реализовали измерения уровня батареи вы можете отправить уровень заряда батареи контроллеру.
|
1 |
void sendBatteryLevel(uint8_t level, bool ack); |
level — Уровень заряда батареи между 0-100 (%) — уровень
ack — Установите true, если хотите чтобы конечный узел подтвердил получение сообщения. По умолчанию отключено.
Отправка сообщения на контроллер (узел жив!).
|
1 |
void sendHeartbeat(); |
Узлы, ожидающие входящие данные, такие, как исполнительные механизм (реле, и т.д) или ноды в режиме ретранслятора, должны использовать receive() — это функция для обработки входящих сообщений. Узлы должны быть не спящие иначе входящие данные будут утеряны.
|
1 |
void receive(const MyMessage &message) |
message — Входящие данные сообщения
Запрос данных
Запрашивает какого-либо значение от шлюза или другого узла в сети. Если вы отправляете этот запрос на какой-либо узел, то должны самостоятельно обрабатывать ответное сообщение в функции receive() узла назначения. Добавление данной функции обязательно для обработки ответа на запрос.
|
1 |
void request(uint8_t childSensorId, uint8_t variableType, uint8_t destination); |
childSensorId — Уникальный идентификатор сенсора для различных датчиков, подключенных к узлу. 0-254.
variableType — тип переменной .
destination — Id другого узла для запроса данных из сети. По умолчанию шлюз.
Запрос времени от контроллера
Запрашивает время от контроллера. Ответ будет получен в функцию receiveTime() в вашем эскизе.
|
1 2 3 |
void requestTime(); void receiveTime(unsigned long ts); |
ts — Время в секундах, начиная с 1970 года с поправкой на часовой пояс с помощью контроллера.
Конфигурация контроллера
Ваш датчик отвечает за данные в правильных единицах измерения. Контроллер может дать вам «подсказку», о единицах измерения.
|
1 |
ControllerConfig GetConfig (); |
ControlleConfig содержит только isMetric , который имеет следующие параметры:
истина (= метрическая) — Цельсию, метр, см, г, км / ч, м / с и т.п ..
ложь (= имперская) — Fahrenheit, ноги, галлон, миль / ч и т.д. …
Сохранение состояния
Вы можете сохранить значение (в локальном EEPROM), хорошо для исполнительных механизмов для запоминания состояния. У вас есть 256 байт. Обратите внимание, что существует ограничение на количество операций записи EEPROM может обрабатывать (~ 100 000 циклов).
|
1 |
void saveState(uint8_t pos, uint8_t value); |
pos — (0-255)
value — значение для сохранения в позиции
Получение состояния (из локальной EEPROM).
|
1 |
uint8 loadState(uint8_t pos); |
pos — Положение для извлечения из EEPROM (0-255)
Ожидание
Ожидание с использованием команды Arduino delay() не является хорошей идеей. Она останавливает всю обработку MySensors и ее следует избегать. Вместо этого вы должны использовать функцию wait(), которая вызывает process() во время ожидания. Обратите внимание, что она не обесточит Arduino или радио во время ожидания. Используйте функцию сна, если хотите сохранить батарею.
|
1 |
void wait(unsigned long ms); |
ms — количество миллисекунд ожидания (в то же время обработка входящих данных)
Ожидание для конкретного сообщения (или максимальное время в миллисекундах).
|
1 |
bool wait(unsigned long ms, uint8_t cmd, uint8_t msgtype); |
ms — количество миллисекунд ожидания (в то же время обработка входящих данных)
cmd — тип команды ожидания
msgtype — Тип сообщения для ожидания
Сон
Для экономии заряда батареи крайне важно, чтобы узел спал. Узел может проснуться от прерываний или с помощью таймера.
Каждая функция сна имеет «умный» вариант, который посылает heartbeat(узел жив) и обрабатывать входящие сообщения перед сном. Это полезно для отправки команд или прошивки FOTA для спящих узлов. Контроллер должен поддерживать буферизацию сообщений и отправлять их, когда узел просыпается.
Функции сна по таймеру.
|
1 2 |
void sleep(unsigned long ms); void smartSleep(unsigned long ms); |
ms — Количество миллисекунд спать.
Функции сна по внешнему прерыванию или по таймеру
Смотрите: http://arduino.cc/en/Reference/attachInterrupt . Подробную информацию о режимах назначения ног прерывания. На Nano / Pro Mini: 0 = Pin2, 1 = PIN3
|
1 2 |
int8_t sleep(int interrupt, int mode, unsigned long ms=0); int8_t smartSleep(int interrupt, int mode, unsigned long ms=0); |
interrupt — прерывание, которое должно вызвать пробуждение.
mode — RISING, FALLING, CHANGE (РАСТЕТ, ПАДАЕТ, ИЗМЕНЯЕТСЯ)
ms — Количество миллисекунд спать (или 0, чтобы спать постоянно).
Возвращает номер прерывания, если пробуждение было вызвано прерыванием, MY_SLEEP_NOT_POSSIBLE если сон не был возможен и отрицательное число если таймер разбудил его.
|
1 2 |
int8_t sleep(uint8_t interrupt1, uint8_t mode1, uint8_t interrupt2, uint8_t mode2, unsigned long ms=0); int8_t smartSleep(uint8_t interrupt1, uint8_t mode1, uint8_t interrupt2, uint8_t mode2, unsigned long ms=0); |
interrupt1 — Первое прерывание, которое должно вызвать пробуждение.
mode1 — режим для первого прерывания RISING, FALLING, CHANGE (РАСТЕТ, ПАДАЕТ, ИЗМЕНЯЕТСЯ)
interrupt2 — второе прерывание, которое должно вызвать пробуждение.
mode2 — режим для второго прерывания RISING, FALLING, CHANGE (РАСТЕТ, ПАДАЕТ, ИЗМЕНЯЕТСЯ)
ms — Количество миллисекунд спать (или 0, чтобы спать постоянно).
Возвращает номер прерывания, если пробуждение было вызвано прерыванием, MY_SLEEP_NOT_POSSIBLE если сон не был возможен и отрицательное число если по таймеру.
Подписание сообщений
Для включения подписанных сообщений, есть отличный гид здесь.
Конструктор сообщений
Создайте экземпляр MyMessage. Этот класс содержит данные сообщения и некоторые помощники для установки полезной нагрузки.
|
1 |
MyMessage (uint8_t childSensorId, uint8_t variableType); |
childSensorId — Id датчика . 0-254.
variableType — тип переменной .
Управление сообщениями
Вы можете управлять исходящими и входящими сообщениями со следующими функциями.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 |
// Setters for building message "on the fly" MyMessage& setType(uint8_t type); MyMessage& setSensor(uint8_t sensor); MyMessage& setDestination(uint8_t destination); // Setters for payload MyMessage& set(void* payload, uint8_t length); MyMessage& set(const char* value); MyMessage& set(uint8_t value); MyMessage& set(float value, uint8_t decimals); MyMessage& set(unsigned long value); MyMessage& set(long value); MyMessage& set(unsigned int value); MyMessage& set(int value); // Getter for ack-flag. Returns true if this is an ack message. bool isAck() const; // Getters for picking up payload on incoming messages char* getStream(char *buffer) const; char* getString(char *buffer) const; const char* getString() const; void* getCustom() const; uint8_t getByte() const; bool getBool() const; float getFloat() const; long getLong() const; unsigned long getULong() const; int getInt() const; unsigned int getUInt() const; |
Автор перевода anton_kulibin
