mirror of
https://github.com/timmbogner/Farm-Data-Relay-System
synced 2024-10-30 09:20:15 +00:00
House keeping on keywords.txt, library.properties and README.md
- added missing categories in keywords.txt - added dependency of ArduinoJson in library.properties (I didn't add LoRa and PubSubClient but think they should go there as well) - reformatted paragraph on dependencies as list for better readability
This commit is contained in:
parent
3878c27725
commit
454365d453
@ -9,11 +9,10 @@ Using an assigned MAC address scheme allows for the whole system to be configure
|
||||
### Installation
|
||||
To install FDRS, download the project folder and move it to your Arduino libraries folder. You will then be able to access all of the FDRS sketch files from the examples menu.
|
||||
|
||||
[ArduinoJson](https://arduinojson.org/) is required.
|
||||
|
||||
This [LoRa library](https://github.com/sandeepmistry/arduino-LoRa) is required only if you are using LoRa.
|
||||
|
||||
[MQTT](https://github.com/knolleary/pubsubclient/) required for MQTT Gateways.
|
||||
You must install the following libraries in order to use all of the features from FDRS:
|
||||
- [ArduinoJson](https://arduinojson.org/) (mandatory)
|
||||
- [LoRa library](https://github.com/sandeepmistry/arduino-LoRa) by sandeepmistry (required if using LoRa)
|
||||
- [PubSubClient](https://github.com/knolleary/pubsubclient/) (required for MQTT Gateways)
|
||||
|
||||
|
||||
### [Sensors](https://github.com/timmbogner/Farm-Data-Relay-System/tree/main/FDRS_Sensor)
|
||||
|
32
keywords.txt
32
keywords.txt
@ -1,18 +1,25 @@
|
||||
##########################################################
|
||||
#######################################################################
|
||||
# Syntax Coloring Map For Farm-Data-Relay-System
|
||||
##########################################################
|
||||
#######################################################################
|
||||
#
|
||||
# Format for each line:
|
||||
# KEYWORD KEYWORD_TOKENTYPE REFERENCE_LINK RSYNTAXTEXTAREA_TOKENTYPE
|
||||
# (only the first two are used)
|
||||
#
|
||||
#######################################################################
|
||||
|
||||
##########################################################
|
||||
|
||||
#######################################################################
|
||||
# Datatypes and Class names (KEYWORD1)
|
||||
##########################################################
|
||||
#######################################################################
|
||||
DataReading KEYWORD1
|
||||
FDRSBase KEYWORD1
|
||||
FDRSLoRa KEYWORD1
|
||||
FDRS_EspNow KEYWORD1
|
||||
|
||||
##########################################################
|
||||
#######################################################################
|
||||
# Methods and Functions (KEYWORD2)
|
||||
##########################################################
|
||||
#######################################################################
|
||||
FDRS_DBG KEYWORD2
|
||||
begin KEYWORD2
|
||||
beginFDRS KEYWORD2
|
||||
@ -32,9 +39,14 @@ sleep KEYWORD2
|
||||
sleepFDRS KEYWORD2
|
||||
transmitLoRa KEYWORD2
|
||||
|
||||
##########################################################
|
||||
#######################################################################
|
||||
# structures (KEYWORD3)
|
||||
#######################################################################
|
||||
|
||||
|
||||
#######################################################################
|
||||
# Literals (LITERAL1)
|
||||
##########################################################
|
||||
#######################################################################
|
||||
DEEP_SLEEP LITERAL1
|
||||
FDRS_BAND LITERAL1
|
||||
FDRS_DEBUG LITERAL1
|
||||
@ -53,3 +65,7 @@ SPI_MOSI LITERAL1
|
||||
SPI_SCK LITERAL1
|
||||
UNIT_MAC LITERAL1
|
||||
USE_LORA LITERAL1
|
||||
|
||||
#######################################################################
|
||||
# ? (LITERAL2)
|
||||
#######################################################################
|
||||
|
@ -7,4 +7,4 @@ paragraph=FDRS is a highly configurable cloud-agnostic network utilizing LoRa an
|
||||
category=Communication
|
||||
url=https://github.com/timmbogner/Farm-Data-Relay-System
|
||||
architectures=*
|
||||
#includes=fdrs_globals.h,fdrs_sensor.h
|
||||
depends=ArduinoJson
|
||||
|
Loading…
Reference in New Issue
Block a user