diff --git a/README.md b/README.md index ab093d1..abae8b3 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,19 @@ # Introducton -This is the condbase of our Lego sorting robot for an educational setup as OST. +This is the codebase of our Lego sorting robot for an educational setup as OST. While there is another experimental implementaiton of this robot in the rep SmartFactory_SorticRoboter, this is the current stable code that is used in production. For installation, please use the "production" branch to get stable code with the latest bugfixes. +# structure + +Sortic150 consists of several modules located in the sw-# Introducton + +This is the codebase of our Lego sorting robot for an educational setup as OST. +While there is another experimental implementaiton of this robot in the rep SmartFactory_SorticRoboter, this is the current stable code that is used in production. For installation, please use the "production" branch to get stable code with the latest bugfixes. + +This branch designed to use with a PLC compact CPU 1512C-1 PN +to resemble an real decentralized factory. + # structure Sortic150 consists of several modules located in the sw-modules directory. @@ -17,37 +27,114 @@ The individual modules are presented below: ## Build -Build&Upload -`python -m platformio run -t upload` ## API chassis -IN -Run action with index 0 with params 100. -`a0[100]` +Write into memory of the PLC (DB100) with OPCua or RFC1006-communication protocol + +OPCua ns=3;s="Data_Block1"."BoxAt" + +IN type Offset + +done Bool 0 +distanz Int16 6 +BoxAt Int16 8 +getPackage Bool 10 -Out -Sends all the sensor values as shown below: -`[s0,s1,...,sn]` +OUT type Offset + +sollPos Int16 2 ## API roboter-arm +gets Data with OPCua + ### IN -Pickup 0: left, 1: right -`pickup(0)` -`pickup(1)` +sollPos (Int) +'1 pickup back' +'2 put down back' +'3 pickup front' +'4 put down front' + +### Out + +done (Bool) + +## API package-reader + +Sends Data with MQTT + +### IN -Drop 0: left, 1:right -`drop(0)` -`drop(1)` +- ### Out -Success: -`success(1)` -Fail: -`success(0)` +getPackage Bool + + +# module-raspbi + +## Requirements + +- RaspberryPi(Model 3B+) +- SD-Card(16Gb) +- Touch-Screen + +## Setup Instructions + +### Before you begin + +1. [Download Raspbian Buster with desktop](https://downloads.raspberrypi.org/raspbian_latest) +2. Follow Installing instructions [installing-images](https://www.raspberrypi.org/documentation/installation/installing-images/README.md) +3. Insert the sd-card and put the device together(plug-in the usb cables etc.) + +### Set Up The RaspberryPi + +1. Connect the RaspberryPi with the Internet +2. Install latest the Node-Red [follow instructions](https://nodered.org/docs/getting-started/raspberrypi) +3. [Autostart Chromium in Kioskmode](https://itrig.de/index.php?/archives/2309-Raspberry-Pi-3-Kiosk-Chromium-Autostart-im-Vollbildmodus-einrichten.html) + +### Configure Node-Red + +1. Copy/paste the node-red.json into running node-red +2. Install node-red-dashboard +3. Autostart node-red on boot: sudo systemctl enable nodered.service + +## Testing + +ip_raspbi:1880/ui + +Show connected devices +`python -m platformio device list` + +Show API OUT from device(needs sudo) +`python -m platformio device monitor` + +# module-iot2050 + +Image from SIEMENS website. (https://support.industry.siemens.com/cs/document/109780231/simatic-iot2050-sd-card-beispielimage?dti=0&lc=de-CH) + +Setup like module-raspbi. Node-red is pre-installed + +differents to Raspberry Pi: +- Nodes for Hardware-Pins (for Arduino Shields) +- in python scipts you'll need the mraa-Library to connect to GPIO's +- ... +modules directory. +The individual modules are presented below: + +# module-chassis and module-roboter-arm + +## Requirements + +- [platformio](http://docs.platformio.org/en/v0.6.0/installation.html) + +## Build + +Build&Upload +`python -m platformio run -t upload` # module-raspbi diff --git a/sw-modules/bluetooth-communication/master/.gitignore b/sw-modules/bluetooth-communication/master/.gitignore deleted file mode 100644 index 6a01030..0000000 --- a/sw-modules/bluetooth-communication/master/.gitignore +++ /dev/null @@ -1,5 +0,0 @@ -.pioenvs -.piolibdeps -.vscode/.browse.c_cpp.db* -.vscode/c_cpp_properties.json -.vscode/launch.json diff --git a/sw-modules/bluetooth-communication/master/.travis.yml b/sw-modules/bluetooth-communication/master/.travis.yml deleted file mode 100644 index 9443843..0000000 --- a/sw-modules/bluetooth-communication/master/.travis.yml +++ /dev/null @@ -1,67 +0,0 @@ -# Continuous Integration (CI) is the practice, in software -# engineering, of merging all developer working copies with a shared mainline -# several times a day < http://docs.platformio.org/page/ci/index.html > -# -# Documentation: -# -# * Travis CI Embedded Builds with PlatformIO -# < https://docs.travis-ci.com/user/integration/platformio/ > -# -# * PlatformIO integration with Travis CI -# < http://docs.platformio.org/page/ci/travis.html > -# -# * User Guide for `platformio ci` command -# < http://docs.platformio.org/page/userguide/cmd_ci.html > -# -# -# Please choice one of the following templates (proposed below) and uncomment -# it (remove "# " before each line) or use own configuration according to the -# Travis CI documentation (see above). -# - - -# -# Template #1: General project. Test it using existing `platformio.ini`. -# - -# language: python -# python: -# - "2.7" -# -# sudo: false -# cache: -# directories: -# - "~/.platformio" -# -# install: -# - pip install -U platformio -# - platformio update -# -# script: -# - platformio run - - -# -# Template #2: The project is intended to by used as a library with examples -# - -# language: python -# python: -# - "2.7" -# -# sudo: false -# cache: -# directories: -# - "~/.platformio" -# -# env: -# - PLATFORMIO_CI_SRC=path/to/test/file.c -# - PLATFORMIO_CI_SRC=examples/file.ino -# - PLATFORMIO_CI_SRC=path/to/test/directory -# -# install: -# - pip install -U platformio -# - platformio update -# -# script: -# - platformio ci --lib="." --board=ID_1 --board=ID_2 --board=ID_N diff --git a/sw-modules/bluetooth-communication/master/doc/pin_layout.jpg b/sw-modules/bluetooth-communication/master/doc/pin_layout.jpg deleted file mode 100644 index a0e188d..0000000 Binary files a/sw-modules/bluetooth-communication/master/doc/pin_layout.jpg and /dev/null differ diff --git a/sw-modules/bluetooth-communication/master/lib/readme.txt b/sw-modules/bluetooth-communication/master/lib/readme.txt deleted file mode 100644 index 131f1bf..0000000 --- a/sw-modules/bluetooth-communication/master/lib/readme.txt +++ /dev/null @@ -1,41 +0,0 @@ - -This directory is intended for the project specific (private) libraries. -PlatformIO will compile them to static libraries and link to executable file. - -The source code of each library should be placed in separate directory, like -"lib/private_lib/[here are source files]". - -For example, see how can be organized `Foo` and `Bar` libraries: - -|--lib -| | -| |--Bar -| | |--docs -| | |--examples -| | |--src -| | |- Bar.c -| | |- Bar.h -| | |- library.json (optional, custom build options, etc) http://docs.platformio.org/page/librarymanager/config.html -| | -| |--Foo -| | |- Foo.c -| | |- Foo.h -| | -| |- readme.txt --> THIS FILE -| -|- platformio.ini -|--src - |- main.c - -Then in `src/main.c` you should use: - -#include -#include - -// rest H/C/CPP code - -PlatformIO will find your libraries automatically, configure preprocessor's -include paths and build them. - -More information about PlatformIO Library Dependency Finder -- http://docs.platformio.org/page/librarymanager/ldf.html diff --git a/sw-modules/bluetooth-communication/master/platformio.ini b/sw-modules/bluetooth-communication/master/platformio.ini deleted file mode 100644 index 113e696..0000000 --- a/sw-modules/bluetooth-communication/master/platformio.ini +++ /dev/null @@ -1,29 +0,0 @@ -; PlatformIO Project Configuration File -; -; Build options: build flags, source filter -; Upload options: custom upload port, speed and extra flags -; Library options: dependencies, extra library storages -; Advanced options: extra scripting -; -; Please visit documentation for the other options and examples -; http://docs.platformio.org/page/projectconf.html - - -; PlatformIO Project Configuration File -; -; Build options: build flags, source filter -; Upload options: custom upload port, speed and extra flags -; Library options: dependencies, extra library storages -; Advanced options: extra scripting -; -; Please visit documentation for the other options and examples -; http://docs.platformio.org/page/projectconf.html - -[env:uno] -platform=atmelavr -board=uno -framework=arduino -lib_deps = SoftwareSerial - -[platformio] -src_dir=src diff --git a/sw-modules/bluetooth-communication/master/src/Master.ino b/sw-modules/bluetooth-communication/master/src/Master.ino deleted file mode 100644 index 058b834..0000000 --- a/sw-modules/bluetooth-communication/master/src/Master.ino +++ /dev/null @@ -1,24 +0,0 @@ -#include -#include - -#define BLUETOOTH_TX 2 -#define BLUETOOTH_RX 3 - -static SoftwareSerial bluetooth{BLUETOOTH_RX, BLUETOOTH_TX}; - -void setup() -{ - Serial.begin(9600); - bluetooth.begin(9600); - bluetooth.println("master ready!"); -} - -void loop() -{ - if (bluetooth.available()){ - String message = bluetooth.readStringUntil('\n'); - Serial.println(message); - } - bluetooth.println("message from master"); - delay(3000); -} diff --git a/sw-modules/bluetooth-communication/slave/.gitignore b/sw-modules/bluetooth-communication/slave/.gitignore deleted file mode 100644 index 6c69f4c..0000000 --- a/sw-modules/bluetooth-communication/slave/.gitignore +++ /dev/null @@ -1,2 +0,0 @@ -.pioenvs -.piolibdeps diff --git a/sw-modules/bluetooth-communication/slave/.travis.yml b/sw-modules/bluetooth-communication/slave/.travis.yml deleted file mode 100644 index 9443843..0000000 --- a/sw-modules/bluetooth-communication/slave/.travis.yml +++ /dev/null @@ -1,67 +0,0 @@ -# Continuous Integration (CI) is the practice, in software -# engineering, of merging all developer working copies with a shared mainline -# several times a day < http://docs.platformio.org/page/ci/index.html > -# -# Documentation: -# -# * Travis CI Embedded Builds with PlatformIO -# < https://docs.travis-ci.com/user/integration/platformio/ > -# -# * PlatformIO integration with Travis CI -# < http://docs.platformio.org/page/ci/travis.html > -# -# * User Guide for `platformio ci` command -# < http://docs.platformio.org/page/userguide/cmd_ci.html > -# -# -# Please choice one of the following templates (proposed below) and uncomment -# it (remove "# " before each line) or use own configuration according to the -# Travis CI documentation (see above). -# - - -# -# Template #1: General project. Test it using existing `platformio.ini`. -# - -# language: python -# python: -# - "2.7" -# -# sudo: false -# cache: -# directories: -# - "~/.platformio" -# -# install: -# - pip install -U platformio -# - platformio update -# -# script: -# - platformio run - - -# -# Template #2: The project is intended to by used as a library with examples -# - -# language: python -# python: -# - "2.7" -# -# sudo: false -# cache: -# directories: -# - "~/.platformio" -# -# env: -# - PLATFORMIO_CI_SRC=path/to/test/file.c -# - PLATFORMIO_CI_SRC=examples/file.ino -# - PLATFORMIO_CI_SRC=path/to/test/directory -# -# install: -# - pip install -U platformio -# - platformio update -# -# script: -# - platformio ci --lib="." --board=ID_1 --board=ID_2 --board=ID_N diff --git a/sw-modules/bluetooth-communication/slave/doc/pin_layout.jpg b/sw-modules/bluetooth-communication/slave/doc/pin_layout.jpg deleted file mode 100644 index a0e188d..0000000 Binary files a/sw-modules/bluetooth-communication/slave/doc/pin_layout.jpg and /dev/null differ diff --git a/sw-modules/bluetooth-communication/slave/lib/readme.txt b/sw-modules/bluetooth-communication/slave/lib/readme.txt deleted file mode 100644 index 131f1bf..0000000 --- a/sw-modules/bluetooth-communication/slave/lib/readme.txt +++ /dev/null @@ -1,41 +0,0 @@ - -This directory is intended for the project specific (private) libraries. -PlatformIO will compile them to static libraries and link to executable file. - -The source code of each library should be placed in separate directory, like -"lib/private_lib/[here are source files]". - -For example, see how can be organized `Foo` and `Bar` libraries: - -|--lib -| | -| |--Bar -| | |--docs -| | |--examples -| | |--src -| | |- Bar.c -| | |- Bar.h -| | |- library.json (optional, custom build options, etc) http://docs.platformio.org/page/librarymanager/config.html -| | -| |--Foo -| | |- Foo.c -| | |- Foo.h -| | -| |- readme.txt --> THIS FILE -| -|- platformio.ini -|--src - |- main.c - -Then in `src/main.c` you should use: - -#include -#include - -// rest H/C/CPP code - -PlatformIO will find your libraries automatically, configure preprocessor's -include paths and build them. - -More information about PlatformIO Library Dependency Finder -- http://docs.platformio.org/page/librarymanager/ldf.html diff --git a/sw-modules/bluetooth-communication/slave/platformio.ini b/sw-modules/bluetooth-communication/slave/platformio.ini deleted file mode 100644 index 113e696..0000000 --- a/sw-modules/bluetooth-communication/slave/platformio.ini +++ /dev/null @@ -1,29 +0,0 @@ -; PlatformIO Project Configuration File -; -; Build options: build flags, source filter -; Upload options: custom upload port, speed and extra flags -; Library options: dependencies, extra library storages -; Advanced options: extra scripting -; -; Please visit documentation for the other options and examples -; http://docs.platformio.org/page/projectconf.html - - -; PlatformIO Project Configuration File -; -; Build options: build flags, source filter -; Upload options: custom upload port, speed and extra flags -; Library options: dependencies, extra library storages -; Advanced options: extra scripting -; -; Please visit documentation for the other options and examples -; http://docs.platformio.org/page/projectconf.html - -[env:uno] -platform=atmelavr -board=uno -framework=arduino -lib_deps = SoftwareSerial - -[platformio] -src_dir=src diff --git a/sw-modules/bluetooth-communication/slave/src/Slave.ino b/sw-modules/bluetooth-communication/slave/src/Slave.ino deleted file mode 100644 index d194a0b..0000000 --- a/sw-modules/bluetooth-communication/slave/src/Slave.ino +++ /dev/null @@ -1,25 +0,0 @@ -#include -#include - -#define BLUETOOTH_TX 2 -#define BLUETOOTH_RX 3 - -static SoftwareSerial bluetooth{BLUETOOTH_RX, BLUETOOTH_TX}; - -void setup() -{ - Serial.begin(9600); - bluetooth.begin(9600); - bluetooth.println("slave ready!"); -} - -void loop() -{ - if (bluetooth.available()){ - - String message = bluetooth.readStringUntil('\n'); - Serial.println(message); - } - bluetooth.println("message from slave"); - delay(3000); -} diff --git a/sw-modules/module-chassis/.gitignore b/sw-modules/module-chassis/.gitignore deleted file mode 100644 index 03e9fdb..0000000 --- a/sw-modules/module-chassis/.gitignore +++ /dev/null @@ -1,11 +0,0 @@ -.pioenvs/** -.piolibdeps/** -.clang_complete/** -.gcc-flags.json -.vscode/** -.pioenvs -.piolibdeps -.vscode/.browse.c_cpp.db* -.vscode/c_cpp_properties.json -.vscode/launch.json -.clang_complete diff --git a/sw-modules/module-chassis/.travis.yml b/sw-modules/module-chassis/.travis.yml deleted file mode 100644 index 2c4ff5c..0000000 --- a/sw-modules/module-chassis/.travis.yml +++ /dev/null @@ -1,65 +0,0 @@ -# Continuous Integration (CI) is the practice, in software -# engineering, of merging all developer working copies with a shared mainline -# several times a day < http://docs.platformio.org/page/ci/index.html > -# -# Documentation: -# -# * Travis CI Embedded Builds with PlatformIO -# < https://docs.travis-ci.com/user/integration/platformio/ > -# -# * PlatformIO integration with Travis CI -# < http://docs.platformio.org/page/ci/travis.html > -# -# * User Guide for `platformio ci` command -# < http://docs.platformio.org/page/userguide/cmd_ci.html > -# -# -# Please choice one of the following templates (proposed below) and uncomment -# it (remove "# " before each line) or use own configuration according to the -# Travis CI documentation (see above). -# - - -# -# Template #1: General project. Test it using existing `platformio.ini`. -# - -# language: python -# python: -# - "2.7" -# -# sudo: false -# cache: -# directories: -# - "~/.platformio" -# -# install: -# - pip install -U platformio -# -# script: -# - platformio run - - -# -# Template #2: The project is intended to by used as a library with examples -# - -# language: python -# python: -# - "2.7" -# -# sudo: false -# cache: -# directories: -# - "~/.platformio" -# -# env: -# - PLATFORMIO_CI_SRC=path/to/test/file.c -# - PLATFORMIO_CI_SRC=examples/file.ino -# - PLATFORMIO_CI_SRC=path/to/test/directory -# -# install: -# - pip install -U platformio -# -# script: -# - platformio ci --lib="." --board=ID_1 --board=ID_2 --board=ID_N diff --git a/sw-modules/module-chassis/lib/readme.txt b/sw-modules/module-chassis/lib/readme.txt deleted file mode 100644 index de6daf5..0000000 --- a/sw-modules/module-chassis/lib/readme.txt +++ /dev/null @@ -1,42 +0,0 @@ - -This directory is intended for the project specific (private) libraries. -PlatformIO will compile them to static libraries and link to executable file. - -The source code of each library should be placed in separate directory, like -"lib/private_lib/[here are source files]". - -For example, see how can be organized `Foo` and `Bar` libraries: - -|--lib -| |--Bar -| | |--docs -| | |--examples -| | |--src -| | |- Bar.c -| | |- Bar.h -| |--Foo -| | |- Foo.c -| | |- Foo.h -| |- readme.txt --> THIS FILE -|- platformio.ini -|--src - |- main.c - -Then in `src/main.c` you should use: - -#include -#include - -// rest H/C/CPP code - -PlatformIO will find your libraries automatically, configure preprocessor's -include paths and build them. - -More information about PlatformIO Library Dependency Finder -- http://docs.platformio.org/page/librarymanager/ldf.html - -Include submodule: -git submodule add {reponame} -https://github.com/HSRLCLab/modular.git - -git config push.recurseSubmodule on-demand diff --git a/sw-modules/module-chassis/src/Action.h b/sw-modules/module-chassis/src/Action.h deleted file mode 100644 index 51cb8ce..0000000 --- a/sw-modules/module-chassis/src/Action.h +++ /dev/null @@ -1,7 +0,0 @@ -#pragma once - -class Action -{ -public: - virtual void start(int params) = 0; -}; diff --git a/sw-modules/module-chassis/src/Config.h b/sw-modules/module-chassis/src/Config.h deleted file mode 100644 index aa92fcf..0000000 --- a/sw-modules/module-chassis/src/Config.h +++ /dev/null @@ -1,11 +0,0 @@ -#pragma once - -#define RFIDDETECTOR_SDA 7 -#define RFIDDETECTOR_RST_PIN 6 -#define CHASSIS_DIGITAL_TRIG_PIN 4 -#define CHASSIS_DIGITAL_ECHO_PIN 5 -#define MOTOR_NR 4 -#define CHASIS_POS_MAX 60 -#define NofActions 3 -#define NofSensors 2 -#define RFID_LENGTH 7 diff --git a/sw-modules/module-chassis/src/Distance.h b/sw-modules/module-chassis/src/Distance.h deleted file mode 100644 index 238fbee..0000000 --- a/sw-modules/module-chassis/src/Distance.h +++ /dev/null @@ -1,19 +0,0 @@ -#pragma once - -#include -#include -#include - -class Distance : public Sensor -{ -public: - Distance(NewPing *sensor) : sensor{sensor} {} - Stream &get(Stream &obj) - { - obj << String(sensor->ping_cm()); - return obj; - } - -private: - NewPing *sensor; -}; diff --git a/sw-modules/module-chassis/src/Motor.h b/sw-modules/module-chassis/src/Motor.h deleted file mode 100644 index 6ae0bcf..0000000 --- a/sw-modules/module-chassis/src/Motor.h +++ /dev/null @@ -1,26 +0,0 @@ -#pragma once - -#include -#include - -class Motor : public Action -{ -public: - Motor(Adafruit_DCMotor *motor, byte direction) : motor{motor}, direction{direction} - { - } - - void start(int speed) - { - if (speed == 0) - { - motor->run(RELEASE); - } - motor->run(direction); - motor->setSpeed(speed); - } - -private: - Adafruit_DCMotor *motor; - byte direction; -}; diff --git a/sw-modules/module-chassis/src/RfidDetector.h b/sw-modules/module-chassis/src/RfidDetector.h deleted file mode 100644 index e7d0837..0000000 --- a/sw-modules/module-chassis/src/RfidDetector.h +++ /dev/null @@ -1,26 +0,0 @@ -#pragma once - -#include -#include - -class RfidDetector : public Sensor -{ -public: - RfidDetector(MFRC522 *rfidReader) : rfidReader{rfidReader} {} - - Stream &get(Stream &obj) - { - if (rfidReader->PICC_IsNewCardPresent() && rfidReader->PICC_ReadCardSerial() && rfidReader->uid.size != 0) - { - for (auto index = 0; index < RFID_LENGTH; index++) - { - obj << rfidReader->uid.uidByte[index]; - } - } - - return obj; - } - -private: - MFRC522 *rfidReader; -}; diff --git a/sw-modules/module-chassis/src/Sensor.h b/sw-modules/module-chassis/src/Sensor.h deleted file mode 100644 index 5cfffaa..0000000 --- a/sw-modules/module-chassis/src/Sensor.h +++ /dev/null @@ -1,16 +0,0 @@ -#pragma once - -#include - -template -inline Stream &operator<<(Stream &obj, T arg) -{ - obj.print(arg); - return obj; -} - -class Sensor -{ -public: - virtual Stream &get(Stream &obj) = 0; -}; diff --git a/sw-modules/module-chassis/src/Sortic.ino b/sw-modules/module-chassis/src/Sortic.ino deleted file mode 100644 index bd12636..0000000 --- a/sw-modules/module-chassis/src/Sortic.ino +++ /dev/null @@ -1,44 +0,0 @@ -#include -#include -#include - -#include "Action.h" -#include "Sensor.h" -#include "Config.h" -#include "Distance.h" -#include "Motor.h" -#include "RfidDetector.h" - -static Adafruit_MotorShield currentMotorShield{}; -static Adafruit_DCMotor *driverMotor = currentMotorShield.getMotor(MOTOR_NR); -static MFRC522 partDetector{RFIDDETECTOR_SDA, RFIDDETECTOR_RST_PIN}; -static NewPing *newPing = new NewPing{CHASSIS_DIGITAL_TRIG_PIN, CHASSIS_DIGITAL_ECHO_PIN, CHASIS_POS_MAX}; - -static Sensor *sensors[NofSensors]{ - new RfidDetector{&partDetector}, - new Distance{newPing}}; -static Action *actions[NofActions]{ - new Motor{driverMotor, FORWARD}, - new Motor{driverMotor, BACKWARD}}; - -void setup() -{ - Serial.begin(9600); - currentMotorShield.begin(); - SPI.begin(); - partDetector.PCD_Init(); -} - -void loop() -{ - if (Serial.available()) - { - Action *action = actions[Serial.parseInt()]; - action->start(Serial.parseInt()); - } - Serial << '['; - for (auto index = 0; index < NofSensors; index++) - { - sensors[index]->get(Serial) << (index == NofSensors - 1 ? ']' : ','); - } -} diff --git a/sw-modules/module-iot2050/node-red.json b/sw-modules/module-iot2050/node-red.json new file mode 100644 index 0000000..dd78bf7 --- /dev/null +++ b/sw-modules/module-iot2050/node-red.json @@ -0,0 +1 @@ +[{"id":"cb4b202.e621f6","type":"tab","label":"IOT2050","disabled":false,"info":""},{"id":"af7f3b2f.adcdf8","type":"mraa-gpio-led","z":"cb4b202.e621f6","name":"ledred","pin":"4","x":590,"y":500,"wires":[]},{"id":"5702a42f.297164","type":"mqtt in","z":"cb4b202.e621f6","name":"","topic":"rfid/package","qos":"2","datatype":"auto","broker":"bcd06034.e998","x":170,"y":340,"wires":[["fda3de4b.897198","6bf9cf8b.f79188","2190c0b1.a9973"]]},{"id":"2190c0b1.a9973","type":"debug","z":"cb4b202.e621f6","name":"","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"payload","targetType":"msg","x":610,"y":340,"wires":[]},{"id":"b30a429c.68647","type":"mqtt out","z":"cb4b202.e621f6","name":"","topic":"rfid/package","qos":"1","retain":"false","broker":"bcd06034.e998","x":610,"y":220,"wires":[]},{"id":"d866d71b.cc8a9","type":"inject","z":"cb4b202.e621f6","name":"","topic":"","payload":"1","payloadType":"str","repeat":"","crontab":"","once":false,"onceDelay":0.1,"x":170,"y":200,"wires":[["b30a429c.68647"]]},{"id":"eb673545.e8e7f","type":"inject","z":"cb4b202.e621f6","name":"","topic":"","payload":"2","payloadType":"str","repeat":"","crontab":"","once":false,"onceDelay":0.1,"x":170,"y":240,"wires":[["b30a429c.68647"]]},{"id":"91a44a89.a42c38","type":"inject","z":"cb4b202.e621f6","name":"","topic":"","payload":"3","payloadType":"str","repeat":"","crontab":"","once":false,"onceDelay":0.1,"x":170,"y":280,"wires":[["b30a429c.68647"]]},{"id":"4c87728.4cdc80c","type":"mraa-gpio-led","z":"cb4b202.e621f6","name":"ledorange","pin":"5","x":600,"y":460,"wires":[]},{"id":"267d0b39.d5cb54","type":"mraa-gpio-led","z":"cb4b202.e621f6","name":"ledgreen","pin":"0","x":600,"y":420,"wires":[]},{"id":"c0b4b99e.4b5668","type":"function","z":"cb4b202.e621f6","name":"is1","func":"if(msg.payload === \"1\"){\n msg.payload = true;\n}\nelse {\n msg.payload = false;\n}\nreturn msg; ","outputs":1,"noerr":0,"x":430,"y":420,"wires":[["267d0b39.d5cb54"]]},{"id":"fda3de4b.897198","type":"delay","z":"cb4b202.e621f6","name":"","pauseType":"delay","timeout":"500","timeoutUnits":"milliseconds","rate":"1","nbRateUnits":"1","rateUnits":"second","randomFirst":"1","randomLast":"5","randomUnits":"seconds","drop":false,"x":240,"y":460,"wires":[["c0b4b99e.4b5668","76541856.d34728","2812b795.ca1288"]]},{"id":"6bf9cf8b.f79188","type":"function","z":"cb4b202.e621f6","name":"false","func":"msg.payload = false;\nreturn msg;","outputs":1,"noerr":0,"x":430,"y":380,"wires":[["267d0b39.d5cb54","4c87728.4cdc80c","af7f3b2f.adcdf8"]]},{"id":"9748d002.47732","type":"debug","z":"cb4b202.e621f6","name":"","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"true","targetType":"full","x":690,"y":760,"wires":[]},{"id":"c8d48d9e.2d3ce","type":"OpcUa-Item","z":"cb4b202.e621f6","item":"ns=3;s=\"Data_Block_1\".\"istPos\"","datatype":"Int16","value":"","name":"istPos","x":270,"y":760,"wires":[["378f51a3.243afe"]]},{"id":"632f6edb.2a65b","type":"OpcUa-Item","z":"cb4b202.e621f6","item":"ns=3;s=\"Data_Block_1\".\"sollPos\"","datatype":"Int16","value":"","name":"sollPos","x":280,"y":800,"wires":[["378f51a3.243afe"]]},{"id":"76541856.d34728","type":"function","z":"cb4b202.e621f6","name":"is2","func":"if(msg.payload === \"2\"){\n msg.payload = true;\n}\nelse {\n msg.payload = false;\n}\nreturn msg; ","outputs":1,"noerr":0,"x":430,"y":460,"wires":[["4c87728.4cdc80c"]]},{"id":"2812b795.ca1288","type":"function","z":"cb4b202.e621f6","name":"is3","func":"if(msg.payload === \"3\"){\n msg.payload = true;\n}\nelse {\n msg.payload = false;\n}\nreturn msg; ","outputs":1,"noerr":0,"x":430,"y":500,"wires":[["af7f3b2f.adcdf8"]]},{"id":"5559382c.831cf","type":"comment","z":"cb4b202.e621f6","name":"es müssen alle LED's gelöscht werden, bevor einzelne wieder angehen...","info":"","x":350,"y":160,"wires":[]},{"id":"1ed8b207.8b4c3e","type":"comment","z":"cb4b202.e621f6","name":"Test MQTT und LEDs","info":"","x":200,"y":120,"wires":[]},{"id":"e9e61324.d5b68","type":"comment","z":"cb4b202.e621f6","name":"Versuch OPCua SPS","info":"","x":120,"y":560,"wires":[]},{"id":"1e02af1b.50d4e9","type":"inject","z":"cb4b202.e621f6","name":"","topic":"","payload":"true","payloadType":"bool","repeat":"","crontab":"","once":false,"onceDelay":0.1,"x":90,"y":760,"wires":[["c8d48d9e.2d3ce","632f6edb.2a65b"]]},{"id":"378f51a3.243afe","type":"OpcUa-Client","z":"cb4b202.e621f6","endpoint":"85a68a30.06e8d","action":"write","deadbandtype":"a","deadbandvalue":1,"time":10,"timeUnit":"s","certificate":"n","localfile":"","localkeyfile":"","securitymode":"None","securitypolicy":"None","name":"","x":500,"y":760,"wires":[["9748d002.47732"]]},{"id":"a0872110.82af08","type":"OpcUa-Client","z":"cb4b202.e621f6","endpoint":"85a68a30.06e8d","action":"read","deadbandtype":"a","deadbandvalue":1,"time":10,"timeUnit":"s","certificate":"n","localfile":"","localkeyfile":"","securitymode":"None","securitypolicy":"None","name":"","x":300,"y":640,"wires":[["fe103b05.8bb75","b6054890.d5938"]]},{"id":"fe103b05.8bb75","type":"OpcUa-Item","z":"cb4b202.e621f6","item":"ns=3;s=\"Data_Block_1\".\"istPos\"","datatype":"Int16","value":"","name":"istPos","x":470,"y":640,"wires":[["b6957c76.7f5a58"]]},{"id":"b6054890.d5938","type":"OpcUa-Item","z":"cb4b202.e621f6","item":"ns=3;s=\"Data_Block_1\".\"sollPos\"","datatype":"Int16","value":"","name":"sollPos","x":480,"y":680,"wires":[["b6957c76.7f5a58"]]},{"id":"3dd5546d.8b465c","type":"inject","z":"cb4b202.e621f6","name":"","topic":"","payload":"true","payloadType":"bool","repeat":"","crontab":"","once":false,"onceDelay":0.1,"x":90,"y":640,"wires":[["a0872110.82af08"]]},{"id":"b6957c76.7f5a58","type":"debug","z":"cb4b202.e621f6","name":"","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"true","targetType":"full","x":690,"y":640,"wires":[]},{"id":"3acee9b2.ae172e","type":"rpi-srf","z":"cb4b202.e621f6","name":"","topic":"SRF","pulse":"1","pins":"13,11","x":150,"y":60,"wires":[["97736338.d9d31","b7ea156e.afeb28"]]},{"id":"539606f8.22efd","type":"s7comm write","z":"cb4b202.e621f6","connection":"35dc00ec.0edd38","payload":"{\"S7_Type\":\"DB\",\"S7_DBnum\":\"100\",\"S7_Datatype\":\"uint16\",\"S7_Offset\":\"6\",\"S7_BitOffset\":\"0\",\"S7_Quantity\":\"1\",\"S7_Name\":\"distanz\"}","s7Name":"distanz","topic":"","name":"","signalSetted":false,"x":620,"y":60,"wires":[[]]},{"id":"97736338.d9d31","type":"debug","z":"cb4b202.e621f6","name":"","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"true","targetType":"full","x":590,"y":100,"wires":[]},{"id":"b7ea156e.afeb28","type":"function","z":"cb4b202.e621f6","name":"wrap JSON","func":"var object = {\n \"value\":[msg.payload]\n }\n \nmsg.payload = Object.assign({}, object); \n\nreturn msg;","outputs":1,"noerr":0,"x":350,"y":60,"wires":[["97736338.d9d31","539606f8.22efd"]]},{"id":"bcd06034.e998","type":"mqtt-broker","z":"","name":"Sortic Server","broker":"192.168.0.11","port":"1883","clientid":"","usetls":false,"compatmode":false,"keepalive":"60","cleansession":true,"birthTopic":"","birthQos":"0","birthPayload":"","closeTopic":"","closeQos":"0","closePayload":"","willTopic":"","willQos":"0","willPayload":""},{"id":"85a68a30.06e8d","type":"OpcUa-Endpoint","z":"","endpoint":"opc.tcp://192.168.0.100:4840","secpol":"None","secmode":"None","login":false},{"id":"35dc00ec.0edd38","type":"s7comm","z":"","ip":"192.168.0.100","port":"102","rack":"0","slot":"1","payload":[{"S7_Type":"DB","S7_DBnum":"100","S7_Datatype":"X","S7_Offset":"0","S7_BitOffset":"0","S7_Quantity":"1","S7_Name":"done"},{"S7_Type":"DB","S7_DBnum":"100","S7_Datatype":"uint16","S7_Offset":"2","S7_BitOffset":"0","S7_Quantity":"1","S7_Name":"sollPos"},{"S7_Type":"DB","S7_DBnum":"100","S7_Datatype":"uint16","S7_Offset":"4","S7_BitOffset":"0","S7_Quantity":"1","S7_Name":"istPos"},{"S7_Type":"DB","S7_DBnum":"100","S7_Datatype":"uint16","S7_Offset":"6","S7_BitOffset":"0","S7_Quantity":"1","S7_Name":"distanz"}]}] \ No newline at end of file diff --git a/sw-modules/module-package-reader/.gitignore b/sw-modules/module-package-reader/.gitignore new file mode 100644 index 0000000..e6bddc6 --- /dev/null +++ b/sw-modules/module-package-reader/.gitignore @@ -0,0 +1,3 @@ +.pio +.vscode/ +*.db \ No newline at end of file diff --git a/sw-modules/module-package-reader/LICENSE b/sw-modules/module-package-reader/LICENSE new file mode 100644 index 0000000..fa9cbab --- /dev/null +++ b/sw-modules/module-package-reader/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2019 LMazzole + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/sw-modules/module-package-reader/README.md b/sw-modules/module-package-reader/README.md new file mode 100644 index 0000000..2be638c --- /dev/null +++ b/sw-modules/module-package-reader/README.md @@ -0,0 +1,216 @@ +# SmartFactory_MQTTCommunication + +The SmartFactroy_MQTTCommunication is an modular part of the SmartFactory project. +MQTTCommunication establishes a WLAN-connection and allows you to connect +with an MQTT-Broker to send and receive message. +Incomming messages need to be in a known JSON-format and will be converted into a struct. +These messages-structs are stored in a circular-buffer. + + + +## Table of contents + + +- [The SmartFactory project](#the-smartfactory-project) +- [Tools and technologies](#tools-and-technologies) + - [Doxygen](#doxygen) + - [VSCode PlatformIO](#vscode-platformio) + - [MQTT](#mqtt) + - [Circular buffer](#circular-buffer) +- [Documentation](#documentation) + - [Hardware](#hardware) + - [Software](#software) + - [Dependency graph](#dependency-graph) + - [Collaboration diagram](#collaboration-diagram) + - [Important functions and files](#important-functions-and-files) + - [MQTTCommunication.h](#mqttcommunicationh) + - [CommunicationConfiguration.h](#communicationconfigurationh) + - [myJSONStr.h](#myjsonstrh) +- [FAQ's](#faqs) + - [I'd like to use this code in my project. What do I need to know?](#id-like-to-use-this-code-in-my-project-what-do-i-need-to-know) + - [Where can I change the configurations like MQTT-Broker IP and WLAN-Credentials?](#where-can-i-change-the-configurations-like-mqtt-broker-ip-and-wlan-credentials) + - [I'd like to change the incoming JSON-Message. How can I do that?](#id-like-to-change-the-incoming-json-message-how-can-i-do-that) +- [ToDo's](#todos) +- [Contributors](#contributors) +- [Changelog](#changelog) +- [License](#license) + + +
+ +## The SmartFactory project + +[SmartFactory_MQTTCommunication](https://github.com/LMazzole/SmartFactory_MQTTCommunication) is part of the SmartFactory-project. It provides a library with basic MQTT-Communication functions. + +Other SmartFactory-components are: +* [SmartFactory_Box-Sortic]() + +A possible implementation of the SmartFactory-project can be seen in the Sortic-showcase: + +

+ +The associated repositorys are: + [SmartFactory-Sortic](https://github.com/LMazzole/SmartFactory-Sortic) + [SmartFactory_Box-Sortic](https://github.com/LMazzole/SmartFactory_Box-Sortic) + [SmartFactory_Vehicle-Sortic](https://github.com/LMazzole/SmartFactory_Vehicle-Sortic) + [SmartFactory_Vehicle-Basis](https://github.com/LMazzole/SmartFactory_Vehicle-Basis) + [SmartFactory_MQTTCommunication](https://github.com/LMazzole/SmartFactory_MQTTCommunication) + +
+ +## Tools and technologies + +The Source-code is written in C++. +To achieve this project, the following tools and technologies were used. + +### Doxygen +Doxygen is used for the documentation of the source code. +An intorduction to *Doxygen* and how to install it can be found in the [ArdFSM-Repo](https://github.com/LMazzole/ArdFSM#documentation-with-doxygen). + +### VSCode PlatformIO +The used IDE is [VSCode](https://code.visualstudio.com/) with the [PlatformIO](https://platformio.org/platformio-ide)-extension. + +### MQTT +MQTT (Message Queuing Telemetry Transport) is a lightweight publish-subscribe messaging protocol and requires a broker to relay the messages. It's used for M2M (machine-to-machine) communication. +An MQTT-system always consist of a broker and one or multiple clients, which can be either subscriber or publisher. + +

+ +[Image: [MQTT101 - Eclispe Foundation]()] + +A client can subscribe and publish to one or multiple topics. Topics are organized in a tree similar to a folder-structure in Windows. Here's an example of how such a topic-tree and published message can look like: + +

+ +This images also illustrates the scalability of MQTT appropriately. +For more Infos about MQTT and MQTT-topics check out the MQTT-Wiki on [Github](https://github.com/mqtt/mqtt.github.io/wiki). +[Source: [Wiki:MQTT](https://en.wikipedia.org/wiki/MQTT), [MQTT](https://mqtt.org/) ] + +
+ +### Circular buffer +A circular buffer or a ring-buffer uses an buffer with fixed Size. If the buffer is full the oldest element gets overwritten. + +

+ + + +

+ +[Image: [Wiki: Circular buffer](https://en.wikipedia.org/wiki/Circular_buffer)] + +
+ +# Documentation +## Hardware +This code needs a WLAN-shield to function properly. +It's tested with a [Adafruit Feather M0 WiFi - ATSAMD21 + ATWINC1500](https://www.adafruit.com/product/3010) from Adafruit. + +## Software +All functions and files are documented on the [GitHub-Page with Doxygen](https://lmazzole.github.io/SmartFactory_MQTTCommunication/) + +### Dependency graph + +

+ + + +

Click on the image to open doxygen-documentation.

+

+ +External libraries: +* [PubSubClient](https://pubsubclient.knolleary.net/) +* [WiFi101](https://www.arduino.cc/en/Reference/WiFi101) +* [ArduinoJson](https://arduinojson.org/) +* [CircularBuffer](https://github.com/rlogiacco/CircularBuffer) + +### Collaboration diagram + +

+ + + +

Click on the image to open doxygen-documentation.

+

+ +
+ +### Important functions and files + +#### MQTTCommunication.h +The *MQTTCommunication.h*-file serves as interface. +It provides the functions for: +* Network-connection +* MQTT-functionalities +* access the message-storage (circular buffer) + +#### CommunicationConfiguration.h +In the *CommunicationConfiguration.h*-file are all important settings defined: +* WLAN SSID +* WLAN password +* WLAN Shield pins +* MQTT Broker IP +* JSON parse size +* Cirrcular Buffer size + +#### myJSONStr.h +In the *myJSONStr.h*-file is defined how the JSON-message and hence the struct looks like. + +This is how the JSON-message (received as String) can look like: +``` javascript +{ + "id": "hostname", + "topic": "topic/topic", + "status": "driving", + "sector": "transit", + "line": 1, + "ack":"hostname", + "req":"hostname", + "cargo":"beer", + "token":false; + "error":false +} +``` +And the corresponding struct in which the message gets parsed: +``` cpp +struct myJSONStr { + String id = "hostname"; + String topic = "topic/topic"; + String status = "driving"; + String sector = "transit"; + int line = 1; + String ack = "hostname"; + String req = "hostname"; + String cargo = "beer"; + bool token = false; + bool error = false; +}; +``` + +
+ +# FAQ's +#### I'd like to use this code in my project. What do I need to know? +> All you need to do is add the GitHub-Link to this Repo under *lib_deps* in your platformio.ini File and you're set up. All dependencies are downloaded automatic. + +#### Where can I change the configurations like MQTT-Broker IP and WLAN-Credentials? +> All the Configuration data is stored in the *CommunicationConfiguration.h* file and can be edited there. + +#### I'd like to change the incoming JSON-Message. How can I do that? +> Incoming messages need to be in a know JSON-Format which is defined in* myJSONStr.h* and needs to match the implementation in *myJSON::parsingJSONToStruct*. If you would like to change this format you need to adapt both files. + + +# ToDo's +The open ToDo's can be found in the Documentation on the [GitHub-Page](https://lmazzole.github.io/SmartFactory_MQTTCommunication/todo.html) +- [ ] Split the code in 2 repos: MQTTCommunication-Sortic and MQTTCommunication in order to increase reusability. + +# Contributors +- [Luca Mazzoleni](https://github.com/LMazzole) +- Luciano Bettinaglio + +# Changelog +V 1.0 - Release BA FS19 - [Luca Mazzoleni](https://github.com/LMazzole) + +# License + +MIT License diff --git a/sw-modules/module-package-reader/docs/.nojekyll b/sw-modules/module-package-reader/docs/.nojekyll new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/sw-modules/module-package-reader/docs/.nojekyll @@ -0,0 +1 @@ + diff --git a/sw-modules/module-package-reader/docs/Circular_Buffer_Animation.gif b/sw-modules/module-package-reader/docs/Circular_Buffer_Animation.gif new file mode 100644 index 0000000..8ffda04 Binary files /dev/null and b/sw-modules/module-package-reader/docs/Circular_Buffer_Animation.gif differ diff --git a/sw-modules/module-package-reader/docs/MQTTPublishSubscribe.png b/sw-modules/module-package-reader/docs/MQTTPublishSubscribe.png new file mode 100644 index 0000000..760ea93 Binary files /dev/null and b/sw-modules/module-package-reader/docs/MQTTPublishSubscribe.png differ diff --git a/sw-modules/module-package-reader/docs/MQTTTopics.png b/sw-modules/module-package-reader/docs/MQTTTopics.png new file mode 100644 index 0000000..9fe1d44 Binary files /dev/null and b/sw-modules/module-package-reader/docs/MQTTTopics.png differ diff --git a/sw-modules/module-package-reader/docs/RepoOverview.png b/sw-modules/module-package-reader/docs/RepoOverview.png new file mode 100644 index 0000000..63b7de0 Binary files /dev/null and b/sw-modules/module-package-reader/docs/RepoOverview.png differ diff --git a/sw-modules/module-package-reader/docs/_communication_configuration_8h.html b/sw-modules/module-package-reader/docs/_communication_configuration_8h.html new file mode 100644 index 0000000..c1ff9e5 --- /dev/null +++ b/sw-modules/module-package-reader/docs/_communication_configuration_8h.html @@ -0,0 +1,411 @@ + + + + + + + +MQTT Communication: CommunicationConfiguration.h File Reference + + + + + + + + + + + + + + +
+
+ + + + + + +
+
MQTT Communication +
+
Smart Factory
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Macros
+
+
CommunicationConfiguration.h File Reference
+
+
+ +

file that contains the default communication configuration +More...

+
+This graph shows which files directly or indirectly include this file:
+
+
+ + + + + +
+
+

Go to the source code of this file.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Macros

#define DEFAULT_WIFI_SSID   "DigitalLab"
 SSID to connect to. More...
 
#define DEFAULT_WIFI_PASSWORD   "digital42HSR"
 Password to corresponding SSID. More...
 
#define DEFAULT_WIFI_CS   8
 Chipselct pin. More...
 
#define DEFAULT_WIFI_IRQ   7
 Interrupt pin. More...
 
#define DEFAULT_WIFI_RST   4
 Reset pin. More...
 
#define DEFAULT_WIFI_EN   2
 Enable pin. More...
 
#define DEFAULT_MQTT_BROKER_IP1   192
 broker IP distributed in 4 values More...
 
#define DEFAULT_MQTT_BROKER_IP2   168
 broker IP distributed in 4 values More...
 
#define DEFAULT_MQTT_BROKER_IP3   1
 broker IP distributed in 4 values More...
 
#define DEFAULT_MQTT_BROKER_IP4   22
 broker IP distributed in 4 values More...
 
#define DEFAULT_MQTT_PORT   1883
 MQTT connection port. More...
 
#define MAX_JSON_PARSE_SIZE   300
 max buffer size to parse JSON objects, size of the pool in bytes, can be calculated in https://arduinojson.org/v5/assistant/ More...
 
#define MAX_JSON_MESSAGES_SAVED   20
 max num of saved JSON items, must be smaller than num of vehicles! More...
 
+

Detailed Description

+

file that contains the default communication configuration

+
Author
Luca Mazzoleni (luca..nosp@m.mazz.nosp@m.oleni.nosp@m.@hsr.nosp@m..ch)
+
Version
1.0 - BA FS19 - Luca Mazzoleni (luca..nosp@m.mazz.nosp@m.oleni.nosp@m.@hsr.nosp@m..ch) - 03.06.2019
+
Date
2019-03-07
+
Copyright
Copyright (c) 2019
+
Todo:
Switch Password to .ini file
+https://community.platformio.org/t/how-to-specify-ota-upload-password-outside-platformio-ini/3588
+http://docs.platformio.org/en/latest/envvars.html#building
+ +

Definition in file CommunicationConfiguration.h.

+

Macro Definition Documentation

+ +

◆ DEFAULT_MQTT_BROKER_IP1

+ +
+
+ + + + +
#define DEFAULT_MQTT_BROKER_IP1   192
+
+ +

broker IP distributed in 4 values

+ +

Definition at line 34 of file CommunicationConfiguration.h.

+ +
+
+ +

◆ DEFAULT_MQTT_BROKER_IP2

+ +
+
+ + + + +
#define DEFAULT_MQTT_BROKER_IP2   168
+
+ +

broker IP distributed in 4 values

+ +

Definition at line 35 of file CommunicationConfiguration.h.

+ +
+
+ +

◆ DEFAULT_MQTT_BROKER_IP3

+ +
+
+ + + + +
#define DEFAULT_MQTT_BROKER_IP3   1
+
+ +

broker IP distributed in 4 values

+ +

Definition at line 36 of file CommunicationConfiguration.h.

+ +
+
+ +

◆ DEFAULT_MQTT_BROKER_IP4

+ +
+
+ + + + +
#define DEFAULT_MQTT_BROKER_IP4   22
+
+ +

broker IP distributed in 4 values

+ +

Definition at line 37 of file CommunicationConfiguration.h.

+ +
+
+ +

◆ DEFAULT_MQTT_PORT

+ +
+
+ + + + +
#define DEFAULT_MQTT_PORT   1883
+
+ +

MQTT connection port.

+ +

Definition at line 38 of file CommunicationConfiguration.h.

+ +
+
+ +

◆ DEFAULT_WIFI_CS

+ +
+
+ + + + +
#define DEFAULT_WIFI_CS   8
+
+ +

Chipselct pin.

+ +

Definition at line 27 of file CommunicationConfiguration.h.

+ +
+
+ +

◆ DEFAULT_WIFI_EN

+ +
+
+ + + + +
#define DEFAULT_WIFI_EN   2
+
+ +

Enable pin.

+ +

Definition at line 30 of file CommunicationConfiguration.h.

+ +
+
+ +

◆ DEFAULT_WIFI_IRQ

+ +
+
+ + + + +
#define DEFAULT_WIFI_IRQ   7
+
+ +

Interrupt pin.

+ +

Definition at line 28 of file CommunicationConfiguration.h.

+ +
+
+ +

◆ DEFAULT_WIFI_PASSWORD

+ +
+
+ + + + +
#define DEFAULT_WIFI_PASSWORD   "digital42HSR"
+
+ +

Password to corresponding SSID.

+ +

Definition at line 24 of file CommunicationConfiguration.h.

+ +
+
+ +

◆ DEFAULT_WIFI_RST

+ +
+
+ + + + +
#define DEFAULT_WIFI_RST   4
+
+ +

Reset pin.

+ +

Definition at line 29 of file CommunicationConfiguration.h.

+ +
+
+ +

◆ DEFAULT_WIFI_SSID

+ +
+
+ + + + +
#define DEFAULT_WIFI_SSID   "DigitalLab"
+
+ +

SSID to connect to.

+ +

Definition at line 23 of file CommunicationConfiguration.h.

+ +
+
+ +

◆ MAX_JSON_MESSAGES_SAVED

+ +
+
+ + + + +
#define MAX_JSON_MESSAGES_SAVED   20
+
+ +

max num of saved JSON items, must be smaller than num of vehicles!

+ +

Definition at line 42 of file CommunicationConfiguration.h.

+ +
+
+ +

◆ MAX_JSON_PARSE_SIZE

+ +
+
+ + + + +
#define MAX_JSON_PARSE_SIZE   300
+
+ +

max buffer size to parse JSON objects, size of the pool in bytes, can be calculated in https://arduinojson.org/v5/assistant/

+ +

Definition at line 41 of file CommunicationConfiguration.h.

+ +
+
+
+
+ + + + diff --git a/sw-modules/module-package-reader/docs/_communication_configuration_8h.js b/sw-modules/module-package-reader/docs/_communication_configuration_8h.js new file mode 100644 index 0000000..bc11cae --- /dev/null +++ b/sw-modules/module-package-reader/docs/_communication_configuration_8h.js @@ -0,0 +1,16 @@ +var _communication_configuration_8h = +[ + [ "DEFAULT_MQTT_BROKER_IP1", "_communication_configuration_8h.html#a5d22797e1aecb523d51e001e4b18bfcd", null ], + [ "DEFAULT_MQTT_BROKER_IP2", "_communication_configuration_8h.html#a3d7bfc12d81b39f60b4c466d73b0f9bd", null ], + [ "DEFAULT_MQTT_BROKER_IP3", "_communication_configuration_8h.html#a5bef8a41df9bae6c18ba9a7cbe7334b1", null ], + [ "DEFAULT_MQTT_BROKER_IP4", "_communication_configuration_8h.html#acd98270e14f470dde211dbf10ab236d5", null ], + [ "DEFAULT_MQTT_PORT", "_communication_configuration_8h.html#a01342056d524ed0b20f9e0ccc800d1db", null ], + [ "DEFAULT_WIFI_CS", "_communication_configuration_8h.html#a3975cc64a3caa3ee968344f9ac96de46", null ], + [ "DEFAULT_WIFI_EN", "_communication_configuration_8h.html#a2c1b2ad8f5142dd54d142524127844ce", null ], + [ "DEFAULT_WIFI_IRQ", "_communication_configuration_8h.html#a2d6cfb023346bcee1140b5579e96133e", null ], + [ "DEFAULT_WIFI_PASSWORD", "_communication_configuration_8h.html#a151690ecdd7d2c7b69586e6df164676c", null ], + [ "DEFAULT_WIFI_RST", "_communication_configuration_8h.html#a8849f0b55abf9c367def4f2e2faad104", null ], + [ "DEFAULT_WIFI_SSID", "_communication_configuration_8h.html#a7ea92631acc3bc41ae5eadc069323267", null ], + [ "MAX_JSON_MESSAGES_SAVED", "_communication_configuration_8h.html#acf4afb55aa7d1288ad9dffc623360a8c", null ], + [ "MAX_JSON_PARSE_SIZE", "_communication_configuration_8h.html#a268cecf8b27e3323864627d776dee31d", null ] +]; \ No newline at end of file diff --git a/sw-modules/module-package-reader/docs/_communication_configuration_8h__dep__incl.map b/sw-modules/module-package-reader/docs/_communication_configuration_8h__dep__incl.map new file mode 100644 index 0000000..63ba34d --- /dev/null +++ b/sw-modules/module-package-reader/docs/_communication_configuration_8h__dep__incl.map @@ -0,0 +1,5 @@ + + + + + diff --git a/sw-modules/module-package-reader/docs/_communication_configuration_8h__dep__incl.md5 b/sw-modules/module-package-reader/docs/_communication_configuration_8h__dep__incl.md5 new file mode 100644 index 0000000..ead4a05 --- /dev/null +++ b/sw-modules/module-package-reader/docs/_communication_configuration_8h__dep__incl.md5 @@ -0,0 +1 @@ +de681a405cc36a9852715af3808c9003 \ No newline at end of file diff --git a/sw-modules/module-package-reader/docs/_communication_configuration_8h__dep__incl.png b/sw-modules/module-package-reader/docs/_communication_configuration_8h__dep__incl.png new file mode 100644 index 0000000..5ebee42 Binary files /dev/null and b/sw-modules/module-package-reader/docs/_communication_configuration_8h__dep__incl.png differ diff --git a/sw-modules/module-package-reader/docs/_communication_configuration_8h_source.html b/sw-modules/module-package-reader/docs/_communication_configuration_8h_source.html new file mode 100644 index 0000000..bb56706 --- /dev/null +++ b/sw-modules/module-package-reader/docs/_communication_configuration_8h_source.html @@ -0,0 +1,105 @@ + + + + + + + +MQTT Communication: CommunicationConfiguration.h Source File + + + + + + + + + + + + + + +
+
+ + + + + + +
+
MQTT Communication +
+
Smart Factory
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
CommunicationConfiguration.h
+
+
+Go to the documentation of this file.
1 
19 #ifndef COMMUNICATIONCONFIGURATION_H
20 #define COMMUNICATIONCONFIGURATION_H
21 
22 //=============WLAN CONNECTION==================================
23 #define DEFAULT_WIFI_SSID "DigitalLab"
24 #define DEFAULT_WIFI_PASSWORD "digital42HSR"
25 
26 // Pins for Adafruit ATWINC1500 Feather https://learn.adafruit.com/adafruit-feather-m0-wifi-atwinc1500/using-the-wifi-module
27 #define DEFAULT_WIFI_CS 8
28 #define DEFAULT_WIFI_IRQ 7
29 #define DEFAULT_WIFI_RST 4
30 #define DEFAULT_WIFI_EN 2
31 
32 //=============MQTT==================================
33 // * DEFAULT_MQTT_* are MQTT defaults
34 #define DEFAULT_MQTT_BROKER_IP1 192
35 #define DEFAULT_MQTT_BROKER_IP2 168
36 #define DEFAULT_MQTT_BROKER_IP3 1
37 #define DEFAULT_MQTT_BROKER_IP4 22
38 #define DEFAULT_MQTT_PORT 1883
39 
40 //=============JSON==================================
41 #define MAX_JSON_PARSE_SIZE 300
42 #define MAX_JSON_MESSAGES_SAVED 20
43 
44 #endif
+
+ + + + diff --git a/sw-modules/module-package-reader/docs/_m_q_t_t_communication_8cpp.html b/sw-modules/module-package-reader/docs/_m_q_t_t_communication_8cpp.html new file mode 100644 index 0000000..10571a7 --- /dev/null +++ b/sw-modules/module-package-reader/docs/_m_q_t_t_communication_8cpp.html @@ -0,0 +1,236 @@ + + + + + + + +MQTT Communication: MQTTCommunication.cpp File Reference + + + + + + + + + + + + + + +
+
+ + + + + + +
+
MQTT Communication +
+
Smart Factory
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Functions | +Variables
+
+
MQTTCommunication.cpp File Reference
+
+
+ +

Implementation of the Connection class. +More...

+
#include "MQTTCommunication.h"
+
+Include dependency graph for MQTTCommunication.cpp:
+
+
+ + + + + + + + + + + + + + + + +
+
+

Go to the source code of this file.

+ + + + + +

+Functions

void callback (char *topic, byte *payload, unsigned int length)
 If the client is used to subscribe to topics, a callback function must be provided in the constructor. his function is called when new messages arrive at the client. More...
 
+ + + + + + + +

+Variables

myJSON _myjson (MAX_JSON_PARSE_SIZE)
 instance of myJSON More...
 
CircularBuffer< myJSONStr, MAX_JSON_MESSAGES_SAVED > _buffer
 instance of CircularBuffer More...
 
+

Detailed Description

+

Implementation of the Connection class.

+
Author
Luca Mazzoleni (luca..nosp@m.mazz.nosp@m.oleni.nosp@m.@hsr.nosp@m..ch)
+
Version
1.0 - added Connection-Implementation - Luca Mazzoleni (luca..nosp@m.mazz.nosp@m.oleni.nosp@m.@hsr.nosp@m..ch) - 2019-04-16
+
Date
2019-04-09
+
Copyright
Copyright (c) 2019
+ +

Definition in file MQTTCommunication.cpp.

+

Function Documentation

+ +

◆ callback()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void callback (char * topic,
byte * payload,
unsigned int length 
)
+
+ +

If the client is used to subscribe to topics, a callback function must be provided in the constructor. his function is called when new messages arrive at the client.

+
Todo:
Change global implementation of callback. Maybe with static?
+ +

Definition at line 32 of file MQTTCommunication.cpp.

+ +
+
+

Variable Documentation

+ +

◆ _buffer

+ +
+
+ + + + +
CircularBuffer<myJSONStr, MAX_JSON_MESSAGES_SAVED> _buffer
+
+ +

instance of CircularBuffer

+

Declares a global Circular Buffer of type myJSONStr with max Elements of MAX_JSON_MESSAGES_SAVED.

+ +

Definition at line 26 of file MQTTCommunication.cpp.

+ +
+
+ +

◆ _myjson

+ +
+
+ + + + +
myJSON _myjson(MAX_JSON_PARSE_SIZE)
+
+ +

instance of myJSON

+

Declare a global variable from typ myJSON so it can be accessed in callback.

+ +
+
+
+
+ + + + diff --git a/sw-modules/module-package-reader/docs/_m_q_t_t_communication_8cpp.js b/sw-modules/module-package-reader/docs/_m_q_t_t_communication_8cpp.js new file mode 100644 index 0000000..d191d4b --- /dev/null +++ b/sw-modules/module-package-reader/docs/_m_q_t_t_communication_8cpp.js @@ -0,0 +1,6 @@ +var _m_q_t_t_communication_8cpp = +[ + [ "callback", "_m_q_t_t_communication_8cpp.html#ac3a129f66dc859e2b7279565f4e1de78", null ], + [ "_buffer", "_m_q_t_t_communication_8cpp.html#ac88e2994c014e5e95aa2497a7501ea6a", null ], + [ "_myjson", "_m_q_t_t_communication_8cpp.html#a4283a95f69f867cc1506b5c3ef038644", null ] +]; \ No newline at end of file diff --git a/sw-modules/module-package-reader/docs/_m_q_t_t_communication_8cpp__incl.map b/sw-modules/module-package-reader/docs/_m_q_t_t_communication_8cpp__incl.map new file mode 100644 index 0000000..f628b44 --- /dev/null +++ b/sw-modules/module-package-reader/docs/_m_q_t_t_communication_8cpp__incl.map @@ -0,0 +1,16 @@ + + + + + + + + + + + + + + + + diff --git a/sw-modules/module-package-reader/docs/_m_q_t_t_communication_8cpp__incl.md5 b/sw-modules/module-package-reader/docs/_m_q_t_t_communication_8cpp__incl.md5 new file mode 100644 index 0000000..5220772 --- /dev/null +++ b/sw-modules/module-package-reader/docs/_m_q_t_t_communication_8cpp__incl.md5 @@ -0,0 +1 @@ +2dfd1505696da56b484b19c53aa5c42e \ No newline at end of file diff --git a/sw-modules/module-package-reader/docs/_m_q_t_t_communication_8cpp__incl.png b/sw-modules/module-package-reader/docs/_m_q_t_t_communication_8cpp__incl.png new file mode 100644 index 0000000..bc00bb9 Binary files /dev/null and b/sw-modules/module-package-reader/docs/_m_q_t_t_communication_8cpp__incl.png differ diff --git a/sw-modules/module-package-reader/docs/_m_q_t_t_communication_8cpp_source.html b/sw-modules/module-package-reader/docs/_m_q_t_t_communication_8cpp_source.html new file mode 100644 index 0000000..6477a23 --- /dev/null +++ b/sw-modules/module-package-reader/docs/_m_q_t_t_communication_8cpp_source.html @@ -0,0 +1,126 @@ + + + + + + + +MQTT Communication: MQTTCommunication.cpp Source File + + + + + + + + + + + + + + +
+
+ + + + + + +
+
MQTT Communication +
+
Smart Factory
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
MQTTCommunication.cpp
+
+
+Go to the documentation of this file.
1 
14 /*
15 Useful Links
16 https://techtutorialsx.com/2017/04/29/esp32-sending-json-messages-over-mqtt/
17 https://randomnerdtutorials.com/decoding-and-encoding-json-with-arduino-or-esp8266/
18 https://arduinodiy.wordpress.com/2017/07/30/json-mqtt-and-openhab/
19 https://assetwolf.com/learn/sending-data-from-arduino-to-cloud
20 */
21 
22 #include "MQTTCommunication.h"
23 
24 //==Global Vairable====
25 myJSON _myjson(MAX_JSON_PARSE_SIZE);
26 CircularBuffer<myJSONStr, MAX_JSON_MESSAGES_SAVED> _buffer;
27 
28 //======Func====
32 void callback(char* topic, byte* payload, unsigned int length) {
33  DBFUNCCALLln("callback(const char[] topic, byte* payload, unsigned int length)");
34  char payload_str[length];
35  for (unsigned int i = 0; i < length; i++) { // iterate message till lentgh caus it's not 0-terminated
36  payload_str[i] = (char)payload[i];
37  }
38  payload_str[length] = '\0';
39 
40  String topic_str = String((char*)topic);
41  String currentMessage = topic_str + " " + payload_str;
42  DBINFO3("CurrMessage: ");
43  DBINFO3ln(currentMessage);
44  DBINFO3("LastMessage: ");
45  DBINFO3ln(_myjson.lastMessage);
46 
47  if ((_myjson.lastMessage == currentMessage) && (_buffer.size() != 0)) {
48  DBINFO2ln("Duplicated Message");
49  } else {
50  DBINFO2ln("Add to Buffer");
51  //https://stackoverflow.com/questions/1360183/how-do-i-call-a-non-static-method-from-a-static-method-in-c
52  myJSONStr newMessage = _myjson.parsingJSONToStruct((char*)payload_str);
53  newMessage.topic = topic_str;
54  DBINFO3("ID: ");
55  DBINFO3ln(newMessage.id);
56  DBINFO3("Topic: ");
57  DBINFO3ln(newMessage.topic);
58  DBINFO3("Status: ");
59  DBINFO3ln(newMessage.status);
60  DBINFO3("sector: ");
61  DBINFO3ln(newMessage.sector);
62  DBINFO3("line: ");
63  DBINFO3ln(newMessage.line);
64  DBINFO3("ack: ");
65  DBINFO3ln(newMessage.ack);
66  DBINFO3("req: ");
67  DBINFO3ln(newMessage.req);
68  DBINFO3("cargo: ");
69  DBINFO3ln(newMessage.cargo);
70  DBINFO3("error: ");
71  DBINFO3ln(newMessage.error);
72  DBINFO3("token: ");
73  DBINFO3ln(newMessage.token);
74  // _myjson.StructIsEqual(newMessage, _buffer.first()); //bug this calls changes the message chars somehow?
75  _buffer.unshift(newMessage);
76  _myjson.lastMessage = currentMessage;
77  }
78 }
79 
80 Communication::Communication(String Hostname) : pHostname(Hostname) {
81  init();
82 }
myJSONStr::req
String req
Request.
Definition: myJSONStr.h:40
+
MQTTCommunication.h
The Connection-class is used as interface.
+
_buffer
CircularBuffer< myJSONStr, MAX_JSON_MESSAGES_SAVED > _buffer
instance of CircularBuffer
Definition: MQTTCommunication.cpp:26
+
myJSONStr
myJSON Struct defines the format of the messages
Definition: myJSONStr.h:33
+
Communication::Communication
Communication(String Hostname)
Construct a new Communication object.
Definition: MQTTCommunication.cpp:80
+
myJSONStr::cargo
String cargo
Cargo.
Definition: myJSONStr.h:41
+
myJSONStr::line
int line
Line.
Definition: myJSONStr.h:38
+
myJSONStr::error
bool error
Error-token.
Definition: myJSONStr.h:43
+
myJSON::lastMessage
String lastMessage
Definition: myJSON.h:48
+
myJSONStr::status
String status
Status.
Definition: myJSONStr.h:36
+
callback
void callback(char *topic, byte *payload, unsigned int length)
If the client is used to subscribe to topics, a callback function must be provided in the constructor...
Definition: MQTTCommunication.cpp:32
+
myJSONStr::id
String id
Hostname.
Definition: myJSONStr.h:34
+
MAX_JSON_PARSE_SIZE
#define MAX_JSON_PARSE_SIZE
max buffer size to parse JSON objects, size of the pool in bytes, can be calculated in https://arduin...
Definition: CommunicationConfiguration.h:41
+
myJSONStr::topic
String topic
MQTT topic.
Definition: myJSONStr.h:35
+
_myjson
myJSON _myjson(MAX_JSON_PARSE_SIZE)
instance of myJSON
+
myJSONStr::sector
String sector
Sector.
Definition: myJSONStr.h:37
+
Communication::init
void init()
Initializes the Hard- and Software for WLAN and MQTT-Connection.
Definition: MQTTCommunication.h:84
+
myJSON::parsingJSONToStruct
myJSONStr parsingJSONToStruct(const char *json)
Parsing JSON-Format into myJSONStr.
Definition: myJSON.cpp:19
+
myJSONStr::ack
String ack
Acknoledgement.
Definition: myJSONStr.h:39
+
myJSONStr::token
bool token
Gateway and Reset-token.
Definition: myJSONStr.h:42
+
myJSON
myJSON class handels the conversion from the JSON-Format into a struct
Definition: myJSON.h:28
+
+
+ + + + diff --git a/sw-modules/module-package-reader/docs/_m_q_t_t_communication_8h.html b/sw-modules/module-package-reader/docs/_m_q_t_t_communication_8h.html new file mode 100644 index 0000000..ba829c0 --- /dev/null +++ b/sw-modules/module-package-reader/docs/_m_q_t_t_communication_8h.html @@ -0,0 +1,270 @@ + + + + + + + +MQTT Communication: MQTTCommunication.h File Reference + + + + + + + + + + + + + + +
+
+ + + + + + +
+
MQTT Communication +
+
Smart Factory
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Classes | +Functions | +Variables
+
+
MQTTCommunication.h File Reference
+
+
+ +

The Connection-class is used as interface. +More...

+
#include "Arduino.h"
+#include "CommunicationConfiguration.h"
+#include <CircularBuffer.h>
+#include "Network/Network.h"
+#include "myJSON/myJSON.h"
+#include "myMQTT/myMQTT.h"
+
+Include dependency graph for MQTTCommunication.h:
+
+
+ + + + + + + + + + + + + + + +
+
+This graph shows which files directly or indirectly include this file:
+
+
+ + + + +
+
+

Go to the source code of this file.

+ + + + + +

+Classes

class  Communication
 The Connection-class provides the interface. More...
 
+ + + + +

+Functions

void callback (char *topic, byte *payload, unsigned int length)
 If the client is used to subscribe to topics, a callback function must be provided in the constructor. his function is called when new messages arrive at the client. More...
 
+ + + + + + + +

+Variables

myJSON _myjson
 Declare a global variable from typ myJSON so it can be accessed in callback. More...
 
CircularBuffer< myJSONStr, MAX_JSON_MESSAGES_SAVED > _buffer
 Declares a global Circular Buffer of type myJSONStr with max Elements of MAX_JSON_MESSAGES_SAVED. More...
 
+

Detailed Description

+

The Connection-class is used as interface.

+
Author
Luca Mazzoleni (luca..nosp@m.mazz.nosp@m.oleni.nosp@m.@hsr.nosp@m..ch)
+
Version
1.0 - added Connection-Implementation - Luca Mazzoleni (luca..nosp@m.mazz.nosp@m.oleni.nosp@m.@hsr.nosp@m..ch) - 2019-04-16
+
Date
2019-04-09
+
Copyright
Copyright (c) 2019
+
Todo:
Split the Code into two Repos: SmartFactory_Communication-Sortic
+and SmartFactory_MQTTCommunication-Basis to simplify modular use.
+ +

Definition in file MQTTCommunication.h.

+

Function Documentation

+ +

◆ callback()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void callback (char * topic,
byte * payload,
unsigned int length 
)
+
+ +

If the client is used to subscribe to topics, a callback function must be provided in the constructor. his function is called when new messages arrive at the client.

+

Internally, the client uses the same buffer for both inbound and outbound messages. After the callback function returns, or if a call to either publish or subscribe is made from within the callback function, the topic and payload values passed to the function will be overwritten. The application should create its own copy of the values if they are required beyond this.

+

https://pubsubclient.knolleary.net/api.html#callback

+

This Function is global because you need to access it from a diffrent class and pass it as pointer. This would be possible if it's static but then all function which get called in callback need to be static too.

+
Parameters
+ + + + +
topic- the topic the message arrived on (const char[])
payload- the message payload (byte array)
length- the length of the message payload (unsigned int)
+
+
+
Todo:
Change global implementation of callback. Maybe with static?
+ +

Definition at line 32 of file MQTTCommunication.cpp.

+ +
+
+

Variable Documentation

+ +

◆ _buffer

+ +
+
+ + + + +
CircularBuffer<myJSONStr, MAX_JSON_MESSAGES_SAVED> _buffer
+
+ +

Declares a global Circular Buffer of type myJSONStr with max Elements of MAX_JSON_MESSAGES_SAVED.

+

When declaring your buffer you should specify the data type it must handle and the buffer capacity: those two parameters will influence the memory consumed by the buffer. https://github.com/rlogiacco/CircularBuffer

+

Declares a global Circular Buffer of type myJSONStr with max Elements of MAX_JSON_MESSAGES_SAVED.

+ +

Definition at line 26 of file MQTTCommunication.cpp.

+ +
+
+ +

◆ _myjson

+ +
+
+ + + + +
myJSON _myjson
+
+ +

Declare a global variable from typ myJSON so it can be accessed in callback.

+

Declare a global variable from typ myJSON so it can be accessed in callback.

+ +
+
+
+
+ + + + diff --git a/sw-modules/module-package-reader/docs/_m_q_t_t_communication_8h.js b/sw-modules/module-package-reader/docs/_m_q_t_t_communication_8h.js new file mode 100644 index 0000000..baf7ac4 --- /dev/null +++ b/sw-modules/module-package-reader/docs/_m_q_t_t_communication_8h.js @@ -0,0 +1,7 @@ +var _m_q_t_t_communication_8h = +[ + [ "Communication", "class_communication.html", "class_communication" ], + [ "callback", "_m_q_t_t_communication_8h.html#ac3a129f66dc859e2b7279565f4e1de78", null ], + [ "_buffer", "_m_q_t_t_communication_8h.html#ac88e2994c014e5e95aa2497a7501ea6a", null ], + [ "_myjson", "_m_q_t_t_communication_8h.html#a7b53ade1cc8486457ead86c3c41a0c7e", null ] +]; \ No newline at end of file diff --git a/sw-modules/module-package-reader/docs/_m_q_t_t_communication_8h__dep__incl.map b/sw-modules/module-package-reader/docs/_m_q_t_t_communication_8h__dep__incl.map new file mode 100644 index 0000000..c878837 --- /dev/null +++ b/sw-modules/module-package-reader/docs/_m_q_t_t_communication_8h__dep__incl.map @@ -0,0 +1,4 @@ + + + + diff --git a/sw-modules/module-package-reader/docs/_m_q_t_t_communication_8h__dep__incl.md5 b/sw-modules/module-package-reader/docs/_m_q_t_t_communication_8h__dep__incl.md5 new file mode 100644 index 0000000..1366fc9 --- /dev/null +++ b/sw-modules/module-package-reader/docs/_m_q_t_t_communication_8h__dep__incl.md5 @@ -0,0 +1 @@ +761fb48f6cf6101f915580f632c5606a \ No newline at end of file diff --git a/sw-modules/module-package-reader/docs/_m_q_t_t_communication_8h__dep__incl.png b/sw-modules/module-package-reader/docs/_m_q_t_t_communication_8h__dep__incl.png new file mode 100644 index 0000000..144f425 Binary files /dev/null and b/sw-modules/module-package-reader/docs/_m_q_t_t_communication_8h__dep__incl.png differ diff --git a/sw-modules/module-package-reader/docs/_m_q_t_t_communication_8h__incl.map b/sw-modules/module-package-reader/docs/_m_q_t_t_communication_8h__incl.map new file mode 100644 index 0000000..2571af7 --- /dev/null +++ b/sw-modules/module-package-reader/docs/_m_q_t_t_communication_8h__incl.map @@ -0,0 +1,15 @@ + + + + + + + + + + + + + + + diff --git a/sw-modules/module-package-reader/docs/_m_q_t_t_communication_8h__incl.md5 b/sw-modules/module-package-reader/docs/_m_q_t_t_communication_8h__incl.md5 new file mode 100644 index 0000000..270cb6d --- /dev/null +++ b/sw-modules/module-package-reader/docs/_m_q_t_t_communication_8h__incl.md5 @@ -0,0 +1 @@ +923cd4a717ea870f088664ba5e59b9c3 \ No newline at end of file diff --git a/sw-modules/module-package-reader/docs/_m_q_t_t_communication_8h__incl.png b/sw-modules/module-package-reader/docs/_m_q_t_t_communication_8h__incl.png new file mode 100644 index 0000000..808ae5f Binary files /dev/null and b/sw-modules/module-package-reader/docs/_m_q_t_t_communication_8h__incl.png differ diff --git a/sw-modules/module-package-reader/docs/_m_q_t_t_communication_8h_source.html b/sw-modules/module-package-reader/docs/_m_q_t_t_communication_8h_source.html new file mode 100644 index 0000000..8047841 --- /dev/null +++ b/sw-modules/module-package-reader/docs/_m_q_t_t_communication_8h_source.html @@ -0,0 +1,156 @@ + + + + + + + +MQTT Communication: MQTTCommunication.h Source File + + + + + + + + + + + + + + +
+
+ + + + + + +
+
MQTT Communication +
+
Smart Factory
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
MQTTCommunication.h
+
+
+Go to the documentation of this file.
1 
17 #ifndef MQTTCOMMUNICATION_H__
18 #define MQTTCOMMUNICATION_H__
19 
20 #include "Arduino.h"
21 
22 #include "CommunicationConfiguration.h"
23 
24 #include <CircularBuffer.h>
25 #include "Network/Network.h"
26 #include "myJSON/myJSON.h"
27 #include "myMQTT/myMQTT.h"
28 
49 void callback(char* topic, byte* payload, unsigned int length);
50 
55 extern myJSON _myjson;
56 
65 extern CircularBuffer<myJSONStr, MAX_JSON_MESSAGES_SAVED> _buffer;
66 
71 class Communication {
72  public:
77  Communication(String Hostname);
78 
79  //==INTERFACE===================================
84  inline void init() {
85  pNetwork.init();
86  pMymqtt.init(&pClient, funcPointer);
87  }
88 
97  inline bool loop() {
98  return pMymqtt.loop();
99  }
100 
101  //=======NETWORK============
102  // inline void connectToWiFi() {
103  // pNetwork.connectToWiFi();
104  // }
105 
106  inline void printNetworkInfo() {
107  pNetwork.printNetworkInfo();
108  }
109 
110  //=======myMQTT============
122  inline bool subscribe(const String topic) {
123  pNetwork.connectToWiFi();
124  return pMymqtt.subscribe(topic);
125  }
126 
137  inline bool unsubscribe(const String topic) {
138  pNetwork.connectToWiFi();
139  return pMymqtt.unsubscribe(topic);
140  }
141 
157  inline bool publishMessage(const String topic, const String msg) {
158  pNetwork.connectToWiFi();
159  return pMymqtt.publishMessage(topic, msg);
160  }
161 
162  //=======myJSON/Buffer============
163  //https://github.com/rlogiacco/CircularBuffer
171  inline myJSONStr last() {
172  return _buffer.last();
173  }
174 
181  inline myJSONStr getElement(int x) {
182  return _buffer[x];
183  }
184 
192  inline myJSONStr pop() {
193  return _buffer.pop();
194  }
195 
202  inline bool isEmpty() {
203  return _buffer.isEmpty();
204  }
205 
213  inline myJSONStr first() {
214  return _buffer.first();
215  }
223  inline myJSONStr shift() {
224  return _buffer.shift();
225  }
226 
232  inline int size() {
233  return _buffer.size();
234  }
235 
240  inline void clear() {
241  _buffer.clear();
242  }
243 
244  private:
245  String pHostname;
246  WiFiClient pClient = WiFiClient();
247  Network pNetwork = Network(DEFAULT_WIFI_SSID,
248  DEFAULT_WIFI_PASSWORD,
249  DEFAULT_WIFI_CS,
250  DEFAULT_WIFI_IRQ,
251  DEFAULT_WIFI_RST,
252  DEFAULT_WIFI_EN);
253  myMQTT pMymqtt = myMQTT(pHostname,
254  DEFAULT_MQTT_BROKER_IP1,
255  DEFAULT_MQTT_BROKER_IP2,
256  DEFAULT_MQTT_BROKER_IP3,
257  DEFAULT_MQTT_BROKER_IP4,
258  DEFAULT_MQTT_PORT);
259 
260  void (*funcPointer)(char*, unsigned char*, unsigned int) = callback;
261 };
262 #endif
DEFAULT_MQTT_BROKER_IP2
#define DEFAULT_MQTT_BROKER_IP2
broker IP distributed in 4 values
Definition: CommunicationConfiguration.h:35
+
Network.h
The Network class establishes a WLAN-Connection.
+
myJSON.h
myJSON class handels the conversion from the JSON-Format into a struct
+
Communication::getElement
myJSONStr getElement(int x)
Get the Element object.
Definition: MQTTCommunication.h:181
+
callback
void callback(char *topic, byte *payload, unsigned int length)
If the client is used to subscribe to topics, a callback function must be provided in the constructor...
Definition: MQTTCommunication.cpp:32
+
DEFAULT_WIFI_SSID
#define DEFAULT_WIFI_SSID
SSID to connect to.
Definition: CommunicationConfiguration.h:23
+
myMQTT::loop
bool loop()
This should be called regularly to allow the client to process incoming messages and maintain its con...
Definition: myMQTT.h:101
+
_myjson
myJSON _myjson
Declare a global variable from typ myJSON so it can be accessed in callback.
+ +
DEFAULT_WIFI_RST
#define DEFAULT_WIFI_RST
Reset pin.
Definition: CommunicationConfiguration.h:29
+
DEFAULT_MQTT_BROKER_IP1
#define DEFAULT_MQTT_BROKER_IP1
broker IP distributed in 4 values
Definition: CommunicationConfiguration.h:34
+
myMQTT
Handels the MQTT connection.
Definition: myMQTT.h:32
+
Communication::clear
void clear()
resets the whole buffer to its initial state
Definition: MQTTCommunication.h:240
+
DEFAULT_WIFI_PASSWORD
#define DEFAULT_WIFI_PASSWORD
Password to corresponding SSID.
Definition: CommunicationConfiguration.h:24
+ +
CommunicationConfiguration.h
file that contains the default communication configuration
+
DEFAULT_WIFI_IRQ
#define DEFAULT_WIFI_IRQ
Interrupt pin.
Definition: CommunicationConfiguration.h:28
+
myJSONStr
myJSON Struct defines the format of the messages
Definition: myJSONStr.h:33
+
DEFAULT_MQTT_PORT
#define DEFAULT_MQTT_PORT
MQTT connection port.
Definition: CommunicationConfiguration.h:38
+
Network::connectToWiFi
void connectToWiFi()
Connects to a WiFi with the given Credential.
Definition: Network.cpp:40
+
Communication::Communication
Communication(String Hostname)
Construct a new Communication object.
Definition: MQTTCommunication.cpp:80
+
Network::printNetworkInfo
void printNetworkInfo()
Prints all relevant Network-Information of the connected network to serial.
Definition: Network.cpp:64
+
Communication::funcPointer
void(* funcPointer)(char *, unsigned char *, unsigned int)
functionpointer to callback-function
Definition: MQTTCommunication.h:260
+
myMQTT.h
This class handels the MQTT connection.
+
Communication::publishMessage
bool publishMessage(const String topic, const String msg)
handles outgoing MQTT messages to Server
Definition: MQTTCommunication.h:157
+
Communication::subscribe
bool subscribe(const String topic)
subsribes to MQTT topic on Server
Definition: MQTTCommunication.h:122
+
Communication::last
myJSONStr last()
Retriev data from the Tail (oldest Element) of the Buffer.
Definition: MQTTCommunication.h:171
+
Communication::pMymqtt
myMQTT pMymqtt
instance of myMQTT
Definition: MQTTCommunication.h:253
+
Communication::loop
bool loop()
This should be called regularly to allow the client to process incoming messages and maintain its con...
Definition: MQTTCommunication.h:97
+
DEFAULT_WIFI_EN
#define DEFAULT_WIFI_EN
Enable pin.
Definition: CommunicationConfiguration.h:30
+
Network::init
void init()
Intitialize WLan-Hardware.
Definition: Network.cpp:25
+
DEFAULT_MQTT_BROKER_IP3
#define DEFAULT_MQTT_BROKER_IP3
broker IP distributed in 4 values
Definition: CommunicationConfiguration.h:36
+
Communication::pClient
WiFiClient pClient
instance of WiFiClient
Definition: MQTTCommunication.h:246
+
myMQTT::init
void init(WiFiClient *myClient, void(*pToCallback)(char *, unsigned char *, unsigned int))
Definition: myMQTT.cpp:33
+
_buffer
CircularBuffer< myJSONStr, MAX_JSON_MESSAGES_SAVED > _buffer
Declares a global Circular Buffer of type myJSONStr with max Elements of MAX_JSON_MESSAGES_SAVED.
Definition: MQTTCommunication.cpp:26
+
Communication::init
void init()
Initializes the Hard- and Software for WLAN and MQTT-Connection.
Definition: MQTTCommunication.h:84
+
Communication::size
int size()
returns the number of elements currently stored in the buffer
Definition: MQTTCommunication.h:232
+
Communication
The Connection-class provides the interface.
Definition: MQTTCommunication.h:71
+
Communication::pNetwork
Network pNetwork
instance of Network
Definition: MQTTCommunication.h:247
+
Communication::isEmpty
bool isEmpty()
Check if the Buffer is empty.
Definition: MQTTCommunication.h:202
+
DEFAULT_WIFI_CS
#define DEFAULT_WIFI_CS
Chipselct pin.
Definition: CommunicationConfiguration.h:27
+
Communication::shift
myJSONStr shift()
Retriev data from the Head (newest Element) of the Buffer.
Definition: MQTTCommunication.h:223
+
myMQTT::unsubscribe
bool unsubscribe(const String topic)
unsubsribes from MQTT topic on Server
Definition: myMQTT.cpp:58
+
DEFAULT_MQTT_BROKER_IP4
#define DEFAULT_MQTT_BROKER_IP4
broker IP distributed in 4 values
Definition: CommunicationConfiguration.h:37
+
Communication::pop
myJSONStr pop()
Retriev data from the Tail (oldest Element) of the Buffer.
Definition: MQTTCommunication.h:192
+
myMQTT::subscribe
bool subscribe(const String topic)
subsribes to MQTT topic on Server
Definition: myMQTT.cpp:41
+
Network
Handels the WLAN-Connection.
Definition: Network.h:30
+
Communication::unsubscribe
bool unsubscribe(const String topic)
unsubsribes from MQTT topic on Server
Definition: MQTTCommunication.h:137
+
myMQTT::publishMessage
bool publishMessage(const String topic, const String msg)
handles outgoing MQTT messages to Server
Definition: myMQTT.cpp:75
+
Communication::first
myJSONStr first()
Retriev data from the Head (newest Element) of the Buffer.
Definition: MQTTCommunication.h:213
+
myJSON
myJSON class handels the conversion from the JSON-Format into a struct
Definition: myJSON.h:28
+
+
+ + + + diff --git a/sw-modules/module-package-reader/docs/_network_8cpp.html b/sw-modules/module-package-reader/docs/_network_8cpp.html new file mode 100644 index 0000000..b903bd3 --- /dev/null +++ b/sw-modules/module-package-reader/docs/_network_8cpp.html @@ -0,0 +1,132 @@ + + + + + + + +MQTT Communication: Network.cpp File Reference + + + + + + + + + + + + + + +
+
+ + + + + + +
+
MQTT Communication +
+
Smart Factory
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
Network.cpp File Reference
+
+
+ +

Implementation of the Network class. +More...

+
#include "Network.h"
+
+Include dependency graph for Network.cpp:
+
+
+ + + + + + + + +
+
+

Go to the source code of this file.

+

Detailed Description

+

Implementation of the Network class.

+
Author
Luca Mazzoleni (luca..nosp@m.mazz.nosp@m.oleni.nosp@m.@hsr.nosp@m..ch)
+
Version
1.0 - added Network-Connection - Luca Mazzoleni (luca..nosp@m.mazz.nosp@m.oleni.nosp@m.@hsr.nosp@m..ch) - 2019-04-13
+
Date
2019-04-13
+
Copyright
Copyright (c) 2019
+ +

Definition in file Network.cpp.

+
+
+ + + + diff --git a/sw-modules/module-package-reader/docs/_network_8cpp__incl.map b/sw-modules/module-package-reader/docs/_network_8cpp__incl.map new file mode 100644 index 0000000..4ef9282 --- /dev/null +++ b/sw-modules/module-package-reader/docs/_network_8cpp__incl.map @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/sw-modules/module-package-reader/docs/_network_8cpp__incl.md5 b/sw-modules/module-package-reader/docs/_network_8cpp__incl.md5 new file mode 100644 index 0000000..95b6ad3 --- /dev/null +++ b/sw-modules/module-package-reader/docs/_network_8cpp__incl.md5 @@ -0,0 +1 @@ +1c97cb819ef966cfc2c50861f27e9582 \ No newline at end of file diff --git a/sw-modules/module-package-reader/docs/_network_8cpp__incl.png b/sw-modules/module-package-reader/docs/_network_8cpp__incl.png new file mode 100644 index 0000000..64542de Binary files /dev/null and b/sw-modules/module-package-reader/docs/_network_8cpp__incl.png differ diff --git a/sw-modules/module-package-reader/docs/_network_8cpp_source.html b/sw-modules/module-package-reader/docs/_network_8cpp_source.html new file mode 100644 index 0000000..5c9fc07 --- /dev/null +++ b/sw-modules/module-package-reader/docs/_network_8cpp_source.html @@ -0,0 +1,126 @@ + + + + + + + +MQTT Communication: Network.cpp Source File + + + + + + + + + + + + + + +
+
+ + + + + + +
+
MQTT Communication +
+
Smart Factory
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
Network.cpp
+
+
+Go to the documentation of this file.
1 
14 #include "Network.h"
15 //=====PUBLIC====================================================================================
16 
17 Network::Network(String ssid, String password, int WIFI_CS, int WIFI_IRQ, int WIFI_RST, int WIFI_EN) : pSsid(ssid),
18  pPassword(password),
19  pWifi_CS(WIFI_CS),
20  pWiFi_IRQ(WIFI_IRQ),
21  pWifi_RST(WIFI_RST),
22  pWifi_EN(WIFI_EN) {
23 }
24 
25 void Network::init() {
26  DBFUNCCALLln("Network::init()");
27  WiFi.setPins(pWifi_CS, pWiFi_IRQ, pWifi_RST, pWifi_EN);
28  if (WiFi.status() == WL_NO_SHIELD) { // check if the shield is presence
29  DBERROR("NO WiFi shield present");
30  DBERROR("WiFi Library could not find WiFi shield. " + decodeWiFistate(WiFi.status()));
31  DBINFO3ln("programm is not continuing");
32  while (true) {
33  // don't continue
34  }
35  }
36  DBINFO3ln(String("WiFi Firmware Version = ") + String(WiFi.firmwareVersion()));
37  connectToWiFi();
38 }
39 
40 void Network::connectToWiFi() {
41  DBFUNCCALLln("Network::connectToWiFi()");
42  while (WiFi.status() != WL_CONNECTED) { // connect to Wifi network
43  DBSTATUS("Status: " + decodeWiFistate(WiFi.status()));
44  DBINFO3ln("Attempting WLAN connection (WEP)...");
45  DBINFO3ln("SSID: " + pSsid);
46  // DBINFO1ln("PW: " + pPassword);
47  if (WiFi.begin(pSsid, pPassword) != WL_CONNECTED) {
48  DBERROR("WLAN connection failed");
49  DBINFO3ln("trying again in 3 seconds");
50  delay(3000);
51  } else {
52  pIPLocal = WiFi.localIP();
53  WiFi.macAddress(pMac);
54  pSsid = WiFi.SSID();
55  WiFi.macAddress(pMac);
56  WiFi.BSSID(pMacRouter);
57  pRssi = WiFi.RSSI();
58  pEncryption = WiFi.encryptionType();
59  // hostname(hostname.c_str());
60  }
61  }
62 }
63 
64 void Network::printNetworkInfo() {
65  DBFUNCCALLln("Network::printNetworkInfo()");
66  printWiFiData();
67  printCurrentNet();
68 }
69 
70 //=====PRIVATE====================================================================================
71 
72 void Network::printWiFiData() {
73  DBFUNCCALLln("Network::printWiFiData()");
74  // print your WiFi shield's IP address:
75  pIPLocal = WiFi.localIP();
76  Serial.print("IP Address: ");
77  Serial.println(pIPLocal);
78  Serial.println(pIPLocal);
79  // print your MAC address:
80  WiFi.macAddress(pMac);
81  Serial.print("MAC address: ");
82  printMacAddress(pMac);
83 }
84 
85 void Network::printCurrentNet() {
86  DBFUNCCALLln("Network::printCurrentNet()");
87  // print the SSID of the network you're attached to:
88  Serial.print("SSID: ");
89  Serial.println(WiFi.SSID());
90  // print the MAC address of the router you're attached to:
91  WiFi.BSSID(pMacRouter);
92  Serial.print("BSSID: ");
93  printMacAddress(pMacRouter);
94  // print the received signal strength:
95  pRssi = WiFi.RSSI();
96  Serial.print("signal strength (RSSI):");
97  Serial.println(pRssi);
98  // print the encryption type:
99  pEncryption = WiFi.encryptionType();
100  Serial.print("Encryption Type: ");
101  Serial.println(decodeEncryptionType(pEncryption));
102  Serial.println();
103 }
104 
105 void Network::printMacAddress(byte mac[]) {
106  for (int i = 5; i >= 0; i--) {
107  if (mac[i] < 16) {
108  Serial.print("0");
109  }
110  Serial.print(mac[i], HEX);
111  if (i > 0) {
112  Serial.print(":");
113  }
114  }
115  Serial.println();
116 }
117 
118 String Network::decodeWiFistate(int errorcode) {
119  DBFUNCCALLln("Network::decodeWiFistate(int errorcode)");
120  switch (errorcode) {
121  case WL_NO_SHIELD:
122  return "WL_NO_SHIELD";
123  case WL_IDLE_STATUS:
124  return "WL_IDLE_STATUS";
125  case WL_NO_SSID_AVAIL:
126  return "WL_NO_SSID_AVAIL";
127  case WL_SCAN_COMPLETED:
128  return "WL_SCAN_COMPLETED";
129  case WL_CONNECTED:
130  return "WL_CONNECTED";
131  case WL_CONNECT_FAILED:
132  return "WL_CONNECT_FAILED";
133  case WL_CONNECTION_LOST:
134  return "WL_CONNECTION_LOST";
135  case WL_DISCONNECTED:
136  return "WL_DISCONNECTED";
137  case WL_AP_LISTENING:
138  return "WL_AP_LISTENING";
139  case WL_AP_CONNECTED:
140  return "WL_AP_CONNECTED";
141  case WL_AP_FAILED:
142  return "WL_AP_FAILED";
143  case WL_PROVISIONING:
144  return "WL_PROVISIONING";
145  case WL_PROVISIONING_FAILED:
146  return "WL_PROVISIONING_FAILED";
147  default:
148  return "Error";
149  }
150 }
151 
152 String Network::decodeEncryptionType(int errorcode) {
153  DBFUNCCALLln("Network::decodeEncryptionType(int errorcode)");
154  switch (errorcode) {
155  case 2:
156  return "TKIP (WPA)";
157  case 5:
158  return "WEP";
159  case 4:
160  return "CCMP (WPA)";
161  case 7:
162  return "NONE";
163  case 8:
164  return "AUTO ";
165  default:
166  return "Error";
167  }
168 }
Network.h
The Network class establishes a WLAN-Connection.
+
Network::printMacAddress
void printMacAddress(byte mac[])
Pritns Mac-address.
Definition: Network.cpp:105
+
Network::connectToWiFi
void connectToWiFi()
Connects to a WiFi with the given Credential.
Definition: Network.cpp:40
+
Network::printNetworkInfo
void printNetworkInfo()
Prints all relevant Network-Information of the connected network to serial.
Definition: Network.cpp:64
+
Network::pEncryption
byte pEncryption
value represents the type of encryption
Definition: Network.h:132
+
Network::pMacRouter
byte pMacRouter[6]
Contains MAC Adress of the Router BSSID.
Definition: Network.h:130
+
Network::Network
Network(String ssid, String password, int WIFI_CS, int WIFI_IRQ, int WIFI_RST, int WIFI_EN)
Construct a new Network object.
Definition: Network.cpp:17
+
Network::pIPLocal
IPAddress pIPLocal
Contains own IP-Adress.
Definition: Network.h:129
+
Network::pRssi
long pRssi
The current RSSI /Received Signal Strength in dBm.
Definition: Network.h:146
+
Network::pWifi_CS
int pWifi_CS
Definition: Network.h:125
+
Network::decodeWiFistate
String decodeWiFistate(int errorcode)
Decodes the Error Values from Wifi status() and returns a description.
Definition: Network.cpp:118
+
Network::pWiFi_IRQ
int pWiFi_IRQ
Definition: Network.h:126
+
Network::printCurrentNet
void printCurrentNet()
Prints all relevant Information of the current Network.
Definition: Network.cpp:85
+
Network::init
void init()
Intitialize WLan-Hardware.
Definition: Network.cpp:25
+
Network::printWiFiData
void printWiFiData()
Prints all relevant WiFi-Information of the connected network to serial.
Definition: Network.cpp:72
+
Network::pWifi_RST
int pWifi_RST
Definition: Network.h:127
+
Network::decodeEncryptionType
String decodeEncryptionType(int errorcode)
Construct a new decode Encryption Type object.
Definition: Network.cpp:152
+
Network::pPassword
String pPassword
Contains WiFi Password.
Definition: Network.h:124
+
Network::pSsid
String pSsid
Contains the SSID the WiFi shield is currently connected to.
Definition: Network.h:123
+
Network::pMac
byte pMac[6]
Contains own MAC Adress.
Definition: Network.h:131
+
Network::pWifi_EN
int pWifi_EN
Definition: Network.h:128
+
+
+ + + + diff --git a/sw-modules/module-package-reader/docs/_network_8h.html b/sw-modules/module-package-reader/docs/_network_8h.html new file mode 100644 index 0000000..7fefa72 --- /dev/null +++ b/sw-modules/module-package-reader/docs/_network_8h.html @@ -0,0 +1,157 @@ + + + + + + + +MQTT Communication: Network.h File Reference + + + + + + + + + + + + + + +
+
+ + + + + + +
+
MQTT Communication +
+
Smart Factory
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Classes
+
+
Network.h File Reference
+
+
+ +

The Network class establishes a WLAN-Connection. +More...

+
#include "Arduino.h"
+#include "LogConfiguration.h"
+#include <SPI.h>
+#include <WiFi101.h>
+
+Include dependency graph for Network.h:
+
+
+ + + + + + + +
+
+This graph shows which files directly or indirectly include this file:
+
+
+ + + + + + + + +
+
+

Go to the source code of this file.

+ + + + + +

+Classes

class  Network
 Handels the WLAN-Connection. More...
 
+

Detailed Description

+

The Network class establishes a WLAN-Connection.

+

https://www.arduino.cc/en/Reference/WiFi101

+
Author
Luca Mazzoleni (luca..nosp@m.mazz.nosp@m.oleni.nosp@m.@hsr.nosp@m..ch)
+
Version
1.0 - added Network-Connection - Luca Mazzoleni (luca..nosp@m.mazz.nosp@m.oleni.nosp@m.@hsr.nosp@m..ch) - 2019-04-13
+
Date
2019-04-13
+
Copyright
Copyright (c) 2019
+ +

Definition in file Network.h.

+
+
+ + + + diff --git a/sw-modules/module-package-reader/docs/_network_8h__dep__incl.map b/sw-modules/module-package-reader/docs/_network_8h__dep__incl.map new file mode 100644 index 0000000..4a31ed3 --- /dev/null +++ b/sw-modules/module-package-reader/docs/_network_8h__dep__incl.map @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/sw-modules/module-package-reader/docs/_network_8h__dep__incl.md5 b/sw-modules/module-package-reader/docs/_network_8h__dep__incl.md5 new file mode 100644 index 0000000..ae6559d --- /dev/null +++ b/sw-modules/module-package-reader/docs/_network_8h__dep__incl.md5 @@ -0,0 +1 @@ +52107397e819b66773c9a74ec8c90d2a \ No newline at end of file diff --git a/sw-modules/module-package-reader/docs/_network_8h__dep__incl.png b/sw-modules/module-package-reader/docs/_network_8h__dep__incl.png new file mode 100644 index 0000000..829b2f1 Binary files /dev/null and b/sw-modules/module-package-reader/docs/_network_8h__dep__incl.png differ diff --git a/sw-modules/module-package-reader/docs/_network_8h__incl.map b/sw-modules/module-package-reader/docs/_network_8h__incl.map new file mode 100644 index 0000000..0ac1650 --- /dev/null +++ b/sw-modules/module-package-reader/docs/_network_8h__incl.map @@ -0,0 +1,7 @@ + + + + + + + diff --git a/sw-modules/module-package-reader/docs/_network_8h__incl.md5 b/sw-modules/module-package-reader/docs/_network_8h__incl.md5 new file mode 100644 index 0000000..27ce3be --- /dev/null +++ b/sw-modules/module-package-reader/docs/_network_8h__incl.md5 @@ -0,0 +1 @@ +8b40b7c93c563fc944873916b05161c5 \ No newline at end of file diff --git a/sw-modules/module-package-reader/docs/_network_8h__incl.png b/sw-modules/module-package-reader/docs/_network_8h__incl.png new file mode 100644 index 0000000..20220ad Binary files /dev/null and b/sw-modules/module-package-reader/docs/_network_8h__incl.png differ diff --git a/sw-modules/module-package-reader/docs/_network_8h_source.html b/sw-modules/module-package-reader/docs/_network_8h_source.html new file mode 100644 index 0000000..3a3402c --- /dev/null +++ b/sw-modules/module-package-reader/docs/_network_8h_source.html @@ -0,0 +1,126 @@ + + + + + + + +MQTT Communication: Network.h Source File + + + + + + + + + + + + + + +
+
+ + + + + + +
+
MQTT Communication +
+
Smart Factory
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
Network.h
+
+
+Go to the documentation of this file.
1 
16 #ifndef NETWORK_H__
17 #define NETWORK_H__
18 
19 #include "Arduino.h"
20 
21 #include "LogConfiguration.h"
22 
23 #include <SPI.h>
24 #include <WiFi101.h>
25 
30 class Network {
31  //=====PUBLIC====================================================================================
32  public:
43  Network(String ssid, String password, int WIFI_CS, int WIFI_IRQ, int WIFI_RST, int WIFI_EN);
44 
54  void init();
55 
63  void connectToWiFi();
64 
73  void printNetworkInfo();
74 
75  //=====PRIVATE====================================================================================
76  private:
83  void printWiFiData();
84 
90  void printCurrentNet();
91 
97  void printMacAddress(byte mac[]);
98 
105  String decodeWiFistate(int errorcode);
106 
121  String decodeEncryptionType(int errorcode);
122 
123  String pSsid;
124  String pPassword;
125  int pWifi_CS;
126  int pWiFi_IRQ;
127  int pWifi_RST;
128  int pWifi_EN;
129  IPAddress pIPLocal;
130  byte pMacRouter[6];
131  byte pMac[6];
132  byte pEncryption;
133 
146  long pRssi;
147 };
148 #endif
Network::printMacAddress
void printMacAddress(byte mac[])
Pritns Mac-address.
Definition: Network.cpp:105
+
Network::connectToWiFi
void connectToWiFi()
Connects to a WiFi with the given Credential.
Definition: Network.cpp:40
+
Network::printNetworkInfo
void printNetworkInfo()
Prints all relevant Network-Information of the connected network to serial.
Definition: Network.cpp:64
+
Network::pEncryption
byte pEncryption
value represents the type of encryption
Definition: Network.h:132
+
Network::pMacRouter
byte pMacRouter[6]
Contains MAC Adress of the Router BSSID.
Definition: Network.h:130
+
Network::Network
Network(String ssid, String password, int WIFI_CS, int WIFI_IRQ, int WIFI_RST, int WIFI_EN)
Construct a new Network object.
Definition: Network.cpp:17
+
Network::pIPLocal
IPAddress pIPLocal
Contains own IP-Adress.
Definition: Network.h:129
+
Network::pRssi
long pRssi
The current RSSI /Received Signal Strength in dBm.
Definition: Network.h:146
+
Network::pWifi_CS
int pWifi_CS
Definition: Network.h:125
+
Network::decodeWiFistate
String decodeWiFistate(int errorcode)
Decodes the Error Values from Wifi status() and returns a description.
Definition: Network.cpp:118
+
Network::pWiFi_IRQ
int pWiFi_IRQ
Definition: Network.h:126
+
Network::printCurrentNet
void printCurrentNet()
Prints all relevant Information of the current Network.
Definition: Network.cpp:85
+
Network::init
void init()
Intitialize WLan-Hardware.
Definition: Network.cpp:25
+
Network::printWiFiData
void printWiFiData()
Prints all relevant WiFi-Information of the connected network to serial.
Definition: Network.cpp:72
+
Network::pWifi_RST
int pWifi_RST
Definition: Network.h:127
+
Network::decodeEncryptionType
String decodeEncryptionType(int errorcode)
Construct a new decode Encryption Type object.
Definition: Network.cpp:152
+
Network::pPassword
String pPassword
Contains WiFi Password.
Definition: Network.h:124
+
Network::pSsid
String pSsid
Contains the SSID the WiFi shield is currently connected to.
Definition: Network.h:123
+
Network::pMac
byte pMac[6]
Contains own MAC Adress.
Definition: Network.h:131
+
Network::pWifi_EN
int pWifi_EN
Definition: Network.h:128
+
Network
Handels the WLAN-Connection.
Definition: Network.h:30
+
+
+ + + + diff --git a/sw-modules/module-package-reader/docs/_r_e_a_d_m_e_8md.html b/sw-modules/module-package-reader/docs/_r_e_a_d_m_e_8md.html new file mode 100644 index 0000000..44f2351 --- /dev/null +++ b/sw-modules/module-package-reader/docs/_r_e_a_d_m_e_8md.html @@ -0,0 +1,105 @@ + + + + + + + +MQTT Communication: README.md File Reference + + + + + + + + + + + + + + +
+
+ + + + + + +
+
MQTT Communication +
+
Smart Factory
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
README.md File Reference
+
+
+
+
+ + + + diff --git a/sw-modules/module-package-reader/docs/annotated.html b/sw-modules/module-package-reader/docs/annotated.html new file mode 100644 index 0000000..a5faa5a --- /dev/null +++ b/sw-modules/module-package-reader/docs/annotated.html @@ -0,0 +1,113 @@ + + + + + + + +MQTT Communication: Class List + + + + + + + + + + + + + + +
+
+ + + + + + +
+
MQTT Communication +
+
Smart Factory
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
Class List
+
+
+
Here are the classes, structs, unions and interfaces with brief descriptions:
+ + + + + + +
 CCommunicationThe Connection-class provides the interface
 CmyJSONMyJSON class handels the conversion from the JSON-Format into a struct
 CmyJSONStrMyJSON Struct defines the format of the messages
 CmyMQTTHandels the MQTT connection
 CNetworkHandels the WLAN-Connection
+
+
+
+ + + + diff --git a/sw-modules/module-package-reader/docs/annotated_dup.js b/sw-modules/module-package-reader/docs/annotated_dup.js new file mode 100644 index 0000000..349a373 --- /dev/null +++ b/sw-modules/module-package-reader/docs/annotated_dup.js @@ -0,0 +1,8 @@ +var annotated_dup = +[ + [ "Communication", "class_communication.html", "class_communication" ], + [ "myJSON", "classmy_j_s_o_n.html", "classmy_j_s_o_n" ], + [ "myJSONStr", "structmy_j_s_o_n_str.html", "structmy_j_s_o_n_str" ], + [ "myMQTT", "classmy_m_q_t_t.html", "classmy_m_q_t_t" ], + [ "Network", "class_network.html", "class_network" ] +]; \ No newline at end of file diff --git a/sw-modules/module-package-reader/docs/bc_s.png b/sw-modules/module-package-reader/docs/bc_s.png new file mode 100644 index 0000000..224b29a Binary files /dev/null and b/sw-modules/module-package-reader/docs/bc_s.png differ diff --git a/sw-modules/module-package-reader/docs/bdwn.png b/sw-modules/module-package-reader/docs/bdwn.png new file mode 100644 index 0000000..940a0b9 Binary files /dev/null and b/sw-modules/module-package-reader/docs/bdwn.png differ diff --git a/sw-modules/module-package-reader/docs/bug.html b/sw-modules/module-package-reader/docs/bug.html new file mode 100644 index 0000000..04947e9 --- /dev/null +++ b/sw-modules/module-package-reader/docs/bug.html @@ -0,0 +1,109 @@ + + + + + + + +MQTT Communication: Bug List + + + + + + + + + + + + + + +
+
+ + + + + + +
+
MQTT Communication +
+
Smart Factory
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
Bug List
+
+
+
+
Member myJSON::StructIsEqual (const myJSONStr &lhs, const myJSONStr &rhs)
+
changes the String in Name when called in callback
+
+
+
+
+ + + + diff --git a/sw-modules/module-package-reader/docs/class_communication-members.html b/sw-modules/module-package-reader/docs/class_communication-members.html new file mode 100644 index 0000000..a63911b --- /dev/null +++ b/sw-modules/module-package-reader/docs/class_communication-members.html @@ -0,0 +1,127 @@ + + + + + + + +MQTT Communication: Member List + + + + + + + + + + + + + + +
+
+ + + + + + +
+
MQTT Communication +
+
Smart Factory
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
Communication Member List
+
+
+ +

This is the complete list of members for Communication, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + +
clear()Communicationinline
Communication(String Hostname)Communication
first()Communicationinline
funcPointerCommunicationprivate
getElement(int x)Communicationinline
init()Communicationinline
isEmpty()Communicationinline
last()Communicationinline
loop()Communicationinline
pClientCommunicationprivate
pHostnameCommunicationprivate
pMymqttCommunicationprivate
pNetworkCommunicationprivate
pop()Communicationinline
printNetworkInfo()Communicationinline
publishMessage(const String topic, const String msg)Communicationinline
shift()Communicationinline
size()Communicationinline
subscribe(const String topic)Communicationinline
unsubscribe(const String topic)Communicationinline
+
+ + + + diff --git a/sw-modules/module-package-reader/docs/class_communication.html b/sw-modules/module-package-reader/docs/class_communication.html new file mode 100644 index 0000000..907b94d --- /dev/null +++ b/sw-modules/module-package-reader/docs/class_communication.html @@ -0,0 +1,818 @@ + + + + + + + +MQTT Communication: Communication Class Reference + + + + + + + + + + + + + + +
+
+ + + + + + +
+
MQTT Communication +
+
Smart Factory
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Public Member Functions | +Private Attributes | +List of all members
+
+
Communication Class Reference
+
+
+ +

The Connection-class provides the interface. + More...

+ +

#include <MQTTCommunication.h>

+
+Collaboration diagram for Communication:
+
+
Collaboration graph
+ + + + + +
[legend]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 Communication (String Hostname)
 Construct a new Communication object. More...
 
void init ()
 Initializes the Hard- and Software for WLAN and MQTT-Connection. More...
 
bool loop ()
 This should be called regularly to allow the client to process incoming messages and maintain its connection to the server. More...
 
void printNetworkInfo ()
 
bool subscribe (const String topic)
 subsribes to MQTT topic on Server More...
 
bool unsubscribe (const String topic)
 unsubsribes from MQTT topic on Server More...
 
bool publishMessage (const String topic, const String msg)
 handles outgoing MQTT messages to Server More...
 
myJSONStr last ()
 Retriev data from the Tail (oldest Element) of the Buffer. More...
 
myJSONStr getElement (int x)
 Get the Element object. More...
 
myJSONStr pop ()
 Retriev data from the Tail (oldest Element) of the Buffer. More...
 
bool isEmpty ()
 Check if the Buffer is empty. More...
 
myJSONStr first ()
 Retriev data from the Head (newest Element) of the Buffer. More...
 
myJSONStr shift ()
 Retriev data from the Head (newest Element) of the Buffer. More...
 
int size ()
 returns the number of elements currently stored in the buffer More...
 
void clear ()
 resets the whole buffer to its initial state More...
 
+ + + + + + + + + + + + + + + +

+Private Attributes

String pHostname
 
WiFiClient pClient = WiFiClient()
 instance of WiFiClient More...
 
Network pNetwork
 instance of Network More...
 
myMQTT pMymqtt
 instance of myMQTT More...
 
void(* funcPointer )(char *, unsigned char *, unsigned int) = callback
 functionpointer to callback-function More...
 
+

Detailed Description

+

The Connection-class provides the interface.

+ +

Definition at line 71 of file MQTTCommunication.h.

+

Constructor & Destructor Documentation

+ +

◆ Communication()

+ +
+
+ + + + + + + + +
Communication::Communication (String Hostname)
+
+ +

Construct a new Communication object.

+ +

Definition at line 80 of file MQTTCommunication.cpp.

+ +
+
+

Member Function Documentation

+ +

◆ clear()

+ +
+
+ + + + + +
+ + + + + + + +
void Communication::clear ()
+ 		+inline
+
+ +

resets the whole buffer to its initial state

+ +

Definition at line 240 of file MQTTCommunication.h.

+ +
+
+ +

◆ first()

+ +
+
+ + + + + +
+ + + + + + + +
myJSONStr Communication::first ()
+ 		+inline
+
+ +

Retriev data from the Head (newest Element) of the Buffer.

+

This operation is non destructiv and the element will NOT be removed from the buffer Reading from an empty buffer is forbidden!!

Returns
myJSONStr - The Element at the Head
+ +

Definition at line 213 of file MQTTCommunication.h.

+ +
+
+ +

◆ getElement()

+ +
+
+ + + + + +
+ + + + + + + + +
myJSONStr Communication::getElement (int x)
+ 		+inline
+
+ +

Get the Element object.

+
Parameters
+ + +
x-
+
+
+
Returns
myJSONStr -
+ +

Definition at line 181 of file MQTTCommunication.h.

+ +
+
+ +

◆ init()

+ +
+
+ + + + + +
+ + + + + + + +
void Communication::init ()
+ 		+inline
+
+ +

Initializes the Hard- and Software for WLAN and MQTT-Connection.

+ +

Definition at line 84 of file MQTTCommunication.h.

+ +
+
+ +

◆ isEmpty()

+ +
+
+ + + + + +
+ + + + + + + +
bool Communication::isEmpty ()
+ 		+inline
+
+ +

Check if the Buffer is empty.

+
Returns
true - if no data is stored in the buffer
+
+false - if data is stored in the buffer
+ +

Definition at line 202 of file MQTTCommunication.h.

+ +
+
+ +

◆ last()

+ +
+
+ + + + + +
+ + + + + + + +
myJSONStr Communication::last ()
+ 		+inline
+
+ +

Retriev data from the Tail (oldest Element) of the Buffer.

+

This operation is non destructiv and the element will NOT be removed from the buffer Reading from an empty buffer is forbidden!!

Returns
myJSONStr - The Element at the Tail
+ +

Definition at line 171 of file MQTTCommunication.h.

+ +
+
+ +

◆ loop()

+ +
+
+ + + + + +
+ + + + + + + +
bool Communication::loop ()
+ 		+inline
+
+ +

This should be called regularly to allow the client to process incoming messages and maintain its connection to the server.

+
Returns
true - he client is still connected
+
+false - the client is no longer connected
+ +

Definition at line 97 of file MQTTCommunication.h.

+ +
+
+ +

◆ pop()

+ +
+
+ + + + + +
+ + + + + + + +
myJSONStr Communication::pop ()
+ 		+inline
+
+ +

Retriev data from the Tail (oldest Element) of the Buffer.

+

Cause the element being read to be removed from the buffer Reading from an empty buffer is forbidden!!

Returns
myJSONStr - The Element at the Tail
+ +

Definition at line 192 of file MQTTCommunication.h.

+ +
+
+ +

◆ printNetworkInfo()

+ +
+
+ + + + + +
+ + + + + + + +
void Communication::printNetworkInfo ()
+ 		+inline
+
+ +

Definition at line 106 of file MQTTCommunication.h.

+ +
+
+ +

◆ publishMessage()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
bool Communication::publishMessage (const String topic,
const String msg 
)
+ 		+inline
+
+ +

handles outgoing MQTT messages to Server

+

Checks if the Board is connected to a newtork and reconects if not

+

Beware though that the default packet size supported by the PubSub client is 128 bytes. You can increase this limit by editing the value lof MQTT_MAX_PACKET_SIZE in PubSubClient.h

+
Parameters
+ + + +
topic- the topic to publish to (const char[])
msg- the message to publish (const char[])
+
+
+
Returns
true - publish succed
+
+false - publish failes
+ +

Definition at line 157 of file MQTTCommunication.h.

+ +
+
+ +

◆ shift()

+ +
+
+ + + + + +
+ + + + + + + +
myJSONStr Communication::shift ()
+ 		+inline
+
+ +

Retriev data from the Head (newest Element) of the Buffer.

+

Cause the element being read to be removed from the buffer Reading from an empty buffer is forbidden!!

Returns
myJSONStr - The Element at the Head
+ +

Definition at line 223 of file MQTTCommunication.h.

+ +
+
+ +

◆ size()

+ +
+
+ + + + + +
+ + + + + + + +
int Communication::size ()
+ 		+inline
+
+ +

returns the number of elements currently stored in the buffer

+
Returns
int - Currently sotred elements
+ +

Definition at line 232 of file MQTTCommunication.h.

+ +
+
+ +

◆ subscribe()

+ +
+
+ + + + + +
+ + + + + + + + +
bool Communication::subscribe (const String topic)
+ 		+inline
+
+ +

subsribes to MQTT topic on Server

+

Checks if the Board is connected to a newtork and reconects if not Check if the client is connected to the server if not call connectToMQTT()

+
Parameters
+ + +
topic- the topic to subscribe to (const char[])
+
+
+
Returns
true - sending the subscribe succeeded. The request completes asynchronously.
+
+false - sending the subscribe failed, either connection lost, or message too large.
+ +

Definition at line 122 of file MQTTCommunication.h.

+ +
+
+ +

◆ unsubscribe()

+ +
+
+ + + + + +
+ + + + + + + + +
bool Communication::unsubscribe (const String topic)
+ 		+inline
+
+ +

unsubsribes from MQTT topic on Server

+

Checks if the Board is connected to a newtork and reconects if not Check if the client is connected to the server

+
Parameters
+ + +
topic- the topic to unsubscribe from (const char[])
+
+
+
Returns
true - sending the unsubscribe succeeded. The request completes asynchronously.
+
+false - sending the unsubscribe failed, either connection lost, or message too large.
+ +

Definition at line 137 of file MQTTCommunication.h.

+ +
+
+

Member Data Documentation

+ +

◆ funcPointer

+ +
+
+ + + + + +
+ + + + +
void(* Communication::funcPointer) (char *, unsigned char *, unsigned int) = callback
+ 		+private
+
+ +

functionpointer to callback-function

+ +

Definition at line 260 of file MQTTCommunication.h.

+ +
+
+ +

◆ pClient

+ +
+
+ + + + + +
+ + + + +
WiFiClient Communication::pClient = WiFiClient()
+ 		+private
+
+ +

instance of WiFiClient

+ +

Definition at line 246 of file MQTTCommunication.h.

+ +
+
+ +

◆ pHostname

+ +
+
+ + + + + +
+ + + + +
String Communication::pHostname
+ 		+private
+
+ +

Definition at line 245 of file MQTTCommunication.h.

+ +
+
+ +

◆ pMymqtt

+ +
+
+ + + + + +
+ + + + +
myMQTT Communication::pMymqtt
+ 		+private
+
+Initial value:
= myMQTT(pHostname,
DEFAULT_MQTT_BROKER_IP1,
DEFAULT_MQTT_BROKER_IP2,
DEFAULT_MQTT_BROKER_IP3,
DEFAULT_MQTT_BROKER_IP4,
DEFAULT_MQTT_PORT)
+

instance of myMQTT

+ +

Definition at line 253 of file MQTTCommunication.h.

+ +
+
+ +

◆ pNetwork

+ +
+
+ + + + + +
+ + + + +
Network Communication::pNetwork
+ 		+private
+
+Initial value:
= Network(DEFAULT_WIFI_SSID,
DEFAULT_WIFI_PASSWORD,
DEFAULT_WIFI_CS,
DEFAULT_WIFI_IRQ,
DEFAULT_WIFI_RST,
DEFAULT_WIFI_EN)
+

instance of Network

+ +

Definition at line 247 of file MQTTCommunication.h.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/sw-modules/module-package-reader/docs/class_communication.js b/sw-modules/module-package-reader/docs/class_communication.js new file mode 100644 index 0000000..9d21557 --- /dev/null +++ b/sw-modules/module-package-reader/docs/class_communication.js @@ -0,0 +1,23 @@ +var class_communication = +[ + [ "Communication", "class_communication.html#ab88eb4c3af7925175dc96a1781da7437", null ], + [ "clear", "class_communication.html#ab1c097a0ede778d6edd57be55fed77d6", null ], + [ "first", "class_communication.html#ab188e8647d1b8abba12dba6101fe4096", null ], + [ "getElement", "class_communication.html#a39b312c42c6977923b275047a84e81fe", null ], + [ "init", "class_communication.html#aa526fb8aa735ea4457dc56d1f0a4fe00", null ], + [ "isEmpty", "class_communication.html#ada2063efe2e5667c4317319c2e91ccd3", null ], + [ "last", "class_communication.html#a699d7c382d121bd4c0bd74687363315d", null ], + [ "loop", "class_communication.html#a751d7d863cb0d5a93cd3490012984c55", null ], + [ "pop", "class_communication.html#a57ed030b569780ab4937c1b76cb825ea", null ], + [ "printNetworkInfo", "class_communication.html#a712771a08b90a572d4b2115fd5a7c4bd", null ], + [ "publishMessage", "class_communication.html#aa59e118e1ed15e911ae2534274ab2e58", null ], + [ "shift", "class_communication.html#a0925e5cd26fc4fc3a0f99c1997bf0644", null ], + [ "size", "class_communication.html#a097f09aba41fec80fd226c75b91c1cd5", null ], + [ "subscribe", "class_communication.html#ae7600b9fe0f1249effde2852e8101593", null ], + [ "unsubscribe", "class_communication.html#a6be65dea68cf039e41df2986386dac61", null ], + [ "funcPointer", "class_communication.html#a0b8c2ab44fad41881b8da21367a02da4", null ], + [ "pClient", "class_communication.html#aacb5eaa628281d49ca2972b23c8ac652", null ], + [ "pHostname", "class_communication.html#aa6d4be2b35368ae426852d1cd2b03ef8", null ], + [ "pMymqtt", "class_communication.html#ae827543871f89ae91a3451dd7299695e", null ], + [ "pNetwork", "class_communication.html#aa6bf0a64203030930e74ee61153edd3a", null ] +]; \ No newline at end of file diff --git a/sw-modules/module-package-reader/docs/class_communication__coll__graph.map b/sw-modules/module-package-reader/docs/class_communication__coll__graph.map new file mode 100644 index 0000000..049d18b --- /dev/null +++ b/sw-modules/module-package-reader/docs/class_communication__coll__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/sw-modules/module-package-reader/docs/class_communication__coll__graph.md5 b/sw-modules/module-package-reader/docs/class_communication__coll__graph.md5 new file mode 100644 index 0000000..bb11dc2 --- /dev/null +++ b/sw-modules/module-package-reader/docs/class_communication__coll__graph.md5 @@ -0,0 +1 @@ +9ab66ac63758f5b7459d66744ef54306 \ No newline at end of file diff --git a/sw-modules/module-package-reader/docs/class_communication__coll__graph.png b/sw-modules/module-package-reader/docs/class_communication__coll__graph.png new file mode 100644 index 0000000..beb63b2 Binary files /dev/null and b/sw-modules/module-package-reader/docs/class_communication__coll__graph.png differ diff --git a/sw-modules/module-package-reader/docs/class_network-members.html b/sw-modules/module-package-reader/docs/class_network-members.html new file mode 100644 index 0000000..ed3953e --- /dev/null +++ b/sw-modules/module-package-reader/docs/class_network-members.html @@ -0,0 +1,127 @@ + + + + + + + +MQTT Communication: Member List + + + + + + + + + + + + + + +
+
+ + + + + + +
+
MQTT Communication +
+
Smart Factory
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
Network Member List
+
+
+ +

This is the complete list of members for Network, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + +
connectToWiFi()Network
decodeEncryptionType(int errorcode)Networkprivate
decodeWiFistate(int errorcode)Networkprivate
init()Network
Network(String ssid, String password, int WIFI_CS, int WIFI_IRQ, int WIFI_RST, int WIFI_EN)Network
pEncryptionNetworkprivate
pIPLocalNetworkprivate
pMacNetworkprivate
pMacRouterNetworkprivate
pPasswordNetworkprivate
printCurrentNet()Networkprivate
printMacAddress(byte mac[])Networkprivate
printNetworkInfo()Network
printWiFiData()Networkprivate
pRssiNetworkprivate
pSsidNetworkprivate
pWifi_CSNetworkprivate
pWifi_ENNetworkprivate
pWiFi_IRQNetworkprivate
pWifi_RSTNetworkprivate
+
+ + + + diff --git a/sw-modules/module-package-reader/docs/class_network.html b/sw-modules/module-package-reader/docs/class_network.html new file mode 100644 index 0000000..40441cf --- /dev/null +++ b/sw-modules/module-package-reader/docs/class_network.html @@ -0,0 +1,787 @@ + + + + + + + +MQTT Communication: Network Class Reference + + + + + + + + + + + + + + +
+
+ + + + + + +
+
MQTT Communication +
+
Smart Factory
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Public Member Functions | +Private Member Functions | +Private Attributes | +List of all members
+
+
Network Class Reference
+
+
+ +

Handels the WLAN-Connection. + More...

+ +

#include <Network.h>

+ + + + + + + + + + + + + + +

+Public Member Functions

 Network (String ssid, String password, int WIFI_CS, int WIFI_IRQ, int WIFI_RST, int WIFI_EN)
 Construct a new Network object. More...
 
void init ()
 Intitialize WLan-Hardware. More...
 
void connectToWiFi ()
 Connects to a WiFi with the given Credential. More...
 
void printNetworkInfo ()
 Prints all relevant Network-Information of the connected network to serial. More...
 
+ + + + + + + + + + + + + + + + +

+Private Member Functions

void printWiFiData ()
 Prints all relevant WiFi-Information of the connected network to serial. More...
 
void printCurrentNet ()
 Prints all relevant Information of the current Network. More...
 
void printMacAddress (byte mac[])
 Pritns Mac-address. More...
 
String decodeWiFistate (int errorcode)
 Decodes the Error Values from Wifi status() and returns a description. More...
 
String decodeEncryptionType (int errorcode)
 Construct a new decode Encryption Type object. More...
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Private Attributes

String pSsid
 Contains the SSID the WiFi shield is currently connected to. More...
 
String pPassword
 Contains WiFi Password. More...
 
int pWifi_CS
 
int pWiFi_IRQ
 
int pWifi_RST
 
int pWifi_EN
 
IPAddress pIPLocal
 Contains own IP-Adress. More...
 
byte pMacRouter [6]
 Contains MAC Adress of the Router BSSID. More...
 
byte pMac [6]
 Contains own MAC Adress. More...
 
byte pEncryption
 value represents the type of encryption More...
 
long pRssi
 The current RSSI /Received Signal Strength in dBm. More...
 
+

Detailed Description

+

Handels the WLAN-Connection.

+ +

Definition at line 30 of file Network.h.

+

Constructor & Destructor Documentation

+ +

◆ Network()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Network::Network (String ssid,
String password,
int WIFI_CS,
int WIFI_IRQ,
int WIFI_RST,
int WIFI_EN 
)
+
+ +

Construct a new Network object.

+
Parameters
+ + + + + + + +
ssid- SSID of the WLan you would like to connect
password- Password of the desired WLAN
WIFI_CS-
WIFI_IRQ-
WIFI_RST-
WIFI_EN-
+
+
+ +

Definition at line 17 of file Network.cpp.

+ +
+
+

Member Function Documentation

+ +

◆ connectToWiFi()

+ +
+
+ + + + + + + +
void Network::connectToWiFi ()
+
+ +

Connects to a WiFi with the given Credential.

+

If the Shield isn't already connected a new connection will be established If the Connection fails then there will be a 3 Sec dealy. https://www.arduino.cc/en/Tutorial/Wifi101ConnectWithWPA

+ +

Definition at line 40 of file Network.cpp.

+ +
+
+ +

◆ decodeEncryptionType()

+ +
+
+ + + + + +
+ + + + + + + + +
String Network::decodeEncryptionType (int errorcode)
+ 		+private
+
+ +

Construct a new decode Encryption Type object.

+

https://www.arduino.cc/en/Reference/WiFi101EncryptionType

+

2 = TKIP (WPA)
+5 = WEP
+4 = CCMP (WPA)
+7 = NONE
+8 = AUTO
+

Parameters
+ + +
errorcode- errorvalue from wifi101
+
+
+
Returns
String - Errordescription
+ +

Definition at line 152 of file Network.cpp.

+ +
+
+ +

◆ decodeWiFistate()

+ +
+
+ + + + + +
+ + + + + + + + +
String Network::decodeWiFistate (int errorcode)
+ 		+private
+
+ +

Decodes the Error Values from Wifi status() and returns a description.

+
Parameters
+ + +
errorcode- errorvalue from wifi101
+
+
+
Returns
String - Errordescription
+ +

Definition at line 118 of file Network.cpp.

+ +
+
+ +

◆ init()

+ +
+
+ + + + + + + +
void Network::init ()
+
+ +

Intitialize WLan-Hardware.

+

Sets Pins from Communication-Config file and checks if a WiFi-Shield is present. If not the programm stops else it calls connectToWiFi()

+ +

Definition at line 25 of file Network.cpp.

+ +
+
+ +

◆ printCurrentNet()

+ +
+
+ + + + + +
+ + + + + + + +
void Network::printCurrentNet ()
+ 		+private
+
+ +

Prints all relevant Information of the current Network.

+

SSID, BSSID, RSSI and encryptionType

+ +

Definition at line 85 of file Network.cpp.

+ +
+
+ +

◆ printMacAddress()

+ +
+
+ + + + + +
+ + + + + + + + +
void Network::printMacAddress (byte mac[])
+ 		+private
+
+ +

Pritns Mac-address.

+
Parameters
+ + +
mac-
+
+
+ +

Definition at line 105 of file Network.cpp.

+ +
+
+ +

◆ printNetworkInfo()

+ +
+
+ + + + + + + +
void Network::printNetworkInfo ()
+
+ +

Prints all relevant Network-Information of the connected network to serial.

+

IP-Address, MAC address (printWiFiData) SSID, BSSID, RSSI and encryptionType (printCurrentNet)

+ +

Definition at line 64 of file Network.cpp.

+ +
+
+ +

◆ printWiFiData()

+ +
+
+ + + + + +
+ + + + + + + +
void Network::printWiFiData ()
+ 		+private
+
+ +

Prints all relevant WiFi-Information of the connected network to serial.

+

IP-Address, MAC address

+ +

Definition at line 72 of file Network.cpp.

+ +
+
+

Member Data Documentation

+ +

◆ pEncryption

+ +
+
+ + + + + +
+ + + + +
byte Network::pEncryption
+ 		+private
+
+ +

value represents the type of encryption

+ +

Definition at line 132 of file Network.h.

+ +
+
+ +

◆ pIPLocal

+ +
+
+ + + + + +
+ + + + +
IPAddress Network::pIPLocal
+ 		+private
+
+ +

Contains own IP-Adress.

+ +

Definition at line 129 of file Network.h.

+ +
+
+ +

◆ pMac

+ +
+
+ + + + + +
+ + + + +
byte Network::pMac[6]
+ 		+private
+
+ +

Contains own MAC Adress.

+ +

Definition at line 131 of file Network.h.

+ +
+
+ +

◆ pMacRouter

+ +
+
+ + + + + +
+ + + + +
byte Network::pMacRouter[6]
+ 		+private
+
+ +

Contains MAC Adress of the Router BSSID.

+ +

Definition at line 130 of file Network.h.

+ +
+
+ +

◆ pPassword

+ +
+
+ + + + + +
+ + + + +
String Network::pPassword
+ 		+private
+
+ +

Contains WiFi Password.

+ +

Definition at line 124 of file Network.h.

+ +
+
+ +

◆ pRssi

+ +
+
+ + + + + +
+ + + + +
long Network::pRssi
+ 		+private
+
+ +

The current RSSI /Received Signal Strength in dBm.

+

-30 dBm Maximum signal strength, you are probably standing right next to the access point.
+-50 dBm Anything down to this level can be considered excellent signal strength.
+-60 dBm Good, reliable signal strength.
+-67 dBm Reliable signal strength. The minimum for any service depending on a reliable connection and signal strength, such as voice over Wi-Fi and non-HD video streaming.
+-70 dBm Not a strong signal. Light browsing and email.
+-80 dBm Unreliable signal strength, will not suffice for most services. Connecting to the network.
+-90 dBm The chances of even connecting are very low at this level.
+Source https://eyesaas.com/wi-fi-signal-strength/

+ +

Definition at line 146 of file Network.h.

+ +
+
+ +

◆ pSsid

+ +
+
+ + + + + +
+ + + + +
String Network::pSsid
+ 		+private
+
+ +

Contains the SSID the WiFi shield is currently connected to.

+ +

Definition at line 123 of file Network.h.

+ +
+
+ +

◆ pWifi_CS

+ +
+
+ + + + + +
+ + + + +
int Network::pWifi_CS
+ 		+private
+
+ +

Definition at line 125 of file Network.h.

+ +
+
+ +

◆ pWifi_EN

+ +
+
+ + + + + +
+ + + + +
int Network::pWifi_EN
+ 		+private
+
+ +

Definition at line 128 of file Network.h.

+ +
+
+ +

◆ pWiFi_IRQ

+ +
+
+ + + + + +
+ + + + +
int Network::pWiFi_IRQ
+ 		+private
+
+ +

Definition at line 126 of file Network.h.

+ +
+
+ +

◆ pWifi_RST

+ +
+
+ + + + + +
+ + + + +
int Network::pWifi_RST
+ 		+private
+
+ +

Definition at line 127 of file Network.h.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/sw-modules/module-package-reader/docs/class_network.js b/sw-modules/module-package-reader/docs/class_network.js new file mode 100644 index 0000000..0eeb14e --- /dev/null +++ b/sw-modules/module-package-reader/docs/class_network.js @@ -0,0 +1,23 @@ +var class_network = +[ + [ "Network", "class_network.html#a0dfd4ee86e18346c40a7ec13c66c679d", null ], + [ "connectToWiFi", "class_network.html#ad7fff536b31740411da0e7c8f281eda9", null ], + [ "decodeEncryptionType", "class_network.html#a07eee94a1b113e65c9d1c6b8c6c6ee44", null ], + [ "decodeWiFistate", "class_network.html#a31ebd477ecb0f08f85b7fa52b9f2bb7a", null ], + [ "init", "class_network.html#a92193e6fe7a1dc2c7a42d9c9cfed81ed", null ], + [ "printCurrentNet", "class_network.html#ad2735cbfe5093d27985c310728e166b6", null ], + [ "printMacAddress", "class_network.html#aa141de92c8e5807f8d69f544fa497705", null ], + [ "printNetworkInfo", "class_network.html#a268526f3cebea91d533596f707b9ee01", null ], + [ "printWiFiData", "class_network.html#a0a51c159d16b9c5abce7e25231a0776a", null ], + [ "pEncryption", "class_network.html#a20c58da03c41b7a9f1b5145e2ce320ea", null ], + [ "pIPLocal", "class_network.html#a9b9b7c16c50e1f7cdda59447b66af4f9", null ], + [ "pMac", "class_network.html#a48797e41acbbfd72643633e482b97f9f", null ], + [ "pMacRouter", "class_network.html#a59728fee5cb48783f2f6531d64602dee", null ], + [ "pPassword", "class_network.html#a45441e8f4bb03d725e1c59504cf744ba", null ], + [ "pRssi", "class_network.html#aff68bd617b4f085f650a21d6982cacc7", null ], + [ "pSsid", "class_network.html#a37b8b3f25aed35e0813c78e494ea8575", null ], + [ "pWifi_CS", "class_network.html#a30246c34ee6f97772dbf27f685c21943", null ], + [ "pWifi_EN", "class_network.html#a7d8d5e27f99515be28c396bcf2694cd3", null ], + [ "pWiFi_IRQ", "class_network.html#ac72ce5aa90e751a2254d01e035adc6c5", null ], + [ "pWifi_RST", "class_network.html#af3c6ee0460d5f234a1339516aeb52564", null ] +]; \ No newline at end of file diff --git a/sw-modules/module-package-reader/docs/classes.html b/sw-modules/module-package-reader/docs/classes.html new file mode 100644 index 0000000..f7d7011 --- /dev/null +++ b/sw-modules/module-package-reader/docs/classes.html @@ -0,0 +1,117 @@ + + + + + + + +MQTT Communication: Class Index + + + + + + + + + + + + + + +
+
+ + + + + + +
+
MQTT Communication +
+
Smart Factory
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
Class Index
+
+
+
c | m | n
+ + + + + + + +
  c  
+
  m  
+		myJSONStr   
myMQTT   
Communication   myJSON   
  n  
+
Network   
+
c | m | n
+
+
+ + + + diff --git a/sw-modules/module-package-reader/docs/classmy_j_s_o_n-members.html b/sw-modules/module-package-reader/docs/classmy_j_s_o_n-members.html new file mode 100644 index 0000000..306e572 --- /dev/null +++ b/sw-modules/module-package-reader/docs/classmy_j_s_o_n-members.html @@ -0,0 +1,111 @@ + + + + + + + +MQTT Communication: Member List + + + + + + + + + + + + + + +
+
+ + + + + + +
+
MQTT Communication +
+
Smart Factory
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
myJSON Member List
+
+
+ +

This is the complete list of members for myJSON, including all inherited members.

+ + + + + +
lastMessagemyJSON
myJSON(const size_t ParsCapacity)myJSON
parsingJSONToStruct(const char *json)myJSON
pParsCapacitymyJSONprivate
+
+ + + + diff --git a/sw-modules/module-package-reader/docs/classmy_j_s_o_n.html b/sw-modules/module-package-reader/docs/classmy_j_s_o_n.html new file mode 100644 index 0000000..f3a734a --- /dev/null +++ b/sw-modules/module-package-reader/docs/classmy_j_s_o_n.html @@ -0,0 +1,238 @@ + + + + + + + +MQTT Communication: myJSON Class Reference + + + + + + + + + + + + + + +
+
+ + + + + + +
+
MQTT Communication +
+
Smart Factory
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Public Member Functions | +Public Attributes | +Private Attributes | +List of all members
+
+
myJSON Class Reference
+
+
+ +

myJSON class handels the conversion from the JSON-Format into a struct + More...

+ +

#include <myJSON.h>

+ + + + + + + + +

+Public Member Functions

 myJSON (const size_t ParsCapacity)
 Construct a new myJSON object. More...
 
myJSONStr parsingJSONToStruct (const char *json)
 Parsing JSON-Format into myJSONStr. More...
 
+ + + +

+Public Attributes

String lastMessage = "init"
 
+ + + +

+Private Attributes

const size_t pParsCapacity
 
+

Detailed Description

+

myJSON class handels the conversion from the JSON-Format into a struct

+ +

Definition at line 28 of file myJSON.h.

+

Constructor & Destructor Documentation

+ +

◆ myJSON()

+ +
+
+ + + + + + + + +
myJSON::myJSON (const size_t ParsCapacity)
+
+ +

Construct a new myJSON object.

+ +

Definition at line 16 of file myJSON.cpp.

+ +
+
+

Member Function Documentation

+ +

◆ parsingJSONToStruct()

+ +
+
+ + + + + + + + +
myJSONStr myJSON::parsingJSONToStruct (const char * json)
+
+ +

Parsing JSON-Format into myJSONStr.

+

Populates myJsonStr from a string. If an error occures, the default myJsonStr is returned. If you change myJsonStr you also need to change this function.

+
Parameters
+ + +
json- pointer to a char-array in json-format
+
+
+
Returns
myJSONStr - Struct
+ +

Definition at line 19 of file myJSON.cpp.

+ +
+
+

Member Data Documentation

+ +

◆ lastMessage

+ +
+
+ + + + +
String myJSON::lastMessage = "init"
+
+ +

Definition at line 48 of file myJSON.h.

+ +
+
+ +

◆ pParsCapacity

+ +
+
+ + + + + +
+ + + + +
const size_t myJSON::pParsCapacity
+ 		+private
+
+ +

Definition at line 51 of file myJSON.h.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/sw-modules/module-package-reader/docs/classmy_j_s_o_n.js b/sw-modules/module-package-reader/docs/classmy_j_s_o_n.js new file mode 100644 index 0000000..d9f4697 --- /dev/null +++ b/sw-modules/module-package-reader/docs/classmy_j_s_o_n.js @@ -0,0 +1,7 @@ +var classmy_j_s_o_n = +[ + [ "myJSON", "classmy_j_s_o_n.html#a895059270e63b6b2ad9c292cb9ecb861", null ], + [ "parsingJSONToStruct", "classmy_j_s_o_n.html#ad655cf00d966cba2100ceb5ed89f3215", null ], + [ "lastMessage", "classmy_j_s_o_n.html#ace499de7665ab481672fb942788955c9", null ], + [ "pParsCapacity", "classmy_j_s_o_n.html#ac76c8f7f3a8d3631406177ca44ccd2cd", null ] +]; \ No newline at end of file diff --git a/sw-modules/module-package-reader/docs/classmy_m_q_t_t-members.html b/sw-modules/module-package-reader/docs/classmy_m_q_t_t-members.html new file mode 100644 index 0000000..639dce4 --- /dev/null +++ b/sw-modules/module-package-reader/docs/classmy_m_q_t_t-members.html @@ -0,0 +1,120 @@ + + + + + + + +MQTT Communication: Member List + + + + + + + + + + + + + + +
+
+ + + + + + +
+
MQTT Communication +
+
Smart Factory
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
myMQTT Member List
+
+
+ +

This is the complete list of members for myMQTT, including all inherited members.

+ + + + + + + + + + + + + + +
connectToMQTT()myMQTTprivate
decodeMQTTstate(int errorcode)myMQTTprivate
init(WiFiClient *myClient, void(*pToCallback)(char *, unsigned char *, unsigned int))myMQTT
loop()myMQTTinline
MQTTConnectionFailed()myMQTTprivate
myMQTT(String hostname, const int BrokerIP1, const int BrokerIP2, const int BrokerIP3, const int BrokerIP4, const int BrokerPort)myMQTT
myMQTTclientmyMQTTprivate
pBrokerIPmyMQTTprivate
pBrokerPortmyMQTTprivate
pHostnamemyMQTTprivate
publishMessage(const String topic, const String msg)myMQTT
subscribe(const String topic)myMQTT
unsubscribe(const String topic)myMQTT
+
+ + + + diff --git a/sw-modules/module-package-reader/docs/classmy_m_q_t_t.html b/sw-modules/module-package-reader/docs/classmy_m_q_t_t.html new file mode 100644 index 0000000..b353ca5 --- /dev/null +++ b/sw-modules/module-package-reader/docs/classmy_m_q_t_t.html @@ -0,0 +1,618 @@ + + + + + + + +MQTT Communication: myMQTT Class Reference + + + + + + + + + + + + + + +
+
+ + + + + + +
+
MQTT Communication +
+
Smart Factory
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Public Member Functions | +Private Member Functions | +Private Attributes | +List of all members
+
+
myMQTT Class Reference
+
+
+ +

Handels the MQTT connection. + More...

+ +

#include <myMQTT.h>

+ + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 myMQTT (String hostname, const int BrokerIP1, const int BrokerIP2, const int BrokerIP3, const int BrokerIP4, const int BrokerPort)
 Construct a new my M Q T T object. More...
 
void init (WiFiClient *myClient, void(*pToCallback)(char *, unsigned char *, unsigned int))
 
bool subscribe (const String topic)
 subsribes to MQTT topic on Server More...
 
bool unsubscribe (const String topic)
 unsubsribes from MQTT topic on Server More...
 
bool publishMessage (const String topic, const String msg)
 handles outgoing MQTT messages to Server More...
 
bool loop ()
 This should be called regularly to allow the client to process incoming messages and maintain its connection to the server. More...
 
+ + + + + + + + + + +

+Private Member Functions

void connectToMQTT ()
 Connects to the MQTT-server. More...
 
String decodeMQTTstate (int errorcode)
 Decodes the Error Values from MQTT state() and returns a description. More...
 
void MQTTConnectionFailed ()
 Writes Error-Message about MQTT connection. More...
 
+ + + + + + + + + + + + + +

+Private Attributes

String pHostname
 Contains Hostname/Client ID. More...
 
IPAddress pBrokerIP
 the IP-address of the server/broker More...
 
const int pBrokerPort
 port to connect to MQTT More...
 
PubSubClient myMQTTclient
 instance of PubSubClient More...
 
+

Detailed Description

+

Handels the MQTT connection.

+

https://pubsubclient.knolleary.net

+ +

Definition at line 32 of file myMQTT.h.

+

Constructor & Destructor Documentation

+ +

◆ myMQTT()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
myMQTT::myMQTT (String hostname,
const int BrokerIP1,
const int BrokerIP2,
const int BrokerIP3,
const int BrokerIP4,
const int BrokerPort 
)
+
+ +

Construct a new my M Q T T object.

+
Parameters
+ + + + + + + +
hostname- the client ID to use when connecting to the server
BrokerIP1- broker IP distributed in 4 values (192)
BrokerIP2- broker IP distributed in 4 values (186)
BrokerIP3- broker IP distributed in 4 values (1)
BrokerIP4- broker IP distributed in 4 values (2)
BrokerPort- MQTT connection port
+
+
+ +

Definition at line 19 of file myMQTT.cpp.

+ +
+
+

Member Function Documentation

+ +

◆ connectToMQTT()

+ +
+
+ + + + + +
+ + + + + + + +
void myMQTT::connectToMQTT ()
+ 		+private
+
+ +

Connects to the MQTT-server.

+

If the server isn't already connected a new connection will be established If the connection fails then there will be a 3 Sec dealy.

+ +

Definition at line 93 of file myMQTT.cpp.

+ +
+
+ +

◆ decodeMQTTstate()

+ +
+
+ + + + + +
+ + + + + + + + +
String myMQTT::decodeMQTTstate (int errorcode)
+ 		+private
+
+ +

Decodes the Error Values from MQTT state() and returns a description.

+
Parameters
+ + +
errorcode- errorvalue from client
+
+
+
Returns
String - Errordescription
+ +

Definition at line 122 of file myMQTT.cpp.

+ +
+
+ +

◆ init()

+ +
+
+ + + + + + + + + + + + + + + + + + +
void myMQTT::init (WiFiClient * myClient,
void(*)(char *, unsigned char *, unsigned int) pToCallback 
)
+
+
Parameters
+ + + +
myClient- pointer to WiFiClient object
pToCallback- pointer to Callback-Function
+
+
+ +

Definition at line 33 of file myMQTT.cpp.

+ +
+
+ +

◆ loop()

+ +
+
+ + + + + +
+ + + + + + + +
bool myMQTT::loop ()
+ 		+inline
+
+ +

This should be called regularly to allow the client to process incoming messages and maintain its connection to the server.

+
Returns
true - he client is still connected
+
+false - the client is no longer connected
+ +

Definition at line 101 of file myMQTT.h.

+ +
+
+ +

◆ MQTTConnectionFailed()

+ +
+
+ + + + + +
+ + + + + + + +
void myMQTT::MQTTConnectionFailed ()
+ 		+private
+
+ +

Writes Error-Message about MQTT connection.

+ +

Definition at line 116 of file myMQTT.cpp.

+ +
+
+ +

◆ publishMessage()

+ +
+
+ + + + + + + + + + + + + + + + + + +
bool myMQTT::publishMessage (const String topic,
const String msg 
)
+
+ +

handles outgoing MQTT messages to Server

+

Beware though that the default packet size supported by the PubSub client is 128 bytes. You can increase this limit by editing the value lof MQTT_MAX_PACKET_SIZE in PubSubClient.h

+
Parameters
+ + + +
topic- the topic to publish to (const char[])
msg- the message to publish (const char[])
+
+
+
Returns
true - publish succed
+
+false - publish failes
+ +

Definition at line 75 of file myMQTT.cpp.

+ +
+
+ +

◆ subscribe()

+ +
+
+ + + + + + + + +
bool myMQTT::subscribe (const String topic)
+
+ +

subsribes to MQTT topic on Server

+

Check if the client is connected to the server if not call connectToMQTT()

+
Parameters
+ + +
topic- the topic to subscribe to (const char[])
+
+
+
Returns
true - sending the subscribe succeeded. The request completes asynchronously.
+
+false - sending the subscribe failed, either connection lost, or message too large.
+ +

Definition at line 41 of file myMQTT.cpp.

+ +
+
+ +

◆ unsubscribe()

+ +
+
+ + + + + + + + +
bool myMQTT::unsubscribe (const String topic)
+
+ +

unsubsribes from MQTT topic on Server

+

Check if the client is connected to the server

+
Parameters
+ + +
topic- the topic to unsubscribe from (const char[])
+
+
+
Returns
true - sending the unsubscribe succeeded. The request completes asynchronously.
+
+false - sending the unsubscribe failed, either connection lost, or message too large.
+ +

Definition at line 58 of file myMQTT.cpp.

+ +
+
+

Member Data Documentation

+ +

◆ myMQTTclient

+ +
+
+ + + + + +
+ + + + +
PubSubClient myMQTT::myMQTTclient
+ 		+private
+
+ +

instance of PubSubClient

+ +

Definition at line 132 of file myMQTT.h.

+ +
+
+ +

◆ pBrokerIP

+ +
+
+ + + + + +
+ + + + +
IPAddress myMQTT::pBrokerIP
+ 		+private
+
+ +

the IP-address of the server/broker

+ +

Definition at line 130 of file myMQTT.h.

+ +
+
+ +

◆ pBrokerPort

+ +
+
+ + + + + +
+ + + + +
const int myMQTT::pBrokerPort
+ 		+private
+
+ +

port to connect to MQTT

+ +

Definition at line 131 of file myMQTT.h.

+ +
+
+ +

◆ pHostname

+ +
+
+ + + + + +
+ + + + +
String myMQTT::pHostname
+ 		+private
+
+ +

Contains Hostname/Client ID.

+ +

Definition at line 129 of file myMQTT.h.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/sw-modules/module-package-reader/docs/classmy_m_q_t_t.js b/sw-modules/module-package-reader/docs/classmy_m_q_t_t.js new file mode 100644 index 0000000..e518beb --- /dev/null +++ b/sw-modules/module-package-reader/docs/classmy_m_q_t_t.js @@ -0,0 +1,16 @@ +var classmy_m_q_t_t = +[ + [ "myMQTT", "classmy_m_q_t_t.html#a279474d24c098fcf26a6d433bf794160", null ], + [ "connectToMQTT", "classmy_m_q_t_t.html#a6d495c08a06513954b95d961f0595959", null ], + [ "decodeMQTTstate", "classmy_m_q_t_t.html#ae4372969b093a2487479005ccb398cbc", null ], + [ "init", "classmy_m_q_t_t.html#a5f19e4308e3dc2d748291d3ca1cd9228", null ], + [ "loop", "classmy_m_q_t_t.html#a16792912f95306c1de19dd10d9ee9d87", null ], + [ "MQTTConnectionFailed", "classmy_m_q_t_t.html#a260a10a835dc83e7268bc901c5a45a00", null ], + [ "publishMessage", "classmy_m_q_t_t.html#ae15c915d8f868cc4cf5505c20f3d9816", null ], + [ "subscribe", "classmy_m_q_t_t.html#a55566e23e8705bf3390b6f8209cbd9a1", null ], + [ "unsubscribe", "classmy_m_q_t_t.html#a215cee06699f991dd068e92e302563a5", null ], + [ "myMQTTclient", "classmy_m_q_t_t.html#a3a747c468141e67bcd20c955850e142d", null ], + [ "pBrokerIP", "classmy_m_q_t_t.html#a86a31975764922935b74f610c1477497", null ], + [ "pBrokerPort", "classmy_m_q_t_t.html#a353d2fe6752bcdfe04dd98f1e137ab05", null ], + [ "pHostname", "classmy_m_q_t_t.html#a4a0245cabf326ffe19716458e97617d5", null ] +]; \ No newline at end of file diff --git a/sw-modules/module-package-reader/docs/closed.png b/sw-modules/module-package-reader/docs/closed.png new file mode 100644 index 0000000..98cc2c9 Binary files /dev/null and b/sw-modules/module-package-reader/docs/closed.png differ diff --git a/sw-modules/module-package-reader/docs/dir_000000_000001.html b/sw-modules/module-package-reader/docs/dir_000000_000001.html new file mode 100644 index 0000000..47e5a0f --- /dev/null +++ b/sw-modules/module-package-reader/docs/dir_000000_000001.html @@ -0,0 +1,101 @@ + + + + + + + +MQTT Communication: src -> myJSON Relation + + + + + + + + + + + + + + +
+
+ + + + + + +
+
MQTT Communication +
+
Smart Factory
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+

src → myJSON Relation

File in srcIncludes file in src/myJSON
MQTTCommunication.hmyJSON.h
+
+ + + + diff --git a/sw-modules/module-package-reader/docs/dir_000000_000002.html b/sw-modules/module-package-reader/docs/dir_000000_000002.html new file mode 100644 index 0000000..66990ad --- /dev/null +++ b/sw-modules/module-package-reader/docs/dir_000000_000002.html @@ -0,0 +1,101 @@ + + + + + + + +MQTT Communication: src -> myMQTT Relation + + + + + + + + + + + + + + +
+
+ + + + + + +
+
MQTT Communication +
+
Smart Factory
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+

src → myMQTT Relation

File in srcIncludes file in src/myMQTT
MQTTCommunication.hmyMQTT.h
+
+ + + + diff --git a/sw-modules/module-package-reader/docs/dir_000002_000003.html b/sw-modules/module-package-reader/docs/dir_000002_000003.html new file mode 100644 index 0000000..5f73541 --- /dev/null +++ b/sw-modules/module-package-reader/docs/dir_000002_000003.html @@ -0,0 +1,101 @@ + + + + + + + +MQTT Communication: myMQTT -> Network Relation + + + + + + + + + + + + + + +
+
+ + + + + + +
+
MQTT Communication +
+
Smart Factory
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+

myMQTT → Network Relation

File in src/myMQTTIncludes file in src/Network
myMQTT.hNetwork.h
+
+ + + + diff --git a/sw-modules/module-package-reader/docs/dir_0c0333544ec44c57ec7d33d873fe36a2.html b/sw-modules/module-package-reader/docs/dir_0c0333544ec44c57ec7d33d873fe36a2.html new file mode 100644 index 0000000..9fb59ee --- /dev/null +++ b/sw-modules/module-package-reader/docs/dir_0c0333544ec44c57ec7d33d873fe36a2.html @@ -0,0 +1,115 @@ + + + + + + + +MQTT Communication: Network Directory Reference + + + + + + + + + + + + + + +
+
+ + + + + + +
+
MQTT Communication +
+
Smart Factory
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
Network Directory Reference
+
+
+ + + + + + + + +

+Files

file  Network.cpp [code]
 Implementation of the Network class.
 
file  Network.h [code]
 The Network class establishes a WLAN-Connection.
 
+
+
+ + + + diff --git a/sw-modules/module-package-reader/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.html b/sw-modules/module-package-reader/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.html new file mode 100644 index 0000000..d621bab --- /dev/null +++ b/sw-modules/module-package-reader/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.html @@ -0,0 +1,144 @@ + + + + + + + +MQTT Communication: src Directory Reference + + + + + + + + + + + + + + +
+
+ + + + + + +
+
MQTT Communication +
+
Smart Factory
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
src Directory Reference
+
+
+
+Directory dependency graph for src:
+
+
src
+ + + + + + + + + +
+ + + + + + + + +

+Directories

directory  myJSON
 
directory  myMQTT
 
directory  Network
 
+ + + + + + + + + + + + + +

+Files

file  CommunicationConfiguration.h [code]
 file that contains the default communication configuration
 
file  MQTTCommunication.cpp [code]
 Implementation of the Connection class.
 
file  MQTTCommunication.h [code]
 The Connection-class is used as interface.
 
file  myJSONStr.h [code]
 myJSON Struct defines the format of the messages
 
+
+
+ + + + diff --git a/sw-modules/module-package-reader/docs/dir_68267d1309a1af8e8297ef4c3efbcdba_dep.map b/sw-modules/module-package-reader/docs/dir_68267d1309a1af8e8297ef4c3efbcdba_dep.map new file mode 100644 index 0000000..92c1f2c --- /dev/null +++ b/sw-modules/module-package-reader/docs/dir_68267d1309a1af8e8297ef4c3efbcdba_dep.map @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/sw-modules/module-package-reader/docs/dir_68267d1309a1af8e8297ef4c3efbcdba_dep.md5 b/sw-modules/module-package-reader/docs/dir_68267d1309a1af8e8297ef4c3efbcdba_dep.md5 new file mode 100644 index 0000000..6f05efe --- /dev/null +++ b/sw-modules/module-package-reader/docs/dir_68267d1309a1af8e8297ef4c3efbcdba_dep.md5 @@ -0,0 +1 @@ +d94e3e14f1993f6e9060913a617039af \ No newline at end of file diff --git a/sw-modules/module-package-reader/docs/dir_68267d1309a1af8e8297ef4c3efbcdba_dep.png b/sw-modules/module-package-reader/docs/dir_68267d1309a1af8e8297ef4c3efbcdba_dep.png new file mode 100644 index 0000000..8c2bf6e Binary files /dev/null and b/sw-modules/module-package-reader/docs/dir_68267d1309a1af8e8297ef4c3efbcdba_dep.png differ diff --git a/sw-modules/module-package-reader/docs/dir_79020f6277c390002298b294970d3a21.html b/sw-modules/module-package-reader/docs/dir_79020f6277c390002298b294970d3a21.html new file mode 100644 index 0000000..6d18ce8 --- /dev/null +++ b/sw-modules/module-package-reader/docs/dir_79020f6277c390002298b294970d3a21.html @@ -0,0 +1,126 @@ + + + + + + + +MQTT Communication: myMQTT Directory Reference + + + + + + + + + + + + + + +
+
+ + + + + + +
+
MQTT Communication +
+
Smart Factory
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
myMQTT Directory Reference
+
+
+
+Directory dependency graph for myMQTT:
+
+
myMQTT
+ + + + + + +
+ + + + + + + + +

+Files

file  myMQTT.cpp [code]
 Implementation of the myMQTT class.
 
file  myMQTT.h [code]
 This class handels the MQTT connection.
 
+
+
+ + + + diff --git a/sw-modules/module-package-reader/docs/dir_79020f6277c390002298b294970d3a21_dep.map b/sw-modules/module-package-reader/docs/dir_79020f6277c390002298b294970d3a21_dep.map new file mode 100644 index 0000000..59ecb39 --- /dev/null +++ b/sw-modules/module-package-reader/docs/dir_79020f6277c390002298b294970d3a21_dep.map @@ -0,0 +1,6 @@ + + + + + + diff --git a/sw-modules/module-package-reader/docs/dir_79020f6277c390002298b294970d3a21_dep.md5 b/sw-modules/module-package-reader/docs/dir_79020f6277c390002298b294970d3a21_dep.md5 new file mode 100644 index 0000000..877eed3 --- /dev/null +++ b/sw-modules/module-package-reader/docs/dir_79020f6277c390002298b294970d3a21_dep.md5 @@ -0,0 +1 @@ +7977d549ecf28e6c958ab2f57cc37dac \ No newline at end of file diff --git a/sw-modules/module-package-reader/docs/dir_79020f6277c390002298b294970d3a21_dep.png b/sw-modules/module-package-reader/docs/dir_79020f6277c390002298b294970d3a21_dep.png new file mode 100644 index 0000000..6646ce8 Binary files /dev/null and b/sw-modules/module-package-reader/docs/dir_79020f6277c390002298b294970d3a21_dep.png differ diff --git a/sw-modules/module-package-reader/docs/dir_d070139c2e0ed0606ea2c7d6bcc56ba8.html b/sw-modules/module-package-reader/docs/dir_d070139c2e0ed0606ea2c7d6bcc56ba8.html new file mode 100644 index 0000000..50a14a4 --- /dev/null +++ b/sw-modules/module-package-reader/docs/dir_d070139c2e0ed0606ea2c7d6bcc56ba8.html @@ -0,0 +1,124 @@ + + + + + + + +MQTT Communication: myJSON Directory Reference + + + + + + + + + + + + + + +
+
+ + + + + + +
+
MQTT Communication +
+
Smart Factory
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
myJSON Directory Reference
+
+
+
+Directory dependency graph for myJSON:
+
+
myJSON
+ + + + +
+ + + + + + + + +

+Files

file  myJSON.cpp [code]
 Implementation of the myJSON-class.
 
file  myJSON.h [code]
 myJSON class handels the conversion from the JSON-Format into a struct
 
+
+
+ + + + diff --git a/sw-modules/module-package-reader/docs/dir_d070139c2e0ed0606ea2c7d6bcc56ba8_dep.map b/sw-modules/module-package-reader/docs/dir_d070139c2e0ed0606ea2c7d6bcc56ba8_dep.map new file mode 100644 index 0000000..4501c07 --- /dev/null +++ b/sw-modules/module-package-reader/docs/dir_d070139c2e0ed0606ea2c7d6bcc56ba8_dep.map @@ -0,0 +1,4 @@ + + + + diff --git a/sw-modules/module-package-reader/docs/dir_d070139c2e0ed0606ea2c7d6bcc56ba8_dep.md5 b/sw-modules/module-package-reader/docs/dir_d070139c2e0ed0606ea2c7d6bcc56ba8_dep.md5 new file mode 100644 index 0000000..cad6380 --- /dev/null +++ b/sw-modules/module-package-reader/docs/dir_d070139c2e0ed0606ea2c7d6bcc56ba8_dep.md5 @@ -0,0 +1 @@ +4089aac7bb861d15c52989c883c20255 \ No newline at end of file diff --git a/sw-modules/module-package-reader/docs/dir_d070139c2e0ed0606ea2c7d6bcc56ba8_dep.png b/sw-modules/module-package-reader/docs/dir_d070139c2e0ed0606ea2c7d6bcc56ba8_dep.png new file mode 100644 index 0000000..0a5419c Binary files /dev/null and b/sw-modules/module-package-reader/docs/dir_d070139c2e0ed0606ea2c7d6bcc56ba8_dep.png differ diff --git a/sw-modules/module-package-reader/docs/doc.png b/sw-modules/module-package-reader/docs/doc.png new file mode 100644 index 0000000..17edabf Binary files /dev/null and b/sw-modules/module-package-reader/docs/doc.png differ diff --git a/sw-modules/module-package-reader/docs/doxygen.css b/sw-modules/module-package-reader/docs/doxygen.css new file mode 100644 index 0000000..e251592 --- /dev/null +++ b/sw-modules/module-package-reader/docs/doxygen.css @@ -0,0 +1,1764 @@ +/* The standard CSS for doxygen 1.8.15 */ + +body, table, div, p, dl { + font: 400 14px/22px Roboto,sans-serif; +} + +p.reference, p.definition { + font: 400 14px/22px Roboto,sans-serif; +} + +/* @group Heading Levels */ + +h1.groupheader { + font-size: 150%; +} + +.title { + font: 400 14px/28px Roboto,sans-serif; + font-size: 150%; + font-weight: bold; + margin: 10px 2px; +} + +h2.groupheader { + border-bottom: 1px solid #879ECB; + color: #354C7B; + font-size: 150%; + font-weight: normal; + margin-top: 1.75em; + padding-top: 8px; + padding-bottom: 4px; + width: 100%; +} + +h3.groupheader { + font-size: 100%; +} + +h1, h2, h3, h4, h5, h6 { + -webkit-transition: text-shadow 0.5s linear; + -moz-transition: text-shadow 0.5s linear; + -ms-transition: text-shadow 0.5s linear; + -o-transition: text-shadow 0.5s linear; + transition: text-shadow 0.5s linear; + margin-right: 15px; +} + +h1.glow, h2.glow, h3.glow, h4.glow, h5.glow, h6.glow { + text-shadow: 0 0 15px cyan; +} + +dt { + font-weight: bold; +} + +div.multicol { + -moz-column-gap: 1em; + -webkit-column-gap: 1em; + -moz-column-count: 3; + -webkit-column-count: 3; +} + +p.startli, p.startdd { + margin-top: 2px; +} + +p.starttd { + margin-top: 0px; +} + +p.endli { + margin-bottom: 0px; +} + +p.enddd { + margin-bottom: 4px; +} + +p.endtd { + margin-bottom: 2px; +} + +p.interli { +} + +p.interdd { +} + +p.intertd { +} + +/* @end */ + +caption { + font-weight: bold; +} + +span.legend { + font-size: 70%; + text-align: center; +} + +h3.version { + font-size: 90%; + text-align: center; +} + +div.qindex, div.navtab{ + background-color: #EBEFF6; + border: 1px solid #A3B4D7; + text-align: center; +} + +div.qindex, div.navpath { + width: 100%; + line-height: 140%; +} + +div.navtab { + margin-right: 15px; +} + +/* @group Link Styling */ + +a { + color: #3D578C; + font-weight: normal; + text-decoration: none; +} + +.contents a:visited { + color: #4665A2; +} + +a:hover { + text-decoration: underline; +} + +a.qindex { + font-weight: bold; +} + +a.qindexHL { + font-weight: bold; + background-color: #9CAFD4; + color: #FFFFFF; + border: 1px double #869DCA; +} + +.contents a.qindexHL:visited { + color: #FFFFFF; +} + +a.el { + font-weight: bold; +} + +a.elRef { +} + +a.code, a.code:visited, a.line, a.line:visited { + color: #4665A2; +} + +a.codeRef, a.codeRef:visited, a.lineRef, a.lineRef:visited { + color: #4665A2; +} + +/* @end */ + +dl.el { + margin-left: -1cm; +} + +ul { + overflow: hidden; /*Fixed: list item bullets overlap floating elements*/ +} + +#side-nav ul { + overflow: visible; /* reset ul rule for scroll bar in GENERATE_TREEVIEW window */ +} + +#main-nav ul { + overflow: visible; /* reset ul rule for the navigation bar drop down lists */ +} + +.fragment { + text-align: left; + direction: ltr; + overflow-x: auto; /*Fixed: fragment lines overlap floating elements*/ + overflow-y: hidden; +} + +pre.fragment { + border: 1px solid #C4CFE5; + background-color: #FBFCFD; + padding: 4px 6px; + margin: 4px 8px 4px 2px; + overflow: auto; + word-wrap: break-word; + font-size: 9pt; + line-height: 125%; + font-family: monospace, fixed; + font-size: 105%; +} + +div.fragment { + padding: 0 0 1px 0; /*Fixed: last line underline overlap border*/ + margin: 4px 8px 4px 2px; + background-color: #FBFCFD; + border: 1px solid #C4CFE5; +} + +div.line { + font-family: monospace, fixed; + font-size: 13px; + min-height: 13px; + line-height: 1.0; + text-wrap: unrestricted; + white-space: -moz-pre-wrap; /* Moz */ + white-space: -pre-wrap; /* Opera 4-6 */ + white-space: -o-pre-wrap; /* Opera 7 */ + white-space: pre-wrap; /* CSS3 */ + word-wrap: break-word; /* IE 5.5+ */ + text-indent: -53px; + padding-left: 53px; + padding-bottom: 0px; + margin: 0px; + -webkit-transition-property: background-color, box-shadow; + -webkit-transition-duration: 0.5s; + -moz-transition-property: background-color, box-shadow; + -moz-transition-duration: 0.5s; + -ms-transition-property: background-color, box-shadow; + -ms-transition-duration: 0.5s; + -o-transition-property: background-color, box-shadow; + -o-transition-duration: 0.5s; + transition-property: background-color, box-shadow; + transition-duration: 0.5s; +} + +div.line:after { + content:"\000A"; + white-space: pre; +} + +div.line.glow { + background-color: cyan; + box-shadow: 0 0 10px cyan; +} + + +span.lineno { + padding-right: 4px; + text-align: right; + border-right: 2px solid #0F0; + background-color: #E8E8E8; + white-space: pre; +} +span.lineno a { + background-color: #D8D8D8; +} + +span.lineno a:hover { + background-color: #C8C8C8; +} + +.lineno { + -webkit-touch-callout: none; + -webkit-user-select: none; + -khtml-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; +} + +div.ah, span.ah { + background-color: black; + font-weight: bold; + color: #FFFFFF; + margin-bottom: 3px; + margin-top: 3px; + padding: 0.2em; + border: solid thin #333; + border-radius: 0.5em; + -webkit-border-radius: .5em; + -moz-border-radius: .5em; + box-shadow: 2px 2px 3px #999; + -webkit-box-shadow: 2px 2px 3px #999; + -moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px; + background-image: -webkit-gradient(linear, left top, left bottom, from(#eee), to(#000),color-stop(0.3, #444)); + background-image: -moz-linear-gradient(center top, #eee 0%, #444 40%, #000 110%); +} + +div.classindex ul { + list-style: none; + padding-left: 0; +} + +div.classindex span.ai { + display: inline-block; +} + +div.groupHeader { + margin-left: 16px; + margin-top: 12px; + font-weight: bold; +} + +div.groupText { + margin-left: 16px; + font-style: italic; +} + +body { + background-color: white; + color: black; + margin: 0; +} + +div.contents { + margin-top: 10px; + margin-left: 12px; + margin-right: 8px; +} + +td.indexkey { + background-color: #EBEFF6; + font-weight: bold; + border: 1px solid #C4CFE5; + margin: 2px 0px 2px 0; + padding: 2px 10px; + white-space: nowrap; + vertical-align: top; +} + +td.indexvalue { + background-color: #EBEFF6; + border: 1px solid #C4CFE5; + padding: 2px 10px; + margin: 2px 0px; +} + +tr.memlist { + background-color: #EEF1F7; +} + +p.formulaDsp { + text-align: center; +} + +img.formulaDsp { + +} + +img.formulaInl, img.inline { + vertical-align: middle; +} + +div.center { + text-align: center; + margin-top: 0px; + margin-bottom: 0px; + padding: 0px; +} + +div.center img { + border: 0px; +} + +address.footer { + text-align: right; + padding-right: 12px; +} + +img.footer { + border: 0px; + vertical-align: middle; +} + +/* @group Code Colorization */ + +span.keyword { + color: #008000 +} + +span.keywordtype { + color: #604020 +} + +span.keywordflow { + color: #e08000 +} + +span.comment { + color: #800000 +} + +span.preprocessor { + color: #806020 +} + +span.stringliteral { + color: #002080 +} + +span.charliteral { + color: #008080 +} + +span.vhdldigit { + color: #ff00ff +} + +span.vhdlchar { + color: #000000 +} + +span.vhdlkeyword { + color: #700070 +} + +span.vhdllogic { + color: #ff0000 +} + +blockquote { + background-color: #F7F8FB; + border-left: 2px solid #9CAFD4; + margin: 0 24px 0 4px; + padding: 0 12px 0 16px; +} + +blockquote.DocNodeRTL { + border-left: 0; + border-right: 2px solid #9CAFD4; + margin: 0 4px 0 24px; + padding: 0 16px 0 12px; +} + +/* @end */ + +/* +.search { + color: #003399; + font-weight: bold; +} + +form.search { + margin-bottom: 0px; + margin-top: 0px; +} + +input.search { + font-size: 75%; + color: #000080; + font-weight: normal; + background-color: #e8eef2; +} +*/ + +td.tiny { + font-size: 75%; +} + +.dirtab { + padding: 4px; + border-collapse: collapse; + border: 1px solid #A3B4D7; +} + +th.dirtab { + background: #EBEFF6; + font-weight: bold; +} + +hr { + height: 0px; + border: none; + border-top: 1px solid #4A6AAA; +} + +hr.footer { + height: 1px; +} + +/* @group Member Descriptions */ + +table.memberdecls { + border-spacing: 0px; + padding: 0px; +} + +.memberdecls td, .fieldtable tr { + -webkit-transition-property: background-color, box-shadow; + -webkit-transition-duration: 0.5s; + -moz-transition-property: background-color, box-shadow; + -moz-transition-duration: 0.5s; + -ms-transition-property: background-color, box-shadow; + -ms-transition-duration: 0.5s; + -o-transition-property: background-color, box-shadow; + -o-transition-duration: 0.5s; + transition-property: background-color, box-shadow; + transition-duration: 0.5s; +} + +.memberdecls td.glow, .fieldtable tr.glow { + background-color: cyan; + box-shadow: 0 0 15px cyan; +} + +.mdescLeft, .mdescRight, +.memItemLeft, .memItemRight, +.memTemplItemLeft, .memTemplItemRight, .memTemplParams { + background-color: #F9FAFC; + border: none; + margin: 4px; + padding: 1px 0 0 8px; +} + +.mdescLeft, .mdescRight { + padding: 0px 8px 4px 8px; + color: #555; +} + +.memSeparator { + border-bottom: 1px solid #DEE4F0; + line-height: 1px; + margin: 0px; + padding: 0px; +} + +.memItemLeft, .memTemplItemLeft { + white-space: nowrap; +} + +.memItemRight { + width: 100%; +} + +.memTemplParams { + color: #4665A2; + white-space: nowrap; + font-size: 80%; +} + +/* @end */ + +/* @group Member Details */ + +/* Styles for detailed member documentation */ + +.memtitle { + padding: 8px; + border-top: 1px solid #A8B8D9; + border-left: 1px solid #A8B8D9; + border-right: 1px solid #A8B8D9; + border-top-right-radius: 4px; + border-top-left-radius: 4px; + margin-bottom: -1px; + background-image: url('nav_f.png'); + background-repeat: repeat-x; + background-color: #E2E8F2; + line-height: 1.25; + font-weight: 300; + float:left; +} + +.permalink +{ + font-size: 65%; + display: inline-block; + vertical-align: middle; +} + +.memtemplate { + font-size: 80%; + color: #4665A2; + font-weight: normal; + margin-left: 9px; +} + +.memnav { + background-color: #EBEFF6; + border: 1px solid #A3B4D7; + text-align: center; + margin: 2px; + margin-right: 15px; + padding: 2px; +} + +.mempage { + width: 100%; +} + +.memitem { + padding: 0; + margin-bottom: 10px; + margin-right: 5px; + -webkit-transition: box-shadow 0.5s linear; + -moz-transition: box-shadow 0.5s linear; + -ms-transition: box-shadow 0.5s linear; + -o-transition: box-shadow 0.5s linear; + transition: box-shadow 0.5s linear; + display: table !important; + width: 100%; +} + +.memitem.glow { + box-shadow: 0 0 15px cyan; +} + +.memname { + font-weight: 400; + margin-left: 6px; +} + +.memname td { + vertical-align: bottom; +} + +.memproto, dl.reflist dt { + border-top: 1px solid #A8B8D9; + border-left: 1px solid #A8B8D9; + border-right: 1px solid #A8B8D9; + padding: 6px 0px 6px 0px; + color: #253555; + font-weight: bold; + text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9); + background-color: #DFE5F1; + /* opera specific markup */ + box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); + border-top-right-radius: 4px; + /* firefox specific markup */ + -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px; + -moz-border-radius-topright: 4px; + /* webkit specific markup */ + -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); + -webkit-border-top-right-radius: 4px; + +} + +.overload { + font-family: "courier new",courier,monospace; + font-size: 65%; +} + +.memdoc, dl.reflist dd { + border-bottom: 1px solid #A8B8D9; + border-left: 1px solid #A8B8D9; + border-right: 1px solid #A8B8D9; + padding: 6px 10px 2px 10px; + background-color: #FBFCFD; + border-top-width: 0; + background-image:url('nav_g.png'); + background-repeat:repeat-x; + background-color: #FFFFFF; + /* opera specific markup */ + border-bottom-left-radius: 4px; + border-bottom-right-radius: 4px; + box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); + /* firefox specific markup */ + -moz-border-radius-bottomleft: 4px; + -moz-border-radius-bottomright: 4px; + -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px; + /* webkit specific markup */ + -webkit-border-bottom-left-radius: 4px; + -webkit-border-bottom-right-radius: 4px; + -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); +} + +dl.reflist dt { + padding: 5px; +} + +dl.reflist dd { + margin: 0px 0px 10px 0px; + padding: 5px; +} + +.paramkey { + text-align: right; +} + +.paramtype { + white-space: nowrap; +} + +.paramname { + color: #602020; + white-space: nowrap; +} +.paramname em { + font-style: normal; +} +.paramname code { + line-height: 14px; +} + +.params, .retval, .exception, .tparams { + margin-left: 0px; + padding-left: 0px; +} + +.params .paramname, .retval .paramname, .tparams .paramname { + font-weight: bold; + vertical-align: top; +} + +.params .paramtype, .tparams .paramtype { + font-style: italic; + vertical-align: top; +} + +.params .paramdir, .tparams .paramdir { + font-family: "courier new",courier,monospace; + vertical-align: top; +} + +table.mlabels { + border-spacing: 0px; +} + +td.mlabels-left { + width: 100%; + padding: 0px; +} + +td.mlabels-right { + vertical-align: bottom; + padding: 0px; + white-space: nowrap; +} + +span.mlabels { + margin-left: 8px; +} + +span.mlabel { + background-color: #728DC1; + border-top:1px solid #5373B4; + border-left:1px solid #5373B4; + border-right:1px solid #C4CFE5; + border-bottom:1px solid #C4CFE5; + text-shadow: none; + color: white; + margin-right: 4px; + padding: 2px 3px; + border-radius: 3px; + font-size: 7pt; + white-space: nowrap; + vertical-align: middle; +} + + + +/* @end */ + +/* these are for tree view inside a (index) page */ + +div.directory { + margin: 10px 0px; + border-top: 1px solid #9CAFD4; + border-bottom: 1px solid #9CAFD4; + width: 100%; +} + +.directory table { + border-collapse:collapse; +} + +.directory td { + margin: 0px; + padding: 0px; + vertical-align: top; +} + +.directory td.entry { + white-space: nowrap; + padding-right: 6px; + padding-top: 3px; +} + +.directory td.entry a { + outline:none; +} + +.directory td.entry a img { + border: none; +} + +.directory td.desc { + width: 100%; + padding-left: 6px; + padding-right: 6px; + padding-top: 3px; + border-left: 1px solid rgba(0,0,0,0.05); +} + +.directory tr.even { + padding-left: 6px; + background-color: #F7F8FB; +} + +.directory img { + vertical-align: -30%; +} + +.directory .levels { + white-space: nowrap; + width: 100%; + text-align: right; + font-size: 9pt; +} + +.directory .levels span { + cursor: pointer; + padding-left: 2px; + padding-right: 2px; + color: #3D578C; +} + +.arrow { + color: #9CAFD4; + -webkit-user-select: none; + -khtml-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; + cursor: pointer; + font-size: 80%; + display: inline-block; + width: 16px; + height: 22px; +} + +.icon { + font-family: Arial, Helvetica; + font-weight: bold; + font-size: 12px; + height: 14px; + width: 16px; + display: inline-block; + background-color: #728DC1; + color: white; + text-align: center; + border-radius: 4px; + margin-left: 2px; + margin-right: 2px; +} + +.icona { + width: 24px; + height: 22px; + display: inline-block; +} + +.iconfopen { + width: 24px; + height: 18px; + margin-bottom: 4px; + background-image:url('folderopen.png'); + background-position: 0px -4px; + background-repeat: repeat-y; + vertical-align:top; + display: inline-block; +} + +.iconfclosed { + width: 24px; + height: 18px; + margin-bottom: 4px; + background-image:url('folderclosed.png'); + background-position: 0px -4px; + background-repeat: repeat-y; + vertical-align:top; + display: inline-block; +} + +.icondoc { + width: 24px; + height: 18px; + margin-bottom: 4px; + background-image:url('doc.png'); + background-position: 0px -4px; + background-repeat: repeat-y; + vertical-align:top; + display: inline-block; +} + +table.directory { + font: 400 14px Roboto,sans-serif; +} + +/* @end */ + +div.dynheader { + margin-top: 8px; + -webkit-touch-callout: none; + -webkit-user-select: none; + -khtml-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; +} + +address { + font-style: normal; + color: #2A3D61; +} + +table.doxtable caption { + caption-side: top; +} + +table.doxtable { + border-collapse:collapse; + margin-top: 4px; + margin-bottom: 4px; +} + +table.doxtable td, table.doxtable th { + border: 1px solid #2D4068; + padding: 3px 7px 2px; +} + +table.doxtable th { + background-color: #374F7F; + color: #FFFFFF; + font-size: 110%; + padding-bottom: 4px; + padding-top: 5px; +} + +table.fieldtable { + /*width: 100%;*/ + margin-bottom: 10px; + border: 1px solid #A8B8D9; + border-spacing: 0px; + -moz-border-radius: 4px; + -webkit-border-radius: 4px; + border-radius: 4px; + -moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px; + -webkit-box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15); + box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15); +} + +.fieldtable td, .fieldtable th { + padding: 3px 7px 2px; +} + +.fieldtable td.fieldtype, .fieldtable td.fieldname { + white-space: nowrap; + border-right: 1px solid #A8B8D9; + border-bottom: 1px solid #A8B8D9; + vertical-align: top; +} + +.fieldtable td.fieldname { + padding-top: 3px; +} + +.fieldtable td.fielddoc { + border-bottom: 1px solid #A8B8D9; + /*width: 100%;*/ +} + +.fieldtable td.fielddoc p:first-child { + margin-top: 0px; +} + +.fieldtable td.fielddoc p:last-child { + margin-bottom: 2px; +} + +.fieldtable tr:last-child td { + border-bottom: none; +} + +.fieldtable th { + background-image:url('nav_f.png'); + background-repeat:repeat-x; + background-color: #E2E8F2; + font-size: 90%; + color: #253555; + padding-bottom: 4px; + padding-top: 5px; + text-align:left; + font-weight: 400; + -moz-border-radius-topleft: 4px; + -moz-border-radius-topright: 4px; + -webkit-border-top-left-radius: 4px; + -webkit-border-top-right-radius: 4px; + border-top-left-radius: 4px; + border-top-right-radius: 4px; + border-bottom: 1px solid #A8B8D9; +} + + +.tabsearch { + top: 0px; + left: 10px; + height: 36px; + background-image: url('tab_b.png'); + z-index: 101; + overflow: hidden; + font-size: 13px; +} + +.navpath ul +{ + font-size: 11px; + background-image:url('tab_b.png'); + background-repeat:repeat-x; + background-position: 0 -5px; + height:30px; + line-height:30px; + color:#8AA0CC; + border:solid 1px #C2CDE4; + overflow:hidden; + margin:0px; + padding:0px; +} + +.navpath li +{ + list-style-type:none; + float:left; + padding-left:10px; + padding-right:15px; + background-image:url('bc_s.png'); + background-repeat:no-repeat; + background-position:right; + color:#364D7C; +} + +.navpath li.navelem a +{ + height:32px; + display:block; + text-decoration: none; + outline: none; + color: #283A5D; + font-family: 'Lucida Grande',Geneva,Helvetica,Arial,sans-serif; + text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9); + text-decoration: none; +} + +.navpath li.navelem a:hover +{ + color:#6884BD; +} + +.navpath li.footer +{ + list-style-type:none; + float:right; + padding-left:10px; + padding-right:15px; + background-image:none; + background-repeat:no-repeat; + background-position:right; + color:#364D7C; + font-size: 8pt; +} + + +div.summary +{ + float: right; + font-size: 8pt; + padding-right: 5px; + width: 50%; + text-align: right; +} + +div.summary a +{ + white-space: nowrap; +} + +table.classindex +{ + margin: 10px; + white-space: nowrap; + margin-left: 3%; + margin-right: 3%; + width: 94%; + border: 0; + border-spacing: 0; + padding: 0; +} + +div.ingroups +{ + font-size: 8pt; + width: 50%; + text-align: left; +} + +div.ingroups a +{ + white-space: nowrap; +} + +div.header +{ + background-image:url('nav_h.png'); + background-repeat:repeat-x; + background-color: #F9FAFC; + margin: 0px; + border-bottom: 1px solid #C4CFE5; +} + +div.headertitle +{ + padding: 5px 5px 5px 10px; +} + +.PageDocRTL-title div.headertitle { + text-align: right; + direction: rtl; +} + +dl { + padding: 0 0 0 0; +} + +/* dl.note, dl.warning, dl.attention, dl.pre, dl.post, dl.invariant, dl.deprecated, dl.todo, dl.test, dl.bug, dl.examples */ +dl.section { + margin-left: 0px; + padding-left: 0px; +} + +dl.section.DocNodeRTL { + margin-right: 0px; + padding-right: 0px; +} + +dl.note { + margin-left: -7px; + padding-left: 3px; + border-left: 4px solid; + border-color: #D0C000; +} + +dl.note.DocNodeRTL { + margin-left: 0; + padding-left: 0; + border-left: 0; + margin-right: -7px; + padding-right: 3px; + border-right: 4px solid; + border-color: #D0C000; +} + +dl.warning, dl.attention { + margin-left: -7px; + padding-left: 3px; + border-left: 4px solid; + border-color: #FF0000; +} + +dl.warning.DocNodeRTL, dl.attention.DocNodeRTL { + margin-left: 0; + padding-left: 0; + border-left: 0; + margin-right: -7px; + padding-right: 3px; + border-right: 4px solid; + border-color: #FF0000; +} + +dl.pre, dl.post, dl.invariant { + margin-left: -7px; + padding-left: 3px; + border-left: 4px solid; + border-color: #00D000; +} + +dl.pre.DocNodeRTL, dl.post.DocNodeRTL, dl.invariant.DocNodeRTL { + margin-left: 0; + padding-left: 0; + border-left: 0; + margin-right: -7px; + padding-right: 3px; + border-right: 4px solid; + border-color: #00D000; +} + +dl.deprecated { + margin-left: -7px; + padding-left: 3px; + border-left: 4px solid; + border-color: #505050; +} + +dl.deprecated.DocNodeRTL { + margin-left: 0; + padding-left: 0; + border-left: 0; + margin-right: -7px; + padding-right: 3px; + border-right: 4px solid; + border-color: #505050; +} + +dl.todo { + margin-left: -7px; + padding-left: 3px; + border-left: 4px solid; + border-color: #00C0E0; +} + +dl.todo.DocNodeRTL { + margin-left: 0; + padding-left: 0; + border-left: 0; + margin-right: -7px; + padding-right: 3px; + border-right: 4px solid; + border-color: #00C0E0; +} + +dl.test { + margin-left: -7px; + padding-left: 3px; + border-left: 4px solid; + border-color: #3030E0; +} + +dl.test.DocNodeRTL { + margin-left: 0; + padding-left: 0; + border-left: 0; + margin-right: -7px; + padding-right: 3px; + border-right: 4px solid; + border-color: #3030E0; +} + +dl.bug { + margin-left: -7px; + padding-left: 3px; + border-left: 4px solid; + border-color: #C08050; +} + +dl.bug.DocNodeRTL { + margin-left: 0; + padding-left: 0; + border-left: 0; + margin-right: -7px; + padding-right: 3px; + border-right: 4px solid; + border-color: #C08050; +} + +dl.section dd { + margin-bottom: 6px; +} + + +#projectlogo +{ + text-align: center; + vertical-align: bottom; + border-collapse: separate; +} + +#projectlogo img +{ + border: 0px none; +} + +#projectalign +{ + vertical-align: middle; +} + +#projectname +{ + font: 300% Tahoma, Arial,sans-serif; + margin: 0px; + padding: 2px 0px; +} + +#projectbrief +{ + font: 120% Tahoma, Arial,sans-serif; + margin: 0px; + padding: 0px; +} + +#projectnumber +{ + font: 50% Tahoma, Arial,sans-serif; + margin: 0px; + padding: 0px; +} + +#titlearea +{ + padding: 0px; + margin: 0px; + width: 100%; + border-bottom: 1px solid #5373B4; +} + +.image +{ + text-align: center; +} + +.dotgraph +{ + text-align: center; +} + +.mscgraph +{ + text-align: center; +} + +.plantumlgraph +{ + text-align: center; +} + +.diagraph +{ + text-align: center; +} + +.caption +{ + font-weight: bold; +} + +div.zoom +{ + border: 1px solid #90A5CE; +} + +dl.citelist { + margin-bottom:50px; +} + +dl.citelist dt { + color:#334975; + float:left; + font-weight:bold; + margin-right:10px; + padding:5px; +} + +dl.citelist dd { + margin:2px 0; + padding:5px 0; +} + +div.toc { + padding: 14px 25px; + background-color: #F4F6FA; + border: 1px solid #D8DFEE; + border-radius: 7px 7px 7px 7px; + float: right; + height: auto; + margin: 0 8px 10px 10px; + width: 200px; +} + +.PageDocRTL-title div.toc { + float: left !important; + text-align: right; +} + +div.toc li { + background: url("bdwn.png") no-repeat scroll 0 5px transparent; + font: 10px/1.2 Verdana,DejaVu Sans,Geneva,sans-serif; + margin-top: 5px; + padding-left: 10px; + padding-top: 2px; +} + +.PageDocRTL-title div.toc li { + background-position-x: right !important; + padding-left: 0 !important; + padding-right: 10px; +} + +div.toc h3 { + font: bold 12px/1.2 Arial,FreeSans,sans-serif; + color: #4665A2; + border-bottom: 0 none; + margin: 0; +} + +div.toc ul { + list-style: none outside none; + border: medium none; + padding: 0px; +} + +div.toc li.level1 { + margin-left: 0px; +} + +div.toc li.level2 { + margin-left: 15px; +} + +div.toc li.level3 { + margin-left: 30px; +} + +div.toc li.level4 { + margin-left: 45px; +} + +.PageDocRTL-title div.toc li.level1 { + margin-left: 0 !important; + margin-right: 0; +} + +.PageDocRTL-title div.toc li.level2 { + margin-left: 0 !important; + margin-right: 15px; +} + +.PageDocRTL-title div.toc li.level3 { + margin-left: 0 !important; + margin-right: 30px; +} + +.PageDocRTL-title div.toc li.level4 { + margin-left: 0 !important; + margin-right: 45px; +} + +.inherit_header { + font-weight: bold; + color: gray; + cursor: pointer; + -webkit-touch-callout: none; + -webkit-user-select: none; + -khtml-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; +} + +.inherit_header td { + padding: 6px 0px 2px 5px; +} + +.inherit { + display: none; +} + +tr.heading h2 { + margin-top: 12px; + margin-bottom: 4px; +} + +/* tooltip related style info */ + +.ttc { + position: absolute; + display: none; +} + +#powerTip { + cursor: default; + white-space: nowrap; + background-color: white; + border: 1px solid gray; + border-radius: 4px 4px 4px 4px; + box-shadow: 1px 1px 7px gray; + display: none; + font-size: smaller; + max-width: 80%; + opacity: 0.9; + padding: 1ex 1em 1em; + position: absolute; + z-index: 2147483647; +} + +#powerTip div.ttdoc { + color: grey; + font-style: italic; +} + +#powerTip div.ttname a { + font-weight: bold; +} + +#powerTip div.ttname { + font-weight: bold; +} + +#powerTip div.ttdeci { + color: #006318; +} + +#powerTip div { + margin: 0px; + padding: 0px; + font: 12px/16px Roboto,sans-serif; +} + +#powerTip:before, #powerTip:after { + content: ""; + position: absolute; + margin: 0px; +} + +#powerTip.n:after, #powerTip.n:before, +#powerTip.s:after, #powerTip.s:before, +#powerTip.w:after, #powerTip.w:before, +#powerTip.e:after, #powerTip.e:before, +#powerTip.ne:after, #powerTip.ne:before, +#powerTip.se:after, #powerTip.se:before, +#powerTip.nw:after, #powerTip.nw:before, +#powerTip.sw:after, #powerTip.sw:before { + border: solid transparent; + content: " "; + height: 0; + width: 0; + position: absolute; +} + +#powerTip.n:after, #powerTip.s:after, +#powerTip.w:after, #powerTip.e:after, +#powerTip.nw:after, #powerTip.ne:after, +#powerTip.sw:after, #powerTip.se:after { + border-color: rgba(255, 255, 255, 0); +} + +#powerTip.n:before, #powerTip.s:before, +#powerTip.w:before, #powerTip.e:before, +#powerTip.nw:before, #powerTip.ne:before, +#powerTip.sw:before, #powerTip.se:before { + border-color: rgba(128, 128, 128, 0); +} + +#powerTip.n:after, #powerTip.n:before, +#powerTip.ne:after, #powerTip.ne:before, +#powerTip.nw:after, #powerTip.nw:before { + top: 100%; +} + +#powerTip.n:after, #powerTip.ne:after, #powerTip.nw:after { + border-top-color: #FFFFFF; + border-width: 10px; + margin: 0px -10px; +} +#powerTip.n:before { + border-top-color: #808080; + border-width: 11px; + margin: 0px -11px; +} +#powerTip.n:after, #powerTip.n:before { + left: 50%; +} + +#powerTip.nw:after, #powerTip.nw:before { + right: 14px; +} + +#powerTip.ne:after, #powerTip.ne:before { + left: 14px; +} + +#powerTip.s:after, #powerTip.s:before, +#powerTip.se:after, #powerTip.se:before, +#powerTip.sw:after, #powerTip.sw:before { + bottom: 100%; +} + +#powerTip.s:after, #powerTip.se:after, #powerTip.sw:after { + border-bottom-color: #FFFFFF; + border-width: 10px; + margin: 0px -10px; +} + +#powerTip.s:before, #powerTip.se:before, #powerTip.sw:before { + border-bottom-color: #808080; + border-width: 11px; + margin: 0px -11px; +} + +#powerTip.s:after, #powerTip.s:before { + left: 50%; +} + +#powerTip.sw:after, #powerTip.sw:before { + right: 14px; +} + +#powerTip.se:after, #powerTip.se:before { + left: 14px; +} + +#powerTip.e:after, #powerTip.e:before { + left: 100%; +} +#powerTip.e:after { + border-left-color: #FFFFFF; + border-width: 10px; + top: 50%; + margin-top: -10px; +} +#powerTip.e:before { + border-left-color: #808080; + border-width: 11px; + top: 50%; + margin-top: -11px; +} + +#powerTip.w:after, #powerTip.w:before { + right: 100%; +} +#powerTip.w:after { + border-right-color: #FFFFFF; + border-width: 10px; + top: 50%; + margin-top: -10px; +} +#powerTip.w:before { + border-right-color: #808080; + border-width: 11px; + top: 50%; + margin-top: -11px; +} + +@media print +{ + #top { display: none; } + #side-nav { display: none; } + #nav-path { display: none; } + body { overflow:visible; } + h1, h2, h3, h4, h5, h6 { page-break-after: avoid; } + .summary { display: none; } + .memitem { page-break-inside: avoid; } + #doc-content + { + margin-left:0 !important; + height:auto !important; + width:auto !important; + overflow:inherit; + display:inline; + } +} + +/* @group Markdown */ + +/* +table.markdownTable { + border-collapse:collapse; + margin-top: 4px; + margin-bottom: 4px; +} + +table.markdownTable td, table.markdownTable th { + border: 1px solid #2D4068; + padding: 3px 7px 2px; +} + +table.markdownTableHead tr { +} + +table.markdownTableBodyLeft td, table.markdownTable th { + border: 1px solid #2D4068; + padding: 3px 7px 2px; +} + +th.markdownTableHeadLeft th.markdownTableHeadRight th.markdownTableHeadCenter th.markdownTableHeadNone { + background-color: #374F7F; + color: #FFFFFF; + font-size: 110%; + padding-bottom: 4px; + padding-top: 5px; +} + +th.markdownTableHeadLeft { + text-align: left +} + +th.markdownTableHeadRight { + text-align: right +} + +th.markdownTableHeadCenter { + text-align: center +} +*/ + +table.markdownTable { + border-collapse:collapse; + margin-top: 4px; + margin-bottom: 4px; +} + +table.markdownTable td, table.markdownTable th { + border: 1px solid #2D4068; + padding: 3px 7px 2px; +} + +table.markdownTable tr { +} + +th.markdownTableHeadLeft, th.markdownTableHeadRight, th.markdownTableHeadCenter, th.markdownTableHeadNone { + background-color: #374F7F; + color: #FFFFFF; + font-size: 110%; + padding-bottom: 4px; + padding-top: 5px; +} + +th.markdownTableHeadLeft, td.markdownTableBodyLeft { + text-align: left +} + +th.markdownTableHeadRight, td.markdownTableBodyRight { + text-align: right +} + +th.markdownTableHeadCenter, td.markdownTableBodyCenter { + text-align: center +} + +.DocNodeRTL { + text-align: right; + direction: rtl; +} + +.DocNodeLTR { + text-align: left; + direction: ltr; +} + +table.DocNodeRTL { + width: auto; + margin-right: 0; + margin-left: auto; +} + +table.DocNodeLTR { + width: auto; + margin-right: auto; + margin-left: 0; +} + +tt, code, kbd, samp +{ + display: inline-block; + direction:ltr; +} +/* @end */ + +u { + text-decoration: underline; +} + diff --git a/sw-modules/module-package-reader/docs/doxygen.png b/sw-modules/module-package-reader/docs/doxygen.png new file mode 100644 index 0000000..3ff17d8 Binary files /dev/null and b/sw-modules/module-package-reader/docs/doxygen.png differ diff --git a/sw-modules/module-package-reader/docs/dynsections.js b/sw-modules/module-package-reader/docs/dynsections.js new file mode 100644 index 0000000..9bff51b --- /dev/null +++ b/sw-modules/module-package-reader/docs/dynsections.js @@ -0,0 +1,127 @@ +/* + @licstart The following is the entire license notice for the + JavaScript code in this file. + + Copyright (C) 1997-2017 by Dimitri van Heesch + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + + @licend The above is the entire license notice + for the JavaScript code in this file + */ +function toggleVisibility(linkObj) +{ + var base = $(linkObj).attr('id'); + var summary = $('#'+base+'-summary'); + var content = $('#'+base+'-content'); + var trigger = $('#'+base+'-trigger'); + var src=$(trigger).attr('src'); + if (content.is(':visible')===true) { + content.hide(); + summary.show(); + $(linkObj).addClass('closed').removeClass('opened'); + $(trigger).attr('src',src.substring(0,src.length-8)+'closed.png'); + } else { + content.show(); + summary.hide(); + $(linkObj).removeClass('closed').addClass('opened'); + $(trigger).attr('src',src.substring(0,src.length-10)+'open.png'); + } + return false; +} + +function updateStripes() +{ + $('table.directory tr'). + removeClass('even').filter(':visible:even').addClass('even'); +} + +function toggleLevel(level) +{ + $('table.directory tr').each(function() { + var l = this.id.split('_').length-1; + var i = $('#img'+this.id.substring(3)); + var a = $('#arr'+this.id.substring(3)); + if (l + + + + + + +MQTT Communication: File List + + + + + + + + + + + + + + +
+
+ + + + + + +
+
MQTT Communication +
+
Smart Factory
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
File List
+
+
+
Here is a list of all files with brief descriptions:
+ + + + + + + + + + + +
 CommunicationConfiguration.hFile that contains the default communication configuration
 MQTTCommunication.cppImplementation of the Connection class
 MQTTCommunication.hThe Connection-class is used as interface
 myJSON.cppImplementation of the myJSON-class
 myJSON.hMyJSON class handels the conversion from the JSON-Format into a struct
 myJSONStr.hMyJSON Struct defines the format of the messages
 myMQTT.cppImplementation of the myMQTT class
 myMQTT.hThis class handels the MQTT connection
 Network.cppImplementation of the Network class
 Network.hThe Network class establishes a WLAN-Connection
+
+
+
+ + + + diff --git a/sw-modules/module-package-reader/docs/files_dup.js b/sw-modules/module-package-reader/docs/files_dup.js new file mode 100644 index 0000000..9488d61 --- /dev/null +++ b/sw-modules/module-package-reader/docs/files_dup.js @@ -0,0 +1,21 @@ +var files_dup = +[ + [ "CommunicationConfiguration.h", "_communication_configuration_8h.html", "_communication_configuration_8h" ], + [ "MQTTCommunication.cpp", "_m_q_t_t_communication_8cpp.html", "_m_q_t_t_communication_8cpp" ], + [ "MQTTCommunication.h", "_m_q_t_t_communication_8h.html", "_m_q_t_t_communication_8h" ], + [ "myJSON.cpp", "my_j_s_o_n_8cpp.html", null ], + [ "myJSON.h", "my_j_s_o_n_8h.html", [ + [ "myJSON", "classmy_j_s_o_n.html", "classmy_j_s_o_n" ] + ] ], + [ "myJSONStr.h", "my_j_s_o_n_str_8h.html", [ + [ "myJSONStr", "structmy_j_s_o_n_str.html", "structmy_j_s_o_n_str" ] + ] ], + [ "myMQTT.cpp", "my_m_q_t_t_8cpp.html", null ], + [ "myMQTT.h", "my_m_q_t_t_8h.html", [ + [ "myMQTT", "classmy_m_q_t_t.html", "classmy_m_q_t_t" ] + ] ], + [ "Network.cpp", "_network_8cpp.html", null ], + [ "Network.h", "_network_8h.html", [ + [ "Network", "class_network.html", "class_network" ] + ] ] +]; \ No newline at end of file diff --git a/sw-modules/module-package-reader/docs/folderclosed.png b/sw-modules/module-package-reader/docs/folderclosed.png new file mode 100644 index 0000000..bb8ab35 Binary files /dev/null and b/sw-modules/module-package-reader/docs/folderclosed.png differ diff --git a/sw-modules/module-package-reader/docs/folderopen.png b/sw-modules/module-package-reader/docs/folderopen.png new file mode 100644 index 0000000..d6c7f67 Binary files /dev/null and b/sw-modules/module-package-reader/docs/folderopen.png differ diff --git a/sw-modules/module-package-reader/docs/functions.html b/sw-modules/module-package-reader/docs/functions.html new file mode 100644 index 0000000..82c891a --- /dev/null +++ b/sw-modules/module-package-reader/docs/functions.html @@ -0,0 +1,345 @@ + + + + + + + +MQTT Communication: Class Members + + + + + + + + + + + + + + +
+
+ + + + + + +
+
MQTT Communication +
+
Smart Factory
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
Here is a list of all class members with links to the classes they belong to:
+ +

- a -

+ + +

- c -

+ + +

- d -

    +
  • decodeEncryptionType() +: Network +
    • +
  • decodeMQTTstate() +: myMQTT +
    • +
  • decodeWiFistate() +: Network +
    • +
+ + +

- e -

+ + +

- f -

+ + +

- g -

+ + +

- i -

+ + +

- l -

+ + +

- m -

+ + +

- n -

+ + +

- p -

+ + +

- r -

+ + +

- s -

+ + +

- t -

+ + +

- u -

+
+
+ + + + diff --git a/sw-modules/module-package-reader/docs/functions_func.html b/sw-modules/module-package-reader/docs/functions_func.html new file mode 100644 index 0000000..22e2122 --- /dev/null +++ b/sw-modules/module-package-reader/docs/functions_func.html @@ -0,0 +1,235 @@ + + + + + + + +MQTT Communication: Class Members - Functions + + + + + + + + + + + + + + +
+
+ + + + + + +
+
MQTT Communication +
+
Smart Factory
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+  + +

- c -

+ + +

- d -

    +
  • decodeEncryptionType() +: Network +
    • +
  • decodeMQTTstate() +: myMQTT +
    • +
  • decodeWiFistate() +: Network +
    • +
+ + +

- f -

+ + +

- g -

+ + +

- i -

+ + +

- l -

+ + +

- m -

+ + +

- n -

+ + +

- p -

+ + +

- s -

+ + +

- u -

+
+
+ + + + diff --git a/sw-modules/module-package-reader/docs/functions_vars.html b/sw-modules/module-package-reader/docs/functions_vars.html new file mode 100644 index 0000000..62ead2c --- /dev/null +++ b/sw-modules/module-package-reader/docs/functions_vars.html @@ -0,0 +1,238 @@ + + + + + + + +MQTT Communication: Class Members - Variables + + + + + + + + + + + + + + +
+
+ + + + + + +
+
MQTT Communication +
+
Smart Factory
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+  + +

- a -

+ + +

- c -

+ + +

- e -

+ + +

- f -

+ + +

- i -

+ + +

- l -

+ + +

- m -

+ + +

- p -

+ + +

- r -

+ + +

- s -

+ + +

- t -

+
+
+ + + + diff --git a/sw-modules/module-package-reader/docs/globals.html b/sw-modules/module-package-reader/docs/globals.html new file mode 100644 index 0000000..0470dfa --- /dev/null +++ b/sw-modules/module-package-reader/docs/globals.html @@ -0,0 +1,153 @@ + + + + + + + +MQTT Communication: File Members + + + + + + + + + + + + + + +
+
+ + + + + + +
+
MQTT Communication +
+
Smart Factory
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
Here is a list of all file members with links to the files they belong to:
+
+
+ + + + diff --git a/sw-modules/module-package-reader/docs/globals_defs.html b/sw-modules/module-package-reader/docs/globals_defs.html new file mode 100644 index 0000000..24cf741 --- /dev/null +++ b/sw-modules/module-package-reader/docs/globals_defs.html @@ -0,0 +1,141 @@ + + + + + + + +MQTT Communication: File Members + + + + + + + + + + + + + + +
+
+ + + + + + +
+
MQTT Communication +
+
Smart Factory
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+  +
+
+ + + + diff --git a/sw-modules/module-package-reader/docs/globals_func.html b/sw-modules/module-package-reader/docs/globals_func.html new file mode 100644 index 0000000..8693971 --- /dev/null +++ b/sw-modules/module-package-reader/docs/globals_func.html @@ -0,0 +1,106 @@ + + + + + + + +MQTT Communication: File Members + + + + + + + + + + + + + + +
+
+ + + + + + +
+
MQTT Communication +
+
Smart Factory
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+  +
+
+ + + + diff --git a/sw-modules/module-package-reader/docs/globals_vars.html b/sw-modules/module-package-reader/docs/globals_vars.html new file mode 100644 index 0000000..31543fd --- /dev/null +++ b/sw-modules/module-package-reader/docs/globals_vars.html @@ -0,0 +1,110 @@ + + + + + + + +MQTT Communication: File Members + + + + + + + + + + + + + + +
+
+ + + + + + +
+
MQTT Communication +
+
Smart Factory
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+  +
+
+ + + + diff --git a/sw-modules/module-package-reader/docs/graph_legend.html b/sw-modules/module-package-reader/docs/graph_legend.html new file mode 100644 index 0000000..6e6e6ca --- /dev/null +++ b/sw-modules/module-package-reader/docs/graph_legend.html @@ -0,0 +1,131 @@ + + + + + + + +MQTT Communication: Graph Legend + + + + + + + + + + + + + + +
+
+ + + + + + +
+
MQTT Communication +
+
Smart Factory
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
Graph Legend
+
+
+

This page explains how to interpret the graphs that are generated by doxygen.

+

Consider the following example:

/*! Invisible class because of truncation */
class Invisible { };
/*! Truncated class, inheritance relation is hidden */
class Truncated : public Invisible { };
/* Class not documented with doxygen comments */
class Undocumented { };
/*! Class that is inherited using public inheritance */
class PublicBase : public Truncated { };
/*! A template class */
template<class T> class Templ { };
/*! Class that is inherited using protected inheritance */
class ProtectedBase { };
/*! Class that is inherited using private inheritance */
class PrivateBase { };
/*! Class that is used by the Inherited class */
class Used { };
/*! Super class that inherits a number of other classes */
class Inherited : public PublicBase,
protected ProtectedBase,
private PrivateBase,
public Undocumented,
public Templ<int>
{
private:
Used *m_usedClass;
};

This will result in the following graph:

+
+

The boxes in the above graph have the following meaning:

+
    +
  • +A filled gray box represents the struct or class for which the graph is generated.
    • +
  • +A box with a black border denotes a documented struct or class.
    • +
  • +A box with a gray border denotes an undocumented struct or class.
    • +
  • +A box with a red border denotes a documented struct or class forwhich not all inheritance/containment relations are shown. A graph is truncated if it does not fit within the specified boundaries.
    • +
+

The arrows have the following meaning:

+
    +
  • +A dark blue arrow is used to visualize a public inheritance relation between two classes.
    • +
  • +A dark green arrow is used for protected inheritance.
    • +
  • +A dark red arrow is used for private inheritance.
    • +
  • +A purple dashed arrow is used if a class is contained or used by another class. The arrow is labelled with the variable(s) through which the pointed class or struct is accessible.
    • +
  • +A yellow dashed arrow denotes a relation between a template instance and the template class it was instantiated from. The arrow is labelled with the template parameters of the instance.
    • +
+
+
+ + + + diff --git a/sw-modules/module-package-reader/docs/graph_legend.md5 b/sw-modules/module-package-reader/docs/graph_legend.md5 new file mode 100644 index 0000000..3b4f8ab --- /dev/null +++ b/sw-modules/module-package-reader/docs/graph_legend.md5 @@ -0,0 +1 @@ +2779a1676ca72f29ac6dddfb5b5a4bb2 \ No newline at end of file diff --git a/sw-modules/module-package-reader/docs/graph_legend.png b/sw-modules/module-package-reader/docs/graph_legend.png new file mode 100644 index 0000000..e303709 Binary files /dev/null and b/sw-modules/module-package-reader/docs/graph_legend.png differ diff --git a/sw-modules/module-package-reader/docs/images/Circular_Buffer_Animation.gif b/sw-modules/module-package-reader/docs/images/Circular_Buffer_Animation.gif new file mode 100644 index 0000000..8ffda04 Binary files /dev/null and b/sw-modules/module-package-reader/docs/images/Circular_Buffer_Animation.gif differ diff --git a/sw-modules/module-package-reader/docs/images/MQTTPublishSubscribe.png b/sw-modules/module-package-reader/docs/images/MQTTPublishSubscribe.png new file mode 100644 index 0000000..760ea93 Binary files /dev/null and b/sw-modules/module-package-reader/docs/images/MQTTPublishSubscribe.png differ diff --git a/sw-modules/module-package-reader/docs/images/MQTTTopics.png b/sw-modules/module-package-reader/docs/images/MQTTTopics.png new file mode 100644 index 0000000..9fe1d44 Binary files /dev/null and b/sw-modules/module-package-reader/docs/images/MQTTTopics.png differ diff --git a/sw-modules/module-package-reader/docs/images/RepoOverview.png b/sw-modules/module-package-reader/docs/images/RepoOverview.png new file mode 100644 index 0000000..63b7de0 Binary files /dev/null and b/sw-modules/module-package-reader/docs/images/RepoOverview.png differ diff --git a/sw-modules/module-package-reader/docs/index.html b/sw-modules/module-package-reader/docs/index.html new file mode 100644 index 0000000..036b6cd --- /dev/null +++ b/sw-modules/module-package-reader/docs/index.html @@ -0,0 +1,104 @@ + + + + + + + +MQTT Communication: Main Page + + + + + + + + + + + + + + +
+
+ + + + + + +
+
MQTT Communication +
+
Smart Factory
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
MQTT Communication Documentation
+
+
+
+
+ + + + diff --git a/sw-modules/module-package-reader/docs/jquery.js b/sw-modules/module-package-reader/docs/jquery.js new file mode 100644 index 0000000..1ee895c --- /dev/null +++ b/sw-modules/module-package-reader/docs/jquery.js @@ -0,0 +1,87 @@ +/*! + * jQuery JavaScript Library v1.7.2 + * http://jquery.com/ + * + * Copyright 2011, John Resig + * Dual licensed under the MIT or GPL Version 2 licenses. + * http://jquery.org/license + * + * Includes Sizzle.js + * http://sizzlejs.com/ + * Copyright 2011, The Dojo Foundation + * Released under the MIT, BSD, and GPL Licenses. + * + * Date: Wed Mar 21 12:46:34 2012 -0700 + */ +(function(bd,L){var av=bd.document,bu=bd.navigator,bm=bd.location;var b=(function(){var bF=function(b0,b1){return new bF.fn.init(b0,b1,bD)},bU=bd.jQuery,bH=bd.$,bD,bY=/^(?:[^#<]*(<[\w\W]+>)[^>]*$|#([\w\-]*)$)/,bM=/\S/,bI=/^\s+/,bE=/\s+$/,bA=/^<(\w+)\s*\/?>(?:<\/\1>)?$/,bN=/^[\],:{}\s]*$/,bW=/\\(?:["\\\/bfnrt]|u[0-9a-fA-F]{4})/g,bP=/"[^"\\\n\r]*"|true|false|null|-?\d+(?:\.\d*)?(?:[eE][+\-]?\d+)?/g,bJ=/(?:^|:|,)(?:\s*\[)+/g,by=/(webkit)[ \/]([\w.]+)/,bR=/(opera)(?:.*version)?[ \/]([\w.]+)/,bQ=/(msie) ([\w.]+)/,bS=/(mozilla)(?:.*? rv:([\w.]+))?/,bB=/-([a-z]|[0-9])/ig,bZ=/^-ms-/,bT=function(b0,b1){return(b1+"").toUpperCase()},bX=bu.userAgent,bV,bC,e,bL=Object.prototype.toString,bG=Object.prototype.hasOwnProperty,bz=Array.prototype.push,bK=Array.prototype.slice,bO=String.prototype.trim,bv=Array.prototype.indexOf,bx={};bF.fn=bF.prototype={constructor:bF,init:function(b0,b4,b3){var b2,b5,b1,b6;if(!b0){return this}if(b0.nodeType){this.context=this[0]=b0;this.length=1;return this}if(b0==="body"&&!b4&&av.body){this.context=av;this[0]=av.body;this.selector=b0;this.length=1;return this}if(typeof b0==="string"){if(b0.charAt(0)==="<"&&b0.charAt(b0.length-1)===">"&&b0.length>=3){b2=[null,b0,null]}else{b2=bY.exec(b0)}if(b2&&(b2[1]||!b4)){if(b2[1]){b4=b4 instanceof bF?b4[0]:b4;b6=(b4?b4.ownerDocument||b4:av);b1=bA.exec(b0);if(b1){if(bF.isPlainObject(b4)){b0=[av.createElement(b1[1])];bF.fn.attr.call(b0,b4,true)}else{b0=[b6.createElement(b1[1])]}}else{b1=bF.buildFragment([b2[1]],[b6]);b0=(b1.cacheable?bF.clone(b1.fragment):b1.fragment).childNodes}return bF.merge(this,b0)}else{b5=av.getElementById(b2[2]);if(b5&&b5.parentNode){if(b5.id!==b2[2]){return b3.find(b0)}this.length=1;this[0]=b5}this.context=av;this.selector=b0;return this}}else{if(!b4||b4.jquery){return(b4||b3).find(b0)}else{return this.constructor(b4).find(b0)}}}else{if(bF.isFunction(b0)){return b3.ready(b0)}}if(b0.selector!==L){this.selector=b0.selector;this.context=b0.context}return bF.makeArray(b0,this)},selector:"",jquery:"1.7.2",length:0,size:function(){return this.length},toArray:function(){return bK.call(this,0)},get:function(b0){return b0==null?this.toArray():(b0<0?this[this.length+b0]:this[b0])},pushStack:function(b1,b3,b0){var b2=this.constructor();if(bF.isArray(b1)){bz.apply(b2,b1)}else{bF.merge(b2,b1)}b2.prevObject=this;b2.context=this.context;if(b3==="find"){b2.selector=this.selector+(this.selector?" ":"")+b0}else{if(b3){b2.selector=this.selector+"."+b3+"("+b0+")"}}return b2},each:function(b1,b0){return bF.each(this,b1,b0)},ready:function(b0){bF.bindReady();bC.add(b0);return this},eq:function(b0){b0=+b0;return b0===-1?this.slice(b0):this.slice(b0,b0+1)},first:function(){return this.eq(0)},last:function(){return this.eq(-1)},slice:function(){return this.pushStack(bK.apply(this,arguments),"slice",bK.call(arguments).join(","))},map:function(b0){return this.pushStack(bF.map(this,function(b2,b1){return b0.call(b2,b1,b2)}))},end:function(){return this.prevObject||this.constructor(null)},push:bz,sort:[].sort,splice:[].splice};bF.fn.init.prototype=bF.fn;bF.extend=bF.fn.extend=function(){var b9,b2,b0,b1,b6,b7,b5=arguments[0]||{},b4=1,b3=arguments.length,b8=false;if(typeof b5==="boolean"){b8=b5;b5=arguments[1]||{};b4=2}if(typeof b5!=="object"&&!bF.isFunction(b5)){b5={}}if(b3===b4){b5=this;--b4}for(;b40){return}bC.fireWith(av,[bF]);if(bF.fn.trigger){bF(av).trigger("ready").off("ready")}}},bindReady:function(){if(bC){return}bC=bF.Callbacks("once memory");if(av.readyState==="complete"){return setTimeout(bF.ready,1)}if(av.addEventListener){av.addEventListener("DOMContentLoaded",e,false);bd.addEventListener("load",bF.ready,false)}else{if(av.attachEvent){av.attachEvent("onreadystatechange",e);bd.attachEvent("onload",bF.ready);var b0=false;try{b0=bd.frameElement==null}catch(b1){}if(av.documentElement.doScroll&&b0){bw()}}}},isFunction:function(b0){return bF.type(b0)==="function"},isArray:Array.isArray||function(b0){return bF.type(b0)==="array"},isWindow:function(b0){return b0!=null&&b0==b0.window},isNumeric:function(b0){return !isNaN(parseFloat(b0))&&isFinite(b0)},type:function(b0){return b0==null?String(b0):bx[bL.call(b0)]||"object"},isPlainObject:function(b2){if(!b2||bF.type(b2)!=="object"||b2.nodeType||bF.isWindow(b2)){return false}try{if(b2.constructor&&!bG.call(b2,"constructor")&&!bG.call(b2.constructor.prototype,"isPrototypeOf")){return false}}catch(b1){return false}var b0;for(b0 in b2){}return b0===L||bG.call(b2,b0)},isEmptyObject:function(b1){for(var b0 in b1){return false}return true},error:function(b0){throw new Error(b0)},parseJSON:function(b0){if(typeof b0!=="string"||!b0){return null}b0=bF.trim(b0);if(bd.JSON&&bd.JSON.parse){return bd.JSON.parse(b0)}if(bN.test(b0.replace(bW,"@").replace(bP,"]").replace(bJ,""))){return(new Function("return "+b0))()}bF.error("Invalid JSON: "+b0)},parseXML:function(b2){if(typeof b2!=="string"||!b2){return null}var b0,b1;try{if(bd.DOMParser){b1=new DOMParser();b0=b1.parseFromString(b2,"text/xml")}else{b0=new ActiveXObject("Microsoft.XMLDOM");b0.async="false";b0.loadXML(b2)}}catch(b3){b0=L}if(!b0||!b0.documentElement||b0.getElementsByTagName("parsererror").length){bF.error("Invalid XML: "+b2)}return b0},noop:function(){},globalEval:function(b0){if(b0&&bM.test(b0)){(bd.execScript||function(b1){bd["eval"].call(bd,b1)})(b0)}},camelCase:function(b0){return b0.replace(bZ,"ms-").replace(bB,bT)},nodeName:function(b1,b0){return b1.nodeName&&b1.nodeName.toUpperCase()===b0.toUpperCase()},each:function(b3,b6,b2){var b1,b4=0,b5=b3.length,b0=b5===L||bF.isFunction(b3);if(b2){if(b0){for(b1 in b3){if(b6.apply(b3[b1],b2)===false){break}}}else{for(;b40&&b0[0]&&b0[b1-1])||b1===0||bF.isArray(b0));if(b3){for(;b21?aK.call(arguments,0):bG;if(!(--bw)){bC.resolveWith(bC,bx)}}}function bz(bF){return function(bG){bB[bF]=arguments.length>1?aK.call(arguments,0):bG;bC.notifyWith(bE,bB)}}if(e>1){for(;bv
a";bH=bv.getElementsByTagName("*");bE=bv.getElementsByTagName("a")[0];if(!bH||!bH.length||!bE){return{}}bF=av.createElement("select");bx=bF.appendChild(av.createElement("option"));bD=bv.getElementsByTagName("input")[0];bI={leadingWhitespace:(bv.firstChild.nodeType===3),tbody:!bv.getElementsByTagName("tbody").length,htmlSerialize:!!bv.getElementsByTagName("link").length,style:/top/.test(bE.getAttribute("style")),hrefNormalized:(bE.getAttribute("href")==="/a"),opacity:/^0.55/.test(bE.style.opacity),cssFloat:!!bE.style.cssFloat,checkOn:(bD.value==="on"),optSelected:bx.selected,getSetAttribute:bv.className!=="t",enctype:!!av.createElement("form").enctype,html5Clone:av.createElement("nav").cloneNode(true).outerHTML!=="<:nav>",submitBubbles:true,changeBubbles:true,focusinBubbles:false,deleteExpando:true,noCloneEvent:true,inlineBlockNeedsLayout:false,shrinkWrapBlocks:false,reliableMarginRight:true,pixelMargin:true};b.boxModel=bI.boxModel=(av.compatMode==="CSS1Compat");bD.checked=true;bI.noCloneChecked=bD.cloneNode(true).checked;bF.disabled=true;bI.optDisabled=!bx.disabled;try{delete bv.test}catch(bB){bI.deleteExpando=false}if(!bv.addEventListener&&bv.attachEvent&&bv.fireEvent){bv.attachEvent("onclick",function(){bI.noCloneEvent=false});bv.cloneNode(true).fireEvent("onclick")}bD=av.createElement("input");bD.value="t";bD.setAttribute("type","radio");bI.radioValue=bD.value==="t";bD.setAttribute("checked","checked");bD.setAttribute("name","t");bv.appendChild(bD);bC=av.createDocumentFragment();bC.appendChild(bv.lastChild);bI.checkClone=bC.cloneNode(true).cloneNode(true).lastChild.checked;bI.appendChecked=bD.checked;bC.removeChild(bD);bC.appendChild(bv);if(bv.attachEvent){for(by in {submit:1,change:1,focusin:1}){bA="on"+by;bw=(bA in bv);if(!bw){bv.setAttribute(bA,"return;");bw=(typeof bv[bA]==="function")}bI[by+"Bubbles"]=bw}}bC.removeChild(bv);bC=bF=bx=bv=bD=null;b(function(){var bM,bV,bW,bU,bO,bP,bR,bL,bK,bQ,bN,e,bT,bS=av.getElementsByTagName("body")[0];if(!bS){return}bL=1;bT="padding:0;margin:0;border:";bN="position:absolute;top:0;left:0;width:1px;height:1px;";e=bT+"0;visibility:hidden;";bK="style='"+bN+bT+"5px solid #000;";bQ="
";bM=av.createElement("div");bM.style.cssText=e+"width:0;height:0;position:static;top:0;margin-top:"+bL+"px";bS.insertBefore(bM,bS.firstChild);bv=av.createElement("div");bM.appendChild(bv);bv.innerHTML="
t
";bz=bv.getElementsByTagName("td");bw=(bz[0].offsetHeight===0);bz[0].style.display="";bz[1].style.display="none";bI.reliableHiddenOffsets=bw&&(bz[0].offsetHeight===0);if(bd.getComputedStyle){bv.innerHTML="";bR=av.createElement("div");bR.style.width="0";bR.style.marginRight="0";bv.style.width="2px";bv.appendChild(bR);bI.reliableMarginRight=(parseInt((bd.getComputedStyle(bR,null)||{marginRight:0}).marginRight,10)||0)===0}if(typeof bv.style.zoom!=="undefined"){bv.innerHTML="";bv.style.width=bv.style.padding="1px";bv.style.border=0;bv.style.overflow="hidden";bv.style.display="inline";bv.style.zoom=1;bI.inlineBlockNeedsLayout=(bv.offsetWidth===3);bv.style.display="block";bv.style.overflow="visible";bv.innerHTML="
";bI.shrinkWrapBlocks=(bv.offsetWidth!==3)}bv.style.cssText=bN+e;bv.innerHTML=bQ;bV=bv.firstChild;bW=bV.firstChild;bO=bV.nextSibling.firstChild.firstChild;bP={doesNotAddBorder:(bW.offsetTop!==5),doesAddBorderForTableAndCells:(bO.offsetTop===5)};bW.style.position="fixed";bW.style.top="20px";bP.fixedPosition=(bW.offsetTop===20||bW.offsetTop===15);bW.style.position=bW.style.top="";bV.style.overflow="hidden";bV.style.position="relative";bP.subtractsBorderForOverflowNotVisible=(bW.offsetTop===-5);bP.doesNotIncludeMarginInBodyOffset=(bS.offsetTop!==bL);if(bd.getComputedStyle){bv.style.marginTop="1%";bI.pixelMargin=(bd.getComputedStyle(bv,null)||{marginTop:0}).marginTop!=="1%"}if(typeof bM.style.zoom!=="undefined"){bM.style.zoom=1}bS.removeChild(bM);bR=bv=bM=null;b.extend(bI,bP)});return bI})();var aT=/^(?:\{.*\}|\[.*\])$/,aA=/([A-Z])/g;b.extend({cache:{},uuid:0,expando:"jQuery"+(b.fn.jquery+Math.random()).replace(/\D/g,""),noData:{embed:true,object:"clsid:D27CDB6E-AE6D-11cf-96B8-444553540000",applet:true},hasData:function(e){e=e.nodeType?b.cache[e[b.expando]]:e[b.expando];return !!e&&!S(e)},data:function(bx,bv,bz,by){if(!b.acceptData(bx)){return}var bG,bA,bD,bE=b.expando,bC=typeof bv==="string",bF=bx.nodeType,e=bF?b.cache:bx,bw=bF?bx[bE]:bx[bE]&&bE,bB=bv==="events";if((!bw||!e[bw]||(!bB&&!by&&!e[bw].data))&&bC&&bz===L){return}if(!bw){if(bF){bx[bE]=bw=++b.uuid}else{bw=bE}}if(!e[bw]){e[bw]={};if(!bF){e[bw].toJSON=b.noop}}if(typeof bv==="object"||typeof bv==="function"){if(by){e[bw]=b.extend(e[bw],bv)}else{e[bw].data=b.extend(e[bw].data,bv)}}bG=bA=e[bw];if(!by){if(!bA.data){bA.data={}}bA=bA.data}if(bz!==L){bA[b.camelCase(bv)]=bz}if(bB&&!bA[bv]){return bG.events}if(bC){bD=bA[bv];if(bD==null){bD=bA[b.camelCase(bv)]}}else{bD=bA}return bD},removeData:function(bx,bv,by){if(!b.acceptData(bx)){return}var bB,bA,bz,bC=b.expando,bD=bx.nodeType,e=bD?b.cache:bx,bw=bD?bx[bC]:bC;if(!e[bw]){return}if(bv){bB=by?e[bw]:e[bw].data;if(bB){if(!b.isArray(bv)){if(bv in bB){bv=[bv]}else{bv=b.camelCase(bv);if(bv in bB){bv=[bv]}else{bv=bv.split(" ")}}}for(bA=0,bz=bv.length;bA1,null,false)},removeData:function(e){return this.each(function(){b.removeData(this,e)})}});function a6(bx,bw,by){if(by===L&&bx.nodeType===1){var bv="data-"+bw.replace(aA,"-$1").toLowerCase();by=bx.getAttribute(bv);if(typeof by==="string"){try{by=by==="true"?true:by==="false"?false:by==="null"?null:b.isNumeric(by)?+by:aT.test(by)?b.parseJSON(by):by}catch(bz){}b.data(bx,bw,by)}else{by=L}}return by}function S(bv){for(var e in bv){if(e==="data"&&b.isEmptyObject(bv[e])){continue}if(e!=="toJSON"){return false}}return true}function bj(by,bx,bA){var bw=bx+"defer",bv=bx+"queue",e=bx+"mark",bz=b._data(by,bw);if(bz&&(bA==="queue"||!b._data(by,bv))&&(bA==="mark"||!b._data(by,e))){setTimeout(function(){if(!b._data(by,bv)&&!b._data(by,e)){b.removeData(by,bw,true);bz.fire()}},0)}}b.extend({_mark:function(bv,e){if(bv){e=(e||"fx")+"mark";b._data(bv,e,(b._data(bv,e)||0)+1)}},_unmark:function(by,bx,bv){if(by!==true){bv=bx;bx=by;by=false}if(bx){bv=bv||"fx";var e=bv+"mark",bw=by?0:((b._data(bx,e)||1)-1);if(bw){b._data(bx,e,bw)}else{b.removeData(bx,e,true);bj(bx,bv,"mark")}}},queue:function(bv,e,bx){var bw;if(bv){e=(e||"fx")+"queue";bw=b._data(bv,e);if(bx){if(!bw||b.isArray(bx)){bw=b._data(bv,e,b.makeArray(bx))}else{bw.push(bx)}}return bw||[]}},dequeue:function(by,bx){bx=bx||"fx";var bv=b.queue(by,bx),bw=bv.shift(),e={};if(bw==="inprogress"){bw=bv.shift()}if(bw){if(bx==="fx"){bv.unshift("inprogress")}b._data(by,bx+".run",e);bw.call(by,function(){b.dequeue(by,bx)},e)}if(!bv.length){b.removeData(by,bx+"queue "+bx+".run",true);bj(by,bx,"queue")}}});b.fn.extend({queue:function(e,bv){var bw=2;if(typeof e!=="string"){bv=e;e="fx";bw--}if(arguments.length1)},removeAttr:function(e){return this.each(function(){b.removeAttr(this,e)})},prop:function(e,bv){return b.access(this,b.prop,e,bv,arguments.length>1)},removeProp:function(e){e=b.propFix[e]||e;return this.each(function(){try{this[e]=L;delete this[e]}catch(bv){}})},addClass:function(by){var bA,bw,bv,bx,bz,bB,e;if(b.isFunction(by)){return this.each(function(bC){b(this).addClass(by.call(this,bC,this.className))})}if(by&&typeof by==="string"){bA=by.split(ag);for(bw=0,bv=this.length;bw-1){return true}}return false},val:function(bx){var e,bv,by,bw=this[0];if(!arguments.length){if(bw){e=b.valHooks[bw.type]||b.valHooks[bw.nodeName.toLowerCase()];if(e&&"get" in e&&(bv=e.get(bw,"value"))!==L){return bv}bv=bw.value;return typeof bv==="string"?bv.replace(aV,""):bv==null?"":bv}return}by=b.isFunction(bx);return this.each(function(bA){var bz=b(this),bB;if(this.nodeType!==1){return}if(by){bB=bx.call(this,bA,bz.val())}else{bB=bx}if(bB==null){bB=""}else{if(typeof bB==="number"){bB+=""}else{if(b.isArray(bB)){bB=b.map(bB,function(bC){return bC==null?"":bC+""})}}}e=b.valHooks[this.type]||b.valHooks[this.nodeName.toLowerCase()];if(!e||!("set" in e)||e.set(this,bB,"value")===L){this.value=bB}})}});b.extend({valHooks:{option:{get:function(e){var bv=e.attributes.value;return !bv||bv.specified?e.value:e.text}},select:{get:function(e){var bA,bv,bz,bx,by=e.selectedIndex,bB=[],bC=e.options,bw=e.type==="select-one";if(by<0){return null}bv=bw?by:0;bz=bw?by+1:bC.length;for(;bv=0});if(!e.length){bv.selectedIndex=-1}return e}}},attrFn:{val:true,css:true,html:true,text:true,data:true,width:true,height:true,offset:true},attr:function(bA,bx,bB,bz){var bw,e,by,bv=bA.nodeType;if(!bA||bv===3||bv===8||bv===2){return}if(bz&&bx in b.attrFn){return b(bA)[bx](bB)}if(typeof bA.getAttribute==="undefined"){return b.prop(bA,bx,bB)}by=bv!==1||!b.isXMLDoc(bA);if(by){bx=bx.toLowerCase();e=b.attrHooks[bx]||(ao.test(bx)?aZ:bf)}if(bB!==L){if(bB===null){b.removeAttr(bA,bx);return}else{if(e&&"set" in e&&by&&(bw=e.set(bA,bB,bx))!==L){return bw}else{bA.setAttribute(bx,""+bB);return bB}}}else{if(e&&"get" in e&&by&&(bw=e.get(bA,bx))!==null){return bw}else{bw=bA.getAttribute(bx);return bw===null?L:bw}}},removeAttr:function(by,bA){var bz,bB,bw,e,bv,bx=0;if(bA&&by.nodeType===1){bB=bA.toLowerCase().split(ag);e=bB.length;for(;bx=0)}}})});var be=/^(?:textarea|input|select)$/i,n=/^([^\.]*)?(?:\.(.+))?$/,J=/(?:^|\s)hover(\.\S+)?\b/,aP=/^key/,bg=/^(?:mouse|contextmenu)|click/,T=/^(?:focusinfocus|focusoutblur)$/,U=/^(\w*)(?:#([\w\-]+))?(?:\.([\w\-]+))?$/,Y=function(e){var bv=U.exec(e);if(bv){bv[1]=(bv[1]||"").toLowerCase();bv[3]=bv[3]&&new RegExp("(?:^|\\s)"+bv[3]+"(?:\\s|$)")}return bv},j=function(bw,e){var bv=bw.attributes||{};return((!e[1]||bw.nodeName.toLowerCase()===e[1])&&(!e[2]||(bv.id||{}).value===e[2])&&(!e[3]||e[3].test((bv["class"]||{}).value)))},bt=function(e){return b.event.special.hover?e:e.replace(J,"mouseenter$1 mouseleave$1")};b.event={add:function(bx,bC,bJ,bA,by){var bD,bB,bK,bI,bH,bF,e,bG,bv,bz,bw,bE;if(bx.nodeType===3||bx.nodeType===8||!bC||!bJ||!(bD=b._data(bx))){return}if(bJ.handler){bv=bJ;bJ=bv.handler;by=bv.selector}if(!bJ.guid){bJ.guid=b.guid++}bK=bD.events;if(!bK){bD.events=bK={}}bB=bD.handle;if(!bB){bD.handle=bB=function(bL){return typeof b!=="undefined"&&(!bL||b.event.triggered!==bL.type)?b.event.dispatch.apply(bB.elem,arguments):L};bB.elem=bx}bC=b.trim(bt(bC)).split(" ");for(bI=0;bI=0){bG=bG.slice(0,-1);bw=true}if(bG.indexOf(".")>=0){bx=bG.split(".");bG=bx.shift();bx.sort()}if((!bA||b.event.customEvent[bG])&&!b.event.global[bG]){return}bv=typeof bv==="object"?bv[b.expando]?bv:new b.Event(bG,bv):new b.Event(bG);bv.type=bG;bv.isTrigger=true;bv.exclusive=bw;bv.namespace=bx.join(".");bv.namespace_re=bv.namespace?new RegExp("(^|\\.)"+bx.join("\\.(?:.*\\.)?")+"(\\.|$)"):null;by=bG.indexOf(":")<0?"on"+bG:"";if(!bA){e=b.cache;for(bC in e){if(e[bC].events&&e[bC].events[bG]){b.event.trigger(bv,bD,e[bC].handle.elem,true)}}return}bv.result=L;if(!bv.target){bv.target=bA}bD=bD!=null?b.makeArray(bD):[];bD.unshift(bv);bF=b.event.special[bG]||{};if(bF.trigger&&bF.trigger.apply(bA,bD)===false){return}bB=[[bA,bF.bindType||bG]];if(!bJ&&!bF.noBubble&&!b.isWindow(bA)){bI=bF.delegateType||bG;bH=T.test(bI+bG)?bA:bA.parentNode;bz=null;for(;bH;bH=bH.parentNode){bB.push([bH,bI]);bz=bH}if(bz&&bz===bA.ownerDocument){bB.push([bz.defaultView||bz.parentWindow||bd,bI])}}for(bC=0;bCbC){bv.push({elem:this,matches:bD.slice(bC)})}for(bJ=0;bJ0?this.on(e,null,bx,bw):this.trigger(e)};if(b.attrFn){b.attrFn[e]=true}if(aP.test(e)){b.event.fixHooks[e]=b.event.keyHooks}if(bg.test(e)){b.event.fixHooks[e]=b.event.mouseHooks}}); +/*! + * Sizzle CSS Selector Engine + * Copyright 2011, The Dojo Foundation + * Released under the MIT, BSD, and GPL Licenses. + * More information: http://sizzlejs.com/ + */ +(function(){var bH=/((?:\((?:\([^()]+\)|[^()]+)+\)|\[(?:\[[^\[\]]*\]|['"][^'"]*['"]|[^\[\]'"]+)+\]|\\.|[^ >+~,(\[\\]+)+|[>+~])(\s*,\s*)?((?:.|\r|\n)*)/g,bC="sizcache"+(Math.random()+"").replace(".",""),bI=0,bL=Object.prototype.toString,bB=false,bA=true,bK=/\\/g,bO=/\r\n/g,bQ=/\W/;[0,0].sort(function(){bA=false;return 0});var by=function(bV,e,bY,bZ){bY=bY||[];e=e||av;var b1=e;if(e.nodeType!==1&&e.nodeType!==9){return[]}if(!bV||typeof bV!=="string"){return bY}var bS,b3,b6,bR,b2,b5,b4,bX,bU=true,bT=by.isXML(e),bW=[],b0=bV;do{bH.exec("");bS=bH.exec(b0);if(bS){b0=bS[3];bW.push(bS[1]);if(bS[2]){bR=bS[3];break}}}while(bS);if(bW.length>1&&bD.exec(bV)){if(bW.length===2&&bE.relative[bW[0]]){b3=bM(bW[0]+bW[1],e,bZ)}else{b3=bE.relative[bW[0]]?[e]:by(bW.shift(),e);while(bW.length){bV=bW.shift();if(bE.relative[bV]){bV+=bW.shift()}b3=bM(bV,b3,bZ)}}}else{if(!bZ&&bW.length>1&&e.nodeType===9&&!bT&&bE.match.ID.test(bW[0])&&!bE.match.ID.test(bW[bW.length-1])){b2=by.find(bW.shift(),e,bT);e=b2.expr?by.filter(b2.expr,b2.set)[0]:b2.set[0]}if(e){b2=bZ?{expr:bW.pop(),set:bF(bZ)}:by.find(bW.pop(),bW.length===1&&(bW[0]==="~"||bW[0]==="+")&&e.parentNode?e.parentNode:e,bT);b3=b2.expr?by.filter(b2.expr,b2.set):b2.set;if(bW.length>0){b6=bF(b3)}else{bU=false}while(bW.length){b5=bW.pop();b4=b5;if(!bE.relative[b5]){b5=""}else{b4=bW.pop()}if(b4==null){b4=e}bE.relative[b5](b6,b4,bT)}}else{b6=bW=[]}}if(!b6){b6=b3}if(!b6){by.error(b5||bV)}if(bL.call(b6)==="[object Array]"){if(!bU){bY.push.apply(bY,b6)}else{if(e&&e.nodeType===1){for(bX=0;b6[bX]!=null;bX++){if(b6[bX]&&(b6[bX]===true||b6[bX].nodeType===1&&by.contains(e,b6[bX]))){bY.push(b3[bX])}}}else{for(bX=0;b6[bX]!=null;bX++){if(b6[bX]&&b6[bX].nodeType===1){bY.push(b3[bX])}}}}}else{bF(b6,bY)}if(bR){by(bR,b1,bY,bZ);by.uniqueSort(bY)}return bY};by.uniqueSort=function(bR){if(bJ){bB=bA;bR.sort(bJ);if(bB){for(var e=1;e0};by.find=function(bX,e,bY){var bW,bS,bU,bT,bV,bR;if(!bX){return[]}for(bS=0,bU=bE.order.length;bS":function(bW,bR){var bV,bU=typeof bR==="string",bS=0,e=bW.length;if(bU&&!bQ.test(bR)){bR=bR.toLowerCase();for(;bS=0)){if(!bS){e.push(bV)}}else{if(bS){bR[bU]=false}}}}return false},ID:function(e){return e[1].replace(bK,"")},TAG:function(bR,e){return bR[1].replace(bK,"").toLowerCase()},CHILD:function(e){if(e[1]==="nth"){if(!e[2]){by.error(e[0])}e[2]=e[2].replace(/^\+|\s*/g,"");var bR=/(-?)(\d*)(?:n([+\-]?\d*))?/.exec(e[2]==="even"&&"2n"||e[2]==="odd"&&"2n+1"||!/\D/.test(e[2])&&"0n+"+e[2]||e[2]);e[2]=(bR[1]+(bR[2]||1))-0;e[3]=bR[3]-0}else{if(e[2]){by.error(e[0])}}e[0]=bI++;return e},ATTR:function(bU,bR,bS,e,bV,bW){var bT=bU[1]=bU[1].replace(bK,"");if(!bW&&bE.attrMap[bT]){bU[1]=bE.attrMap[bT]}bU[4]=(bU[4]||bU[5]||"").replace(bK,"");if(bU[2]==="~="){bU[4]=" "+bU[4]+" "}return bU},PSEUDO:function(bU,bR,bS,e,bV){if(bU[1]==="not"){if((bH.exec(bU[3])||"").length>1||/^\w/.test(bU[3])){bU[3]=by(bU[3],null,null,bR)}else{var bT=by.filter(bU[3],bR,bS,true^bV);if(!bS){e.push.apply(e,bT)}return false}}else{if(bE.match.POS.test(bU[0])||bE.match.CHILD.test(bU[0])){return true}}return bU},POS:function(e){e.unshift(true);return e}},filters:{enabled:function(e){return e.disabled===false&&e.type!=="hidden"},disabled:function(e){return e.disabled===true},checked:function(e){return e.checked===true},selected:function(e){if(e.parentNode){e.parentNode.selectedIndex}return e.selected===true},parent:function(e){return !!e.firstChild},empty:function(e){return !e.firstChild},has:function(bS,bR,e){return !!by(e[3],bS).length},header:function(e){return(/h\d/i).test(e.nodeName)},text:function(bS){var e=bS.getAttribute("type"),bR=bS.type;return bS.nodeName.toLowerCase()==="input"&&"text"===bR&&(e===bR||e===null)},radio:function(e){return e.nodeName.toLowerCase()==="input"&&"radio"===e.type},checkbox:function(e){return e.nodeName.toLowerCase()==="input"&&"checkbox"===e.type},file:function(e){return e.nodeName.toLowerCase()==="input"&&"file"===e.type},password:function(e){return e.nodeName.toLowerCase()==="input"&&"password"===e.type},submit:function(bR){var e=bR.nodeName.toLowerCase();return(e==="input"||e==="button")&&"submit"===bR.type},image:function(e){return e.nodeName.toLowerCase()==="input"&&"image"===e.type},reset:function(bR){var e=bR.nodeName.toLowerCase();return(e==="input"||e==="button")&&"reset"===bR.type},button:function(bR){var e=bR.nodeName.toLowerCase();return e==="input"&&"button"===bR.type||e==="button"},input:function(e){return(/input|select|textarea|button/i).test(e.nodeName)},focus:function(e){return e===e.ownerDocument.activeElement}},setFilters:{first:function(bR,e){return e===0},last:function(bS,bR,e,bT){return bR===bT.length-1},even:function(bR,e){return e%2===0},odd:function(bR,e){return e%2===1},lt:function(bS,bR,e){return bRe[3]-0},nth:function(bS,bR,e){return e[3]-0===bR},eq:function(bS,bR,e){return e[3]-0===bR}},filter:{PSEUDO:function(bS,bX,bW,bY){var e=bX[1],bR=bE.filters[e];if(bR){return bR(bS,bW,bX,bY)}else{if(e==="contains"){return(bS.textContent||bS.innerText||bw([bS])||"").indexOf(bX[3])>=0}else{if(e==="not"){var bT=bX[3];for(var bV=0,bU=bT.length;bV=0)}}},ID:function(bR,e){return bR.nodeType===1&&bR.getAttribute("id")===e},TAG:function(bR,e){return(e==="*"&&bR.nodeType===1)||!!bR.nodeName&&bR.nodeName.toLowerCase()===e},CLASS:function(bR,e){return(" "+(bR.className||bR.getAttribute("class"))+" ").indexOf(e)>-1},ATTR:function(bV,bT){var bS=bT[1],e=by.attr?by.attr(bV,bS):bE.attrHandle[bS]?bE.attrHandle[bS](bV):bV[bS]!=null?bV[bS]:bV.getAttribute(bS),bW=e+"",bU=bT[2],bR=bT[4];return e==null?bU==="!=":!bU&&by.attr?e!=null:bU==="="?bW===bR:bU==="*="?bW.indexOf(bR)>=0:bU==="~="?(" "+bW+" ").indexOf(bR)>=0:!bR?bW&&e!==false:bU==="!="?bW!==bR:bU==="^="?bW.indexOf(bR)===0:bU==="$="?bW.substr(bW.length-bR.length)===bR:bU==="|="?bW===bR||bW.substr(0,bR.length+1)===bR+"-":false},POS:function(bU,bR,bS,bV){var e=bR[2],bT=bE.setFilters[e];if(bT){return bT(bU,bS,bR,bV)}}}};var bD=bE.match.POS,bx=function(bR,e){return"\\"+(e-0+1)};for(var bz in bE.match){bE.match[bz]=new RegExp(bE.match[bz].source+(/(?![^\[]*\])(?![^\(]*\))/.source));bE.leftMatch[bz]=new RegExp(/(^(?:.|\r|\n)*?)/.source+bE.match[bz].source.replace(/\\(\d+)/g,bx))}bE.match.globalPOS=bD;var bF=function(bR,e){bR=Array.prototype.slice.call(bR,0);if(e){e.push.apply(e,bR);return e}return bR};try{Array.prototype.slice.call(av.documentElement.childNodes,0)[0].nodeType}catch(bP){bF=function(bU,bT){var bS=0,bR=bT||[];if(bL.call(bU)==="[object Array]"){Array.prototype.push.apply(bR,bU)}else{if(typeof bU.length==="number"){for(var e=bU.length;bS";e.insertBefore(bR,e.firstChild);if(av.getElementById(bS)){bE.find.ID=function(bU,bV,bW){if(typeof bV.getElementById!=="undefined"&&!bW){var bT=bV.getElementById(bU[1]);return bT?bT.id===bU[1]||typeof bT.getAttributeNode!=="undefined"&&bT.getAttributeNode("id").nodeValue===bU[1]?[bT]:L:[]}};bE.filter.ID=function(bV,bT){var bU=typeof bV.getAttributeNode!=="undefined"&&bV.getAttributeNode("id");return bV.nodeType===1&&bU&&bU.nodeValue===bT}}e.removeChild(bR);e=bR=null})();(function(){var e=av.createElement("div");e.appendChild(av.createComment(""));if(e.getElementsByTagName("*").length>0){bE.find.TAG=function(bR,bV){var bU=bV.getElementsByTagName(bR[1]);if(bR[1]==="*"){var bT=[];for(var bS=0;bU[bS];bS++){if(bU[bS].nodeType===1){bT.push(bU[bS])}}bU=bT}return bU}}e.innerHTML="";if(e.firstChild&&typeof e.firstChild.getAttribute!=="undefined"&&e.firstChild.getAttribute("href")!=="#"){bE.attrHandle.href=function(bR){return bR.getAttribute("href",2)}}e=null})();if(av.querySelectorAll){(function(){var e=by,bT=av.createElement("div"),bS="__sizzle__";bT.innerHTML="

";if(bT.querySelectorAll&&bT.querySelectorAll(".TEST").length===0){return}by=function(b4,bV,bZ,b3){bV=bV||av;if(!b3&&!by.isXML(bV)){var b2=/^(\w+$)|^\.([\w\-]+$)|^#([\w\-]+$)/.exec(b4);if(b2&&(bV.nodeType===1||bV.nodeType===9)){if(b2[1]){return bF(bV.getElementsByTagName(b4),bZ)}else{if(b2[2]&&bE.find.CLASS&&bV.getElementsByClassName){return bF(bV.getElementsByClassName(b2[2]),bZ)}}}if(bV.nodeType===9){if(b4==="body"&&bV.body){return bF([bV.body],bZ)}else{if(b2&&b2[3]){var bY=bV.getElementById(b2[3]);if(bY&&bY.parentNode){if(bY.id===b2[3]){return bF([bY],bZ)}}else{return bF([],bZ)}}}try{return bF(bV.querySelectorAll(b4),bZ)}catch(b0){}}else{if(bV.nodeType===1&&bV.nodeName.toLowerCase()!=="object"){var bW=bV,bX=bV.getAttribute("id"),bU=bX||bS,b6=bV.parentNode,b5=/^\s*[+~]/.test(b4);if(!bX){bV.setAttribute("id",bU)}else{bU=bU.replace(/'/g,"\\$&")}if(b5&&b6){bV=bV.parentNode}try{if(!b5||b6){return bF(bV.querySelectorAll("[id='"+bU+"'] "+b4),bZ)}}catch(b1){}finally{if(!bX){bW.removeAttribute("id")}}}}}return e(b4,bV,bZ,b3)};for(var bR in e){by[bR]=e[bR]}bT=null})()}(function(){var e=av.documentElement,bS=e.matchesSelector||e.mozMatchesSelector||e.webkitMatchesSelector||e.msMatchesSelector;if(bS){var bU=!bS.call(av.createElement("div"),"div"),bR=false;try{bS.call(av.documentElement,"[test!='']:sizzle")}catch(bT){bR=true}by.matchesSelector=function(bW,bY){bY=bY.replace(/\=\s*([^'"\]]*)\s*\]/g,"='$1']");if(!by.isXML(bW)){try{if(bR||!bE.match.PSEUDO.test(bY)&&!/!=/.test(bY)){var bV=bS.call(bW,bY);if(bV||!bU||bW.document&&bW.document.nodeType!==11){return bV}}}catch(bX){}}return by(bY,null,null,[bW]).length>0}}})();(function(){var e=av.createElement("div");e.innerHTML="
";if(!e.getElementsByClassName||e.getElementsByClassName("e").length===0){return}e.lastChild.className="e";if(e.getElementsByClassName("e").length===1){return}bE.order.splice(1,0,"CLASS");bE.find.CLASS=function(bR,bS,bT){if(typeof bS.getElementsByClassName!=="undefined"&&!bT){return bS.getElementsByClassName(bR[1])}};e=null})();function bv(bR,bW,bV,bZ,bX,bY){for(var bT=0,bS=bZ.length;bT0){bU=e;break}}}e=e[bR]}bZ[bT]=bU}}}if(av.documentElement.contains){by.contains=function(bR,e){return bR!==e&&(bR.contains?bR.contains(e):true)}}else{if(av.documentElement.compareDocumentPosition){by.contains=function(bR,e){return !!(bR.compareDocumentPosition(e)&16)}}else{by.contains=function(){return false}}}by.isXML=function(e){var bR=(e?e.ownerDocument||e:0).documentElement;return bR?bR.nodeName!=="HTML":false};var bM=function(bS,e,bW){var bV,bX=[],bU="",bY=e.nodeType?[e]:e;while((bV=bE.match.PSEUDO.exec(bS))){bU+=bV[0];bS=bS.replace(bE.match.PSEUDO,"")}bS=bE.relative[bS]?bS+"*":bS;for(var bT=0,bR=bY.length;bT0){for(bB=bA;bB=0:b.filter(e,this).length>0:this.filter(e).length>0)},closest:function(by,bx){var bv=[],bw,e,bz=this[0];if(b.isArray(by)){var bB=1;while(bz&&bz.ownerDocument&&bz!==bx){for(bw=0;bw-1:b.find.matchesSelector(bz,by)){bv.push(bz);break}else{bz=bz.parentNode;if(!bz||!bz.ownerDocument||bz===bx||bz.nodeType===11){break}}}}bv=bv.length>1?b.unique(bv):bv;return this.pushStack(bv,"closest",by)},index:function(e){if(!e){return(this[0]&&this[0].parentNode)?this.prevAll().length:-1}if(typeof e==="string"){return b.inArray(this[0],b(e))}return b.inArray(e.jquery?e[0]:e,this)},add:function(e,bv){var bx=typeof e==="string"?b(e,bv):b.makeArray(e&&e.nodeType?[e]:e),bw=b.merge(this.get(),bx);return this.pushStack(B(bx[0])||B(bw[0])?bw:b.unique(bw))},andSelf:function(){return this.add(this.prevObject)}});function B(e){return !e||!e.parentNode||e.parentNode.nodeType===11}b.each({parent:function(bv){var e=bv.parentNode;return e&&e.nodeType!==11?e:null},parents:function(e){return b.dir(e,"parentNode")},parentsUntil:function(bv,e,bw){return b.dir(bv,"parentNode",bw)},next:function(e){return b.nth(e,2,"nextSibling")},prev:function(e){return b.nth(e,2,"previousSibling")},nextAll:function(e){return b.dir(e,"nextSibling")},prevAll:function(e){return b.dir(e,"previousSibling")},nextUntil:function(bv,e,bw){return b.dir(bv,"nextSibling",bw)},prevUntil:function(bv,e,bw){return b.dir(bv,"previousSibling",bw)},siblings:function(e){return b.sibling((e.parentNode||{}).firstChild,e)},children:function(e){return b.sibling(e.firstChild)},contents:function(e){return b.nodeName(e,"iframe")?e.contentDocument||e.contentWindow.document:b.makeArray(e.childNodes)}},function(e,bv){b.fn[e]=function(by,bw){var bx=b.map(this,bv,by);if(!ab.test(e)){bw=by}if(bw&&typeof bw==="string"){bx=b.filter(bw,bx)}bx=this.length>1&&!ay[e]?b.unique(bx):bx;if((this.length>1||bb.test(bw))&&aq.test(e)){bx=bx.reverse()}return this.pushStack(bx,e,P.call(arguments).join(","))}});b.extend({filter:function(bw,e,bv){if(bv){bw=":not("+bw+")"}return e.length===1?b.find.matchesSelector(e[0],bw)?[e[0]]:[]:b.find.matches(bw,e)},dir:function(bw,bv,by){var e=[],bx=bw[bv];while(bx&&bx.nodeType!==9&&(by===L||bx.nodeType!==1||!b(bx).is(by))){if(bx.nodeType===1){e.push(bx)}bx=bx[bv]}return e},nth:function(by,e,bw,bx){e=e||1;var bv=0;for(;by;by=by[bw]){if(by.nodeType===1&&++bv===e){break}}return by},sibling:function(bw,bv){var e=[];for(;bw;bw=bw.nextSibling){if(bw.nodeType===1&&bw!==bv){e.push(bw)}}return e}});function aH(bx,bw,e){bw=bw||0;if(b.isFunction(bw)){return b.grep(bx,function(bz,by){var bA=!!bw.call(bz,by,bz);return bA===e})}else{if(bw.nodeType){return b.grep(bx,function(bz,by){return(bz===bw)===e})}else{if(typeof bw==="string"){var bv=b.grep(bx,function(by){return by.nodeType===1});if(bp.test(bw)){return b.filter(bw,bv,!e)}else{bw=b.filter(bw,bv)}}}}return b.grep(bx,function(bz,by){return(b.inArray(bz,bw)>=0)===e})}function a(e){var bw=aS.split("|"),bv=e.createDocumentFragment();if(bv.createElement){while(bw.length){bv.createElement(bw.pop())}}return bv}var aS="abbr|article|aside|audio|bdi|canvas|data|datalist|details|figcaption|figure|footer|header|hgroup|mark|meter|nav|output|progress|section|summary|time|video",ah=/ jQuery\d+="(?:\d+|null)"/g,ar=/^\s+/,R=/<(?!area|br|col|embed|hr|img|input|link|meta|param)(([\w:]+)[^>]*)\/>/ig,d=/<([\w:]+)/,v=/]","i"),o=/checked\s*(?:[^=]|=\s*.checked.)/i,bn=/\/(java|ecma)script/i,aO=/^\s*",""],legend:[1,"
","
"],thead:[1,"","
"],tr:[2,"","
"],td:[3,"","
"],col:[2,"","
"],area:[1,"",""],_default:[0,"",""]},ac=a(av);ax.optgroup=ax.option;ax.tbody=ax.tfoot=ax.colgroup=ax.caption=ax.thead;ax.th=ax.td;if(!b.support.htmlSerialize){ax._default=[1,"div
","
"]}b.fn.extend({text:function(e){return b.access(this,function(bv){return bv===L?b.text(this):this.empty().append((this[0]&&this[0].ownerDocument||av).createTextNode(bv))},null,e,arguments.length)},wrapAll:function(e){if(b.isFunction(e)){return this.each(function(bw){b(this).wrapAll(e.call(this,bw))})}if(this[0]){var bv=b(e,this[0].ownerDocument).eq(0).clone(true);if(this[0].parentNode){bv.insertBefore(this[0])}bv.map(function(){var bw=this;while(bw.firstChild&&bw.firstChild.nodeType===1){bw=bw.firstChild}return bw}).append(this)}return this},wrapInner:function(e){if(b.isFunction(e)){return this.each(function(bv){b(this).wrapInner(e.call(this,bv))})}return this.each(function(){var bv=b(this),bw=bv.contents();if(bw.length){bw.wrapAll(e)}else{bv.append(e)}})},wrap:function(e){var bv=b.isFunction(e);return this.each(function(bw){b(this).wrapAll(bv?e.call(this,bw):e)})},unwrap:function(){return this.parent().each(function(){if(!b.nodeName(this,"body")){b(this).replaceWith(this.childNodes)}}).end()},append:function(){return this.domManip(arguments,true,function(e){if(this.nodeType===1){this.appendChild(e)}})},prepend:function(){return this.domManip(arguments,true,function(e){if(this.nodeType===1){this.insertBefore(e,this.firstChild)}})},before:function(){if(this[0]&&this[0].parentNode){return this.domManip(arguments,false,function(bv){this.parentNode.insertBefore(bv,this)})}else{if(arguments.length){var e=b.clean(arguments);e.push.apply(e,this.toArray());return this.pushStack(e,"before",arguments)}}},after:function(){if(this[0]&&this[0].parentNode){return this.domManip(arguments,false,function(bv){this.parentNode.insertBefore(bv,this.nextSibling)})}else{if(arguments.length){var e=this.pushStack(this,"after",arguments);e.push.apply(e,b.clean(arguments));return e}}},remove:function(e,bx){for(var bv=0,bw;(bw=this[bv])!=null;bv++){if(!e||b.filter(e,[bw]).length){if(!bx&&bw.nodeType===1){b.cleanData(bw.getElementsByTagName("*"));b.cleanData([bw])}if(bw.parentNode){bw.parentNode.removeChild(bw)}}}return this},empty:function(){for(var e=0,bv;(bv=this[e])!=null;e++){if(bv.nodeType===1){b.cleanData(bv.getElementsByTagName("*"))}while(bv.firstChild){bv.removeChild(bv.firstChild)}}return this},clone:function(bv,e){bv=bv==null?false:bv;e=e==null?bv:e;return this.map(function(){return b.clone(this,bv,e)})},html:function(e){return b.access(this,function(by){var bx=this[0]||{},bw=0,bv=this.length;if(by===L){return bx.nodeType===1?bx.innerHTML.replace(ah,""):null}if(typeof by==="string"&&!ae.test(by)&&(b.support.leadingWhitespace||!ar.test(by))&&!ax[(d.exec(by)||["",""])[1].toLowerCase()]){by=by.replace(R,"<$1>");try{for(;bw1&&bw0?this.clone(true):this).get();b(bC[bA])[bv](by);bz=bz.concat(by)}return this.pushStack(bz,e,bC.selector)}}});function bh(e){if(typeof e.getElementsByTagName!=="undefined"){return e.getElementsByTagName("*")}else{if(typeof e.querySelectorAll!=="undefined"){return e.querySelectorAll("*")}else{return[]}}}function az(e){if(e.type==="checkbox"||e.type==="radio"){e.defaultChecked=e.checked}}function D(e){var bv=(e.nodeName||"").toLowerCase();if(bv==="input"){az(e)}else{if(bv!=="script"&&typeof e.getElementsByTagName!=="undefined"){b.grep(e.getElementsByTagName("input"),az)}}}function am(e){var bv=av.createElement("div");ac.appendChild(bv);bv.innerHTML=e.outerHTML;return bv.firstChild}b.extend({clone:function(by,bA,bw){var e,bv,bx,bz=b.support.html5Clone||b.isXMLDoc(by)||!ai.test("<"+by.nodeName+">")?by.cloneNode(true):am(by);if((!b.support.noCloneEvent||!b.support.noCloneChecked)&&(by.nodeType===1||by.nodeType===11)&&!b.isXMLDoc(by)){aj(by,bz);e=bh(by);bv=bh(bz);for(bx=0;e[bx];++bx){if(bv[bx]){aj(e[bx],bv[bx])}}}if(bA){s(by,bz);if(bw){e=bh(by);bv=bh(bz);for(bx=0;e[bx];++bx){s(e[bx],bv[bx])}}}e=bv=null;return bz},clean:function(bI,bw,bv,bx){var bA,bH,bD,bJ=[];bw=bw||av;if(typeof bw.createElement==="undefined"){bw=bw.ownerDocument||bw[0]&&bw[0].ownerDocument||av}for(var bE=0,bG;(bG=bI[bE])!=null;bE++){if(typeof bG==="number"){bG+=""}if(!bG){continue}if(typeof bG==="string"){if(!W.test(bG)){bG=bw.createTextNode(bG)}else{bG=bG.replace(R,"<$1>");var bN=(d.exec(bG)||["",""])[1].toLowerCase(),bz=ax[bN]||ax._default,bK=bz[0],bB=bw.createElement("div"),bL=ac.childNodes,bM;if(bw===av){ac.appendChild(bB)}else{a(bw).appendChild(bB)}bB.innerHTML=bz[1]+bG+bz[2];while(bK--){bB=bB.lastChild}if(!b.support.tbody){var by=v.test(bG),e=bN==="table"&&!by?bB.firstChild&&bB.firstChild.childNodes:bz[1]===""&&!by?bB.childNodes:[];for(bD=e.length-1;bD>=0;--bD){if(b.nodeName(e[bD],"tbody")&&!e[bD].childNodes.length){e[bD].parentNode.removeChild(e[bD])}}}if(!b.support.leadingWhitespace&&ar.test(bG)){bB.insertBefore(bw.createTextNode(ar.exec(bG)[0]),bB.firstChild)}bG=bB.childNodes;if(bB){bB.parentNode.removeChild(bB);if(bL.length>0){bM=bL[bL.length-1];if(bM&&bM.parentNode){bM.parentNode.removeChild(bM)}}}}}var bF;if(!b.support.appendChecked){if(bG[0]&&typeof(bF=bG.length)==="number"){for(bD=0;bD1)};b.extend({cssHooks:{opacity:{get:function(bw,bv){if(bv){var e=Z(bw,"opacity");return e===""?"1":e}else{return bw.style.opacity}}}},cssNumber:{fillOpacity:true,fontWeight:true,lineHeight:true,opacity:true,orphans:true,widows:true,zIndex:true,zoom:true},cssProps:{"float":b.support.cssFloat?"cssFloat":"styleFloat"},style:function(bx,bw,bD,by){if(!bx||bx.nodeType===3||bx.nodeType===8||!bx.style){return}var bB,bC,bz=b.camelCase(bw),bv=bx.style,bE=b.cssHooks[bz];bw=b.cssProps[bz]||bz;if(bD!==L){bC=typeof bD;if(bC==="string"&&(bB=I.exec(bD))){bD=(+(bB[1]+1)*+bB[2])+parseFloat(b.css(bx,bw));bC="number"}if(bD==null||bC==="number"&&isNaN(bD)){return}if(bC==="number"&&!b.cssNumber[bz]){bD+="px"}if(!bE||!("set" in bE)||(bD=bE.set(bx,bD))!==L){try{bv[bw]=bD}catch(bA){}}}else{if(bE&&"get" in bE&&(bB=bE.get(bx,false,by))!==L){return bB}return bv[bw]}},css:function(by,bx,bv){var bw,e;bx=b.camelCase(bx);e=b.cssHooks[bx];bx=b.cssProps[bx]||bx;if(bx==="cssFloat"){bx="float"}if(e&&"get" in e&&(bw=e.get(by,true,bv))!==L){return bw}else{if(Z){return Z(by,bx)}}},swap:function(by,bx,bz){var e={},bw,bv;for(bv in bx){e[bv]=by.style[bv];by.style[bv]=bx[bv]}bw=bz.call(by);for(bv in bx){by.style[bv]=e[bv]}return bw}});b.curCSS=b.css;if(av.defaultView&&av.defaultView.getComputedStyle){aJ=function(bA,bw){var bv,bz,e,by,bx=bA.style;bw=bw.replace(y,"-$1").toLowerCase();if((bz=bA.ownerDocument.defaultView)&&(e=bz.getComputedStyle(bA,null))){bv=e.getPropertyValue(bw);if(bv===""&&!b.contains(bA.ownerDocument.documentElement,bA)){bv=b.style(bA,bw)}}if(!b.support.pixelMargin&&e&&aE.test(bw)&&a1.test(bv)){by=bx.width;bx.width=bv;bv=e.width;bx.width=by}return bv}}if(av.documentElement.currentStyle){aY=function(bz,bw){var bA,e,by,bv=bz.currentStyle&&bz.currentStyle[bw],bx=bz.style;if(bv==null&&bx&&(by=bx[bw])){bv=by}if(a1.test(bv)){bA=bx.left;e=bz.runtimeStyle&&bz.runtimeStyle.left;if(e){bz.runtimeStyle.left=bz.currentStyle.left}bx.left=bw==="fontSize"?"1em":bv;bv=bx.pixelLeft+"px";bx.left=bA;if(e){bz.runtimeStyle.left=e}}return bv===""?"auto":bv}}Z=aJ||aY;function af(by,bw,bv){var bz=bw==="width"?by.offsetWidth:by.offsetHeight,bx=bw==="width"?1:0,e=4;if(bz>0){if(bv!=="border"){for(;bx=1&&b.trim(bw.replace(al,""))===""){bx.removeAttribute("filter");if(bv&&!bv.filter){return}}bx.filter=al.test(bw)?bw.replace(al,e):bw+" "+e}}}b(function(){if(!b.support.reliableMarginRight){b.cssHooks.marginRight={get:function(bv,e){return b.swap(bv,{display:"inline-block"},function(){if(e){return Z(bv,"margin-right")}else{return bv.style.marginRight}})}}}});if(b.expr&&b.expr.filters){b.expr.filters.hidden=function(bw){var bv=bw.offsetWidth,e=bw.offsetHeight;return(bv===0&&e===0)||(!b.support.reliableHiddenOffsets&&((bw.style&&bw.style.display)||b.css(bw,"display"))==="none")};b.expr.filters.visible=function(e){return !b.expr.filters.hidden(e)}}b.each({margin:"",padding:"",border:"Width"},function(e,bv){b.cssHooks[e+bv]={expand:function(by){var bx,bz=typeof by==="string"?by.split(" "):[by],bw={};for(bx=0;bx<4;bx++){bw[e+G[bx]+bv]=bz[bx]||bz[bx-2]||bz[0]}return bw}}});var k=/%20/g,ap=/\[\]$/,bs=/\r?\n/g,bq=/#.*$/,aD=/^(.*?):[ \t]*([^\r\n]*)\r?$/mg,a0=/^(?:color|date|datetime|datetime-local|email|hidden|month|number|password|range|search|tel|text|time|url|week)$/i,aN=/^(?:about|app|app\-storage|.+\-extension|file|res|widget):$/,aR=/^(?:GET|HEAD)$/,c=/^\/\//,M=/\?/,a7=/)<[^<]*)*<\/script>/gi,p=/^(?:select|textarea)/i,h=/\s+/,br=/([?&])_=[^&]*/,K=/^([\w\+\.\-]+:)(?:\/\/([^\/?#:]*)(?::(\d+))?)?/,z=b.fn.load,aa={},q={},aF,r,aW=["*/"]+["*"];try{aF=bm.href}catch(aw){aF=av.createElement("a");aF.href="";aF=aF.href}r=K.exec(aF.toLowerCase())||[];function f(e){return function(by,bA){if(typeof by!=="string"){bA=by;by="*"}if(b.isFunction(bA)){var bx=by.toLowerCase().split(h),bw=0,bz=bx.length,bv,bB,bC;for(;bw=0){var e=bw.slice(by,bw.length);bw=bw.slice(0,by)}var bx="GET";if(bz){if(b.isFunction(bz)){bA=bz;bz=L}else{if(typeof bz==="object"){bz=b.param(bz,b.ajaxSettings.traditional);bx="POST"}}}var bv=this;b.ajax({url:bw,type:bx,dataType:"html",data:bz,complete:function(bC,bB,bD){bD=bC.responseText;if(bC.isResolved()){bC.done(function(bE){bD=bE});bv.html(e?b("
").append(bD.replace(a7,"")).find(e):bD)}if(bA){bv.each(bA,[bD,bB,bC])}}});return this},serialize:function(){return b.param(this.serializeArray())},serializeArray:function(){return this.map(function(){return this.elements?b.makeArray(this.elements):this}).filter(function(){return this.name&&!this.disabled&&(this.checked||p.test(this.nodeName)||a0.test(this.type))}).map(function(e,bv){var bw=b(this).val();return bw==null?null:b.isArray(bw)?b.map(bw,function(by,bx){return{name:bv.name,value:by.replace(bs,"\r\n")}}):{name:bv.name,value:bw.replace(bs,"\r\n")}}).get()}});b.each("ajaxStart ajaxStop ajaxComplete ajaxError ajaxSuccess ajaxSend".split(" "),function(e,bv){b.fn[bv]=function(bw){return this.on(bv,bw)}});b.each(["get","post"],function(e,bv){b[bv]=function(bw,by,bz,bx){if(b.isFunction(by)){bx=bx||bz;bz=by;by=L}return b.ajax({type:bv,url:bw,data:by,success:bz,dataType:bx})}});b.extend({getScript:function(e,bv){return b.get(e,L,bv,"script")},getJSON:function(e,bv,bw){return b.get(e,bv,bw,"json")},ajaxSetup:function(bv,e){if(e){an(bv,b.ajaxSettings)}else{e=bv;bv=b.ajaxSettings}an(bv,e);return bv},ajaxSettings:{url:aF,isLocal:aN.test(r[1]),global:true,type:"GET",contentType:"application/x-www-form-urlencoded; charset=UTF-8",processData:true,async:true,accepts:{xml:"application/xml, text/xml",html:"text/html",text:"text/plain",json:"application/json, text/javascript","*":aW},contents:{xml:/xml/,html:/html/,json:/json/},responseFields:{xml:"responseXML",text:"responseText"},converters:{"* text":bd.String,"text html":true,"text json":b.parseJSON,"text xml":b.parseXML},flatOptions:{context:true,url:true}},ajaxPrefilter:f(aa),ajaxTransport:f(q),ajax:function(bz,bx){if(typeof bz==="object"){bx=bz;bz=L}bx=bx||{};var bD=b.ajaxSetup({},bx),bS=bD.context||bD,bG=bS!==bD&&(bS.nodeType||bS instanceof b)?b(bS):b.event,bR=b.Deferred(),bN=b.Callbacks("once memory"),bB=bD.statusCode||{},bC,bH={},bO={},bQ,by,bL,bE,bI,bA=0,bw,bK,bJ={readyState:0,setRequestHeader:function(bT,bU){if(!bA){var e=bT.toLowerCase();bT=bO[e]=bO[e]||bT;bH[bT]=bU}return this},getAllResponseHeaders:function(){return bA===2?bQ:null},getResponseHeader:function(bT){var e;if(bA===2){if(!by){by={};while((e=aD.exec(bQ))){by[e[1].toLowerCase()]=e[2]}}e=by[bT.toLowerCase()]}return e===L?null:e},overrideMimeType:function(e){if(!bA){bD.mimeType=e}return this},abort:function(e){e=e||"abort";if(bL){bL.abort(e)}bF(0,e);return this}};function bF(bZ,bU,b0,bW){if(bA===2){return}bA=2;if(bE){clearTimeout(bE)}bL=L;bQ=bW||"";bJ.readyState=bZ>0?4:0;var bT,b4,b3,bX=bU,bY=b0?bk(bD,bJ,b0):L,bV,b2;if(bZ>=200&&bZ<300||bZ===304){if(bD.ifModified){if((bV=bJ.getResponseHeader("Last-Modified"))){b.lastModified[bC]=bV}if((b2=bJ.getResponseHeader("Etag"))){b.etag[bC]=b2}}if(bZ===304){bX="notmodified";bT=true}else{try{b4=F(bD,bY);bX="success";bT=true}catch(b1){bX="parsererror";b3=b1}}}else{b3=bX;if(!bX||bZ){bX="error";if(bZ<0){bZ=0}}}bJ.status=bZ;bJ.statusText=""+(bU||bX);if(bT){bR.resolveWith(bS,[b4,bX,bJ])}else{bR.rejectWith(bS,[bJ,bX,b3])}bJ.statusCode(bB);bB=L;if(bw){bG.trigger("ajax"+(bT?"Success":"Error"),[bJ,bD,bT?b4:b3])}bN.fireWith(bS,[bJ,bX]);if(bw){bG.trigger("ajaxComplete",[bJ,bD]);if(!(--b.active)){b.event.trigger("ajaxStop")}}}bR.promise(bJ);bJ.success=bJ.done;bJ.error=bJ.fail;bJ.complete=bN.add;bJ.statusCode=function(bT){if(bT){var e;if(bA<2){for(e in bT){bB[e]=[bB[e],bT[e]]}}else{e=bT[bJ.status];bJ.then(e,e)}}return this};bD.url=((bz||bD.url)+"").replace(bq,"").replace(c,r[1]+"//");bD.dataTypes=b.trim(bD.dataType||"*").toLowerCase().split(h);if(bD.crossDomain==null){bI=K.exec(bD.url.toLowerCase());bD.crossDomain=!!(bI&&(bI[1]!=r[1]||bI[2]!=r[2]||(bI[3]||(bI[1]==="http:"?80:443))!=(r[3]||(r[1]==="http:"?80:443))))}if(bD.data&&bD.processData&&typeof bD.data!=="string"){bD.data=b.param(bD.data,bD.traditional)}aX(aa,bD,bx,bJ);if(bA===2){return false}bw=bD.global;bD.type=bD.type.toUpperCase();bD.hasContent=!aR.test(bD.type);if(bw&&b.active++===0){b.event.trigger("ajaxStart")}if(!bD.hasContent){if(bD.data){bD.url+=(M.test(bD.url)?"&":"?")+bD.data;delete bD.data}bC=bD.url;if(bD.cache===false){var bv=b.now(),bP=bD.url.replace(br,"$1_="+bv);bD.url=bP+((bP===bD.url)?(M.test(bD.url)?"&":"?")+"_="+bv:"")}}if(bD.data&&bD.hasContent&&bD.contentType!==false||bx.contentType){bJ.setRequestHeader("Content-Type",bD.contentType)}if(bD.ifModified){bC=bC||bD.url;if(b.lastModified[bC]){bJ.setRequestHeader("If-Modified-Since",b.lastModified[bC])}if(b.etag[bC]){bJ.setRequestHeader("If-None-Match",b.etag[bC])}}bJ.setRequestHeader("Accept",bD.dataTypes[0]&&bD.accepts[bD.dataTypes[0]]?bD.accepts[bD.dataTypes[0]]+(bD.dataTypes[0]!=="*"?", "+aW+"; q=0.01":""):bD.accepts["*"]);for(bK in bD.headers){bJ.setRequestHeader(bK,bD.headers[bK])}if(bD.beforeSend&&(bD.beforeSend.call(bS,bJ,bD)===false||bA===2)){bJ.abort();return false}for(bK in {success:1,error:1,complete:1}){bJ[bK](bD[bK])}bL=aX(q,bD,bx,bJ);if(!bL){bF(-1,"No Transport")}else{bJ.readyState=1;if(bw){bG.trigger("ajaxSend",[bJ,bD])}if(bD.async&&bD.timeout>0){bE=setTimeout(function(){bJ.abort("timeout")},bD.timeout)}try{bA=1;bL.send(bH,bF)}catch(bM){if(bA<2){bF(-1,bM)}else{throw bM}}}return bJ},param:function(e,bw){var bv=[],by=function(bz,bA){bA=b.isFunction(bA)?bA():bA;bv[bv.length]=encodeURIComponent(bz)+"="+encodeURIComponent(bA)};if(bw===L){bw=b.ajaxSettings.traditional}if(b.isArray(e)||(e.jquery&&!b.isPlainObject(e))){b.each(e,function(){by(this.name,this.value)})}else{for(var bx in e){u(bx,e[bx],bw,by)}}return bv.join("&").replace(k,"+")}});function u(bw,by,bv,bx){if(b.isArray(by)){b.each(by,function(bA,bz){if(bv||ap.test(bw)){bx(bw,bz)}else{u(bw+"["+(typeof bz==="object"?bA:"")+"]",bz,bv,bx)}})}else{if(!bv&&b.type(by)==="object"){for(var e in by){u(bw+"["+e+"]",by[e],bv,bx)}}else{bx(bw,by)}}}b.extend({active:0,lastModified:{},etag:{}});function bk(bD,bC,bz){var bv=bD.contents,bB=bD.dataTypes,bw=bD.responseFields,by,bA,bx,e;for(bA in bw){if(bA in bz){bC[bw[bA]]=bz[bA]}}while(bB[0]==="*"){bB.shift();if(by===L){by=bD.mimeType||bC.getResponseHeader("content-type")}}if(by){for(bA in bv){if(bv[bA]&&bv[bA].test(by)){bB.unshift(bA);break}}}if(bB[0] in bz){bx=bB[0]}else{for(bA in bz){if(!bB[0]||bD.converters[bA+" "+bB[0]]){bx=bA;break}if(!e){e=bA}}bx=bx||e}if(bx){if(bx!==bB[0]){bB.unshift(bx)}return bz[bx]}}function F(bH,bz){if(bH.dataFilter){bz=bH.dataFilter(bz,bH.dataType)}var bD=bH.dataTypes,bG={},bA,bE,bw=bD.length,bB,bC=bD[0],bx,by,bF,bv,e;for(bA=1;bA=bw.duration+this.startTime){this.now=this.end;this.pos=this.state=1;this.update();bw.animatedProperties[this.prop]=true;for(bA in bw.animatedProperties){if(bw.animatedProperties[bA]!==true){e=false}}if(e){if(bw.overflow!=null&&!b.support.shrinkWrapBlocks){b.each(["","X","Y"],function(bC,bD){bz.style["overflow"+bD]=bw.overflow[bC]})}if(bw.hide){b(bz).hide()}if(bw.hide||bw.show){for(bA in bw.animatedProperties){b.style(bz,bA,bw.orig[bA]);b.removeData(bz,"fxshow"+bA,true);b.removeData(bz,"toggle"+bA,true)}}bv=bw.complete;if(bv){bw.complete=false;bv.call(bz)}}return false}else{if(bw.duration==Infinity){this.now=bx}else{bB=bx-this.startTime;this.state=bB/bw.duration;this.pos=b.easing[bw.animatedProperties[this.prop]](this.state,bB,0,1,bw.duration);this.now=this.start+((this.end-this.start)*this.pos)}this.update()}return true}};b.extend(b.fx,{tick:function(){var bw,bv=b.timers,e=0;for(;e").appendTo(e),bw=bv.css("display");bv.remove();if(bw==="none"||bw===""){if(!ba){ba=av.createElement("iframe");ba.frameBorder=ba.width=ba.height=0}e.appendChild(ba);if(!m||!ba.createElement){m=(ba.contentWindow||ba.contentDocument).document;m.write((b.support.boxModel?"":"")+"");m.close()}bv=m.createElement(bx);m.body.appendChild(bv);bw=b.css(bv,"display");e.removeChild(ba)}Q[bx]=bw}return Q[bx]}var a8,V=/^t(?:able|d|h)$/i,ad=/^(?:body|html)$/i;if("getBoundingClientRect" in av.documentElement){a8=function(by,bH,bw,bB){try{bB=by.getBoundingClientRect()}catch(bF){}if(!bB||!b.contains(bw,by)){return bB?{top:bB.top,left:bB.left}:{top:0,left:0}}var bC=bH.body,bD=aL(bH),bA=bw.clientTop||bC.clientTop||0,bE=bw.clientLeft||bC.clientLeft||0,bv=bD.pageYOffset||b.support.boxModel&&bw.scrollTop||bC.scrollTop,bz=bD.pageXOffset||b.support.boxModel&&bw.scrollLeft||bC.scrollLeft,bG=bB.top+bv-bA,bx=bB.left+bz-bE;return{top:bG,left:bx}}}else{a8=function(bz,bE,bx){var bC,bw=bz.offsetParent,bv=bz,bA=bE.body,bB=bE.defaultView,e=bB?bB.getComputedStyle(bz,null):bz.currentStyle,bD=bz.offsetTop,by=bz.offsetLeft;while((bz=bz.parentNode)&&bz!==bA&&bz!==bx){if(b.support.fixedPosition&&e.position==="fixed"){break}bC=bB?bB.getComputedStyle(bz,null):bz.currentStyle;bD-=bz.scrollTop;by-=bz.scrollLeft;if(bz===bw){bD+=bz.offsetTop;by+=bz.offsetLeft;if(b.support.doesNotAddBorder&&!(b.support.doesAddBorderForTableAndCells&&V.test(bz.nodeName))){bD+=parseFloat(bC.borderTopWidth)||0;by+=parseFloat(bC.borderLeftWidth)||0}bv=bw;bw=bz.offsetParent}if(b.support.subtractsBorderForOverflowNotVisible&&bC.overflow!=="visible"){bD+=parseFloat(bC.borderTopWidth)||0;by+=parseFloat(bC.borderLeftWidth)||0}e=bC}if(e.position==="relative"||e.position==="static"){bD+=bA.offsetTop;by+=bA.offsetLeft}if(b.support.fixedPosition&&e.position==="fixed"){bD+=Math.max(bx.scrollTop,bA.scrollTop);by+=Math.max(bx.scrollLeft,bA.scrollLeft)}return{top:bD,left:by}}}b.fn.offset=function(e){if(arguments.length){return e===L?this:this.each(function(bx){b.offset.setOffset(this,e,bx)})}var bv=this[0],bw=bv&&bv.ownerDocument;if(!bw){return null}if(bv===bw.body){return b.offset.bodyOffset(bv)}return a8(bv,bw,bw.documentElement)};b.offset={bodyOffset:function(e){var bw=e.offsetTop,bv=e.offsetLeft;if(b.support.doesNotIncludeMarginInBodyOffset){bw+=parseFloat(b.css(e,"marginTop"))||0;bv+=parseFloat(b.css(e,"marginLeft"))||0}return{top:bw,left:bv}},setOffset:function(bx,bG,bA){var bB=b.css(bx,"position");if(bB==="static"){bx.style.position="relative"}var bz=b(bx),bv=bz.offset(),e=b.css(bx,"top"),bE=b.css(bx,"left"),bF=(bB==="absolute"||bB==="fixed")&&b.inArray("auto",[e,bE])>-1,bD={},bC={},bw,by;if(bF){bC=bz.position();bw=bC.top;by=bC.left}else{bw=parseFloat(e)||0;by=parseFloat(bE)||0}if(b.isFunction(bG)){bG=bG.call(bx,bA,bv)}if(bG.top!=null){bD.top=(bG.top-bv.top)+bw}if(bG.left!=null){bD.left=(bG.left-bv.left)+by}if("using" in bG){bG.using.call(bx,bD)}else{bz.css(bD)}}};b.fn.extend({position:function(){if(!this[0]){return null}var bw=this[0],bv=this.offsetParent(),bx=this.offset(),e=ad.test(bv[0].nodeName)?{top:0,left:0}:bv.offset();bx.top-=parseFloat(b.css(bw,"marginTop"))||0;bx.left-=parseFloat(b.css(bw,"marginLeft"))||0;e.top+=parseFloat(b.css(bv[0],"borderTopWidth"))||0;e.left+=parseFloat(b.css(bv[0],"borderLeftWidth"))||0;return{top:bx.top-e.top,left:bx.left-e.left}},offsetParent:function(){return this.map(function(){var e=this.offsetParent||av.body;while(e&&(!ad.test(e.nodeName)&&b.css(e,"position")==="static")){e=e.offsetParent}return e})}});b.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(bw,bv){var e=/Y/.test(bv);b.fn[bw]=function(bx){return b.access(this,function(by,bB,bA){var bz=aL(by);if(bA===L){return bz?(bv in bz)?bz[bv]:b.support.boxModel&&bz.document.documentElement[bB]||bz.document.body[bB]:by[bB]}if(bz){bz.scrollTo(!e?bA:b(bz).scrollLeft(),e?bA:b(bz).scrollTop())}else{by[bB]=bA}},bw,bx,arguments.length,null)}});function aL(e){return b.isWindow(e)?e:e.nodeType===9?e.defaultView||e.parentWindow:false}b.each({Height:"height",Width:"width"},function(bw,bx){var bv="client"+bw,e="scroll"+bw,by="offset"+bw;b.fn["inner"+bw]=function(){var bz=this[0];return bz?bz.style?parseFloat(b.css(bz,bx,"padding")):this[bx]():null};b.fn["outer"+bw]=function(bA){var bz=this[0];return bz?bz.style?parseFloat(b.css(bz,bx,bA?"margin":"border")):this[bx]():null};b.fn[bx]=function(bz){return b.access(this,function(bC,bB,bD){var bF,bE,bG,bA;if(b.isWindow(bC)){bF=bC.document;bE=bF.documentElement[bv];return b.support.boxModel&&bE||bF.body&&bF.body[bv]||bE}if(bC.nodeType===9){bF=bC.documentElement;if(bF[bv]>=bF[e]){return bF[bv]}return Math.max(bC.body[e],bF[e],bC.body[by],bF[by])}if(bD===L){bG=b.css(bC,bB);bA=parseFloat(bG);return b.isNumeric(bA)?bA:bG}b(bC).css(bB,bD)},bx,bz,arguments.length,null)}});bd.jQuery=bd.$=b;if(typeof define==="function"&&define.amd&&define.amd.jQuery){define("jquery",[],function(){return b})}})(window);/*! + * jQuery UI 1.8.18 + * + * Copyright 2011, AUTHORS.txt (http://jqueryui.com/about) + * Dual licensed under the MIT or GPL Version 2 licenses. + * http://jquery.org/license + * + * http://docs.jquery.com/UI + */ +(function(a,d){a.ui=a.ui||{};if(a.ui.version){return}a.extend(a.ui,{version:"1.8.18",keyCode:{ALT:18,BACKSPACE:8,CAPS_LOCK:20,COMMA:188,COMMAND:91,COMMAND_LEFT:91,COMMAND_RIGHT:93,CONTROL:17,DELETE:46,DOWN:40,END:35,ENTER:13,ESCAPE:27,HOME:36,INSERT:45,LEFT:37,MENU:93,NUMPAD_ADD:107,NUMPAD_DECIMAL:110,NUMPAD_DIVIDE:111,NUMPAD_ENTER:108,NUMPAD_MULTIPLY:106,NUMPAD_SUBTRACT:109,PAGE_DOWN:34,PAGE_UP:33,PERIOD:190,RIGHT:39,SHIFT:16,SPACE:32,TAB:9,UP:38,WINDOWS:91}});a.fn.extend({propAttr:a.fn.prop||a.fn.attr,_focus:a.fn.focus,focus:function(e,f){return typeof e==="number"?this.each(function(){var g=this;setTimeout(function(){a(g).focus();if(f){f.call(g)}},e)}):this._focus.apply(this,arguments)},scrollParent:function(){var e;if((a.browser.msie&&(/(static|relative)/).test(this.css("position")))||(/absolute/).test(this.css("position"))){e=this.parents().filter(function(){return(/(relative|absolute|fixed)/).test(a.curCSS(this,"position",1))&&(/(auto|scroll)/).test(a.curCSS(this,"overflow",1)+a.curCSS(this,"overflow-y",1)+a.curCSS(this,"overflow-x",1))}).eq(0)}else{e=this.parents().filter(function(){return(/(auto|scroll)/).test(a.curCSS(this,"overflow",1)+a.curCSS(this,"overflow-y",1)+a.curCSS(this,"overflow-x",1))}).eq(0)}return(/fixed/).test(this.css("position"))||!e.length?a(document):e},zIndex:function(h){if(h!==d){return this.css("zIndex",h)}if(this.length){var f=a(this[0]),e,g;while(f.length&&f[0]!==document){e=f.css("position");if(e==="absolute"||e==="relative"||e==="fixed"){g=parseInt(f.css("zIndex"),10);if(!isNaN(g)&&g!==0){return g}}f=f.parent()}}return 0},disableSelection:function(){return this.bind((a.support.selectstart?"selectstart":"mousedown")+".ui-disableSelection",function(e){e.preventDefault()})},enableSelection:function(){return this.unbind(".ui-disableSelection")}});a.each(["Width","Height"],function(g,e){var f=e==="Width"?["Left","Right"]:["Top","Bottom"],h=e.toLowerCase(),k={innerWidth:a.fn.innerWidth,innerHeight:a.fn.innerHeight,outerWidth:a.fn.outerWidth,outerHeight:a.fn.outerHeight};function j(m,l,i,n){a.each(f,function(){l-=parseFloat(a.curCSS(m,"padding"+this,true))||0;if(i){l-=parseFloat(a.curCSS(m,"border"+this+"Width",true))||0}if(n){l-=parseFloat(a.curCSS(m,"margin"+this,true))||0}});return l}a.fn["inner"+e]=function(i){if(i===d){return k["inner"+e].call(this)}return this.each(function(){a(this).css(h,j(this,i)+"px")})};a.fn["outer"+e]=function(i,l){if(typeof i!=="number"){return k["outer"+e].call(this,i)}return this.each(function(){a(this).css(h,j(this,i,true,l)+"px")})}});function c(g,e){var j=g.nodeName.toLowerCase();if("area"===j){var i=g.parentNode,h=i.name,f;if(!g.href||!h||i.nodeName.toLowerCase()!=="map"){return false}f=a("img[usemap=#"+h+"]")[0];return !!f&&b(f)}return(/input|select|textarea|button|object/.test(j)?!g.disabled:"a"==j?g.href||e:e)&&b(g)}function b(e){return !a(e).parents().andSelf().filter(function(){return a.curCSS(this,"visibility")==="hidden"||a.expr.filters.hidden(this)}).length}a.extend(a.expr[":"],{data:function(g,f,e){return !!a.data(g,e[3])},focusable:function(e){return c(e,!isNaN(a.attr(e,"tabindex")))},tabbable:function(g){var e=a.attr(g,"tabindex"),f=isNaN(e);return(f||e>=0)&&c(g,!f)}});a(function(){var e=document.body,f=e.appendChild(f=document.createElement("div"));f.offsetHeight;a.extend(f.style,{minHeight:"100px",height:"auto",padding:0,borderWidth:0});a.support.minHeight=f.offsetHeight===100;a.support.selectstart="onselectstart" in f;e.removeChild(f).style.display="none"});a.extend(a.ui,{plugin:{add:function(f,g,j){var h=a.ui[f].prototype;for(var e in j){h.plugins[e]=h.plugins[e]||[];h.plugins[e].push([g,j[e]])}},call:function(e,g,f){var j=e.plugins[g];if(!j||!e.element[0].parentNode){return}for(var h=0;h0){return true}h[e]=1;g=(h[e]>0);h[e]=0;return g},isOverAxis:function(f,e,g){return(f>e)&&(f<(e+g))},isOver:function(j,f,i,h,e,g){return a.ui.isOverAxis(j,i,e)&&a.ui.isOverAxis(f,h,g)}})})(jQuery);/*! + * jQuery UI Widget 1.8.18 + * + * Copyright 2011, AUTHORS.txt (http://jqueryui.com/about) + * Dual licensed under the MIT or GPL Version 2 licenses. + * http://jquery.org/license + * + * http://docs.jquery.com/UI/Widget + */ +(function(b,d){if(b.cleanData){var c=b.cleanData;b.cleanData=function(f){for(var g=0,h;(h=f[g])!=null;g++){try{b(h).triggerHandler("remove")}catch(j){}}c(f)}}else{var a=b.fn.remove;b.fn.remove=function(e,f){return this.each(function(){if(!f){if(!e||b.filter(e,[this]).length){b("*",this).add([this]).each(function(){try{b(this).triggerHandler("remove")}catch(g){}})}}return a.call(b(this),e,f)})}}b.widget=function(f,h,e){var g=f.split(".")[0],j;f=f.split(".")[1];j=g+"-"+f;if(!e){e=h;h=b.Widget}b.expr[":"][j]=function(k){return !!b.data(k,f)};b[g]=b[g]||{};b[g][f]=function(k,l){if(arguments.length){this._createWidget(k,l)}};var i=new h();i.options=b.extend(true,{},i.options);b[g][f].prototype=b.extend(true,i,{namespace:g,widgetName:f,widgetEventPrefix:b[g][f].prototype.widgetEventPrefix||f,widgetBaseClass:j},e);b.widget.bridge(f,b[g][f])};b.widget.bridge=function(f,e){b.fn[f]=function(i){var g=typeof i==="string",h=Array.prototype.slice.call(arguments,1),j=this;i=!g&&h.length?b.extend.apply(null,[true,i].concat(h)):i;if(g&&i.charAt(0)==="_"){return j}if(g){this.each(function(){var k=b.data(this,f),l=k&&b.isFunction(k[i])?k[i].apply(k,h):k;if(l!==k&&l!==d){j=l;return false}})}else{this.each(function(){var k=b.data(this,f);if(k){k.option(i||{})._init()}else{b.data(this,f,new e(i,this))}})}return j}};b.Widget=function(e,f){if(arguments.length){this._createWidget(e,f)}};b.Widget.prototype={widgetName:"widget",widgetEventPrefix:"",options:{disabled:false},_createWidget:function(f,g){b.data(g,this.widgetName,this);this.element=b(g);this.options=b.extend(true,{},this.options,this._getCreateOptions(),f);var e=this;this.element.bind("remove."+this.widgetName,function(){e.destroy()});this._create();this._trigger("create");this._init()},_getCreateOptions:function(){return b.metadata&&b.metadata.get(this.element[0])[this.widgetName]},_create:function(){},_init:function(){},destroy:function(){this.element.unbind("."+this.widgetName).removeData(this.widgetName);this.widget().unbind("."+this.widgetName).removeAttr("aria-disabled").removeClass(this.widgetBaseClass+"-disabled ui-state-disabled")},widget:function(){return this.element},option:function(f,g){var e=f;if(arguments.length===0){return b.extend({},this.options)}if(typeof f==="string"){if(g===d){return this.options[f]}e={};e[f]=g}this._setOptions(e);return this},_setOptions:function(f){var e=this;b.each(f,function(g,h){e._setOption(g,h)});return this},_setOption:function(e,f){this.options[e]=f;if(e==="disabled"){this.widget()[f?"addClass":"removeClass"](this.widgetBaseClass+"-disabled ui-state-disabled").attr("aria-disabled",f)}return this},enable:function(){return this._setOption("disabled",false)},disable:function(){return this._setOption("disabled",true)},_trigger:function(e,f,g){var j,i,h=this.options[e];g=g||{};f=b.Event(f);f.type=(e===this.widgetEventPrefix?e:this.widgetEventPrefix+e).toLowerCase();f.target=this.element[0];i=f.originalEvent;if(i){for(j in i){if(!(j in f)){f[j]=i[j]}}}this.element.trigger(f,g);return !(b.isFunction(h)&&h.call(this.element[0],f,g)===false||f.isDefaultPrevented())}}})(jQuery);/*! + * jQuery UI Mouse 1.8.18 + * + * Copyright 2011, AUTHORS.txt (http://jqueryui.com/about) + * Dual licensed under the MIT or GPL Version 2 licenses. + * http://jquery.org/license + * + * http://docs.jquery.com/UI/Mouse + * + * Depends: + * jquery.ui.widget.js + */ +(function(b,c){var a=false;b(document).mouseup(function(d){a=false});b.widget("ui.mouse",{options:{cancel:":input,option",distance:1,delay:0},_mouseInit:function(){var d=this;this.element.bind("mousedown."+this.widgetName,function(e){return d._mouseDown(e)}).bind("click."+this.widgetName,function(e){if(true===b.data(e.target,d.widgetName+".preventClickEvent")){b.removeData(e.target,d.widgetName+".preventClickEvent");e.stopImmediatePropagation();return false}});this.started=false},_mouseDestroy:function(){this.element.unbind("."+this.widgetName)},_mouseDown:function(f){if(a){return}(this._mouseStarted&&this._mouseUp(f));this._mouseDownEvent=f;var e=this,g=(f.which==1),d=(typeof this.options.cancel=="string"&&f.target.nodeName?b(f.target).closest(this.options.cancel).length:false);if(!g||d||!this._mouseCapture(f)){return true}this.mouseDelayMet=!this.options.delay;if(!this.mouseDelayMet){this._mouseDelayTimer=setTimeout(function(){e.mouseDelayMet=true},this.options.delay)}if(this._mouseDistanceMet(f)&&this._mouseDelayMet(f)){this._mouseStarted=(this._mouseStart(f)!==false);if(!this._mouseStarted){f.preventDefault();return true}}if(true===b.data(f.target,this.widgetName+".preventClickEvent")){b.removeData(f.target,this.widgetName+".preventClickEvent")}this._mouseMoveDelegate=function(h){return e._mouseMove(h)};this._mouseUpDelegate=function(h){return e._mouseUp(h)};b(document).bind("mousemove."+this.widgetName,this._mouseMoveDelegate).bind("mouseup."+this.widgetName,this._mouseUpDelegate);f.preventDefault();a=true;return true},_mouseMove:function(d){if(b.browser.msie&&!(document.documentMode>=9)&&!d.button){return this._mouseUp(d)}if(this._mouseStarted){this._mouseDrag(d);return d.preventDefault()}if(this._mouseDistanceMet(d)&&this._mouseDelayMet(d)){this._mouseStarted=(this._mouseStart(this._mouseDownEvent,d)!==false);(this._mouseStarted?this._mouseDrag(d):this._mouseUp(d))}return !this._mouseStarted},_mouseUp:function(d){b(document).unbind("mousemove."+this.widgetName,this._mouseMoveDelegate).unbind("mouseup."+this.widgetName,this._mouseUpDelegate);if(this._mouseStarted){this._mouseStarted=false;if(d.target==this._mouseDownEvent.target){b.data(d.target,this.widgetName+".preventClickEvent",true)}this._mouseStop(d)}return false},_mouseDistanceMet:function(d){return(Math.max(Math.abs(this._mouseDownEvent.pageX-d.pageX),Math.abs(this._mouseDownEvent.pageY-d.pageY))>=this.options.distance)},_mouseDelayMet:function(d){return this.mouseDelayMet},_mouseStart:function(d){},_mouseDrag:function(d){},_mouseStop:function(d){},_mouseCapture:function(d){return true}})})(jQuery);(function(c,d){c.widget("ui.resizable",c.ui.mouse,{widgetEventPrefix:"resize",options:{alsoResize:false,animate:false,animateDuration:"slow",animateEasing:"swing",aspectRatio:false,autoHide:false,containment:false,ghost:false,grid:false,handles:"e,s,se",helper:false,maxHeight:null,maxWidth:null,minHeight:10,minWidth:10,zIndex:1000},_create:function(){var f=this,k=this.options;this.element.addClass("ui-resizable");c.extend(this,{_aspectRatio:!!(k.aspectRatio),aspectRatio:k.aspectRatio,originalElement:this.element,_proportionallyResizeElements:[],_helper:k.helper||k.ghost||k.animate?k.helper||"ui-resizable-helper":null});if(this.element[0].nodeName.match(/canvas|textarea|input|select|button|img/i)){this.element.wrap(c('
').css({position:this.element.css("position"),width:this.element.outerWidth(),height:this.element.outerHeight(),top:this.element.css("top"),left:this.element.css("left")}));this.element=this.element.parent().data("resizable",this.element.data("resizable"));this.elementIsWrapper=true;this.element.css({marginLeft:this.originalElement.css("marginLeft"),marginTop:this.originalElement.css("marginTop"),marginRight:this.originalElement.css("marginRight"),marginBottom:this.originalElement.css("marginBottom")});this.originalElement.css({marginLeft:0,marginTop:0,marginRight:0,marginBottom:0});this.originalResizeStyle=this.originalElement.css("resize");this.originalElement.css("resize","none");this._proportionallyResizeElements.push(this.originalElement.css({position:"static",zoom:1,display:"block"}));this.originalElement.css({margin:this.originalElement.css("margin")});this._proportionallyResize()}this.handles=k.handles||(!c(".ui-resizable-handle",this.element).length?"e,s,se":{n:".ui-resizable-n",e:".ui-resizable-e",s:".ui-resizable-s",w:".ui-resizable-w",se:".ui-resizable-se",sw:".ui-resizable-sw",ne:".ui-resizable-ne",nw:".ui-resizable-nw"});if(this.handles.constructor==String){if(this.handles=="all"){this.handles="n,e,s,w,se,sw,ne,nw"}var l=this.handles.split(",");this.handles={};for(var g=0;g
');if(/sw|se|ne|nw/.test(j)){h.css({zIndex:++k.zIndex})}if("se"==j){h.addClass("ui-icon ui-icon-gripsmall-diagonal-se")}this.handles[j]=".ui-resizable-"+j;this.element.append(h)}}this._renderAxis=function(q){q=q||this.element;for(var n in this.handles){if(this.handles[n].constructor==String){this.handles[n]=c(this.handles[n],this.element).show()}if(this.elementIsWrapper&&this.originalElement[0].nodeName.match(/textarea|input|select|button/i)){var o=c(this.handles[n],this.element),p=0;p=/sw|ne|nw|se|n|s/.test(n)?o.outerHeight():o.outerWidth();var m=["padding",/ne|nw|n/.test(n)?"Top":/se|sw|s/.test(n)?"Bottom":/^e$/.test(n)?"Right":"Left"].join("");q.css(m,p);this._proportionallyResize()}if(!c(this.handles[n]).length){continue}}};this._renderAxis(this.element);this._handles=c(".ui-resizable-handle",this.element).disableSelection();this._handles.mouseover(function(){if(!f.resizing){if(this.className){var i=this.className.match(/ui-resizable-(se|sw|ne|nw|n|e|s|w)/i)}f.axis=i&&i[1]?i[1]:"se"}});if(k.autoHide){this._handles.hide();c(this.element).addClass("ui-resizable-autohide").hover(function(){if(k.disabled){return}c(this).removeClass("ui-resizable-autohide");f._handles.show()},function(){if(k.disabled){return}if(!f.resizing){c(this).addClass("ui-resizable-autohide");f._handles.hide()}})}this._mouseInit()},destroy:function(){this._mouseDestroy();var e=function(g){c(g).removeClass("ui-resizable ui-resizable-disabled ui-resizable-resizing").removeData("resizable").unbind(".resizable").find(".ui-resizable-handle").remove()};if(this.elementIsWrapper){e(this.element);var f=this.element;f.after(this.originalElement.css({position:f.css("position"),width:f.outerWidth(),height:f.outerHeight(),top:f.css("top"),left:f.css("left")})).remove()}this.originalElement.css("resize",this.originalResizeStyle);e(this.originalElement);return this},_mouseCapture:function(f){var g=false;for(var e in this.handles){if(c(this.handles[e])[0]==f.target){g=true}}return !this.options.disabled&&g},_mouseStart:function(g){var j=this.options,f=this.element.position(),e=this.element;this.resizing=true;this.documentScroll={top:c(document).scrollTop(),left:c(document).scrollLeft()};if(e.is(".ui-draggable")||(/absolute/).test(e.css("position"))){e.css({position:"absolute",top:f.top,left:f.left})}this._renderProxy();var k=b(this.helper.css("left")),h=b(this.helper.css("top"));if(j.containment){k+=c(j.containment).scrollLeft()||0;h+=c(j.containment).scrollTop()||0}this.offset=this.helper.offset();this.position={left:k,top:h};this.size=this._helper?{width:e.outerWidth(),height:e.outerHeight()}:{width:e.width(),height:e.height()};this.originalSize=this._helper?{width:e.outerWidth(),height:e.outerHeight()}:{width:e.width(),height:e.height()};this.originalPosition={left:k,top:h};this.sizeDiff={width:e.outerWidth()-e.width(),height:e.outerHeight()-e.height()};this.originalMousePosition={left:g.pageX,top:g.pageY};this.aspectRatio=(typeof j.aspectRatio=="number")?j.aspectRatio:((this.originalSize.width/this.originalSize.height)||1);var i=c(".ui-resizable-"+this.axis).css("cursor");c("body").css("cursor",i=="auto"?this.axis+"-resize":i);e.addClass("ui-resizable-resizing");this._propagate("start",g);return true},_mouseDrag:function(e){var h=this.helper,g=this.options,m={},q=this,j=this.originalMousePosition,n=this.axis;var r=(e.pageX-j.left)||0,p=(e.pageY-j.top)||0;var i=this._change[n];if(!i){return false}var l=i.apply(this,[e,r,p]),k=c.browser.msie&&c.browser.version<7,f=this.sizeDiff;this._updateVirtualBoundaries(e.shiftKey);if(this._aspectRatio||e.shiftKey){l=this._updateRatio(l,e)}l=this._respectSize(l,e);this._propagate("resize",e);h.css({top:this.position.top+"px",left:this.position.left+"px",width:this.size.width+"px",height:this.size.height+"px"});if(!this._helper&&this._proportionallyResizeElements.length){this._proportionallyResize()}this._updateCache(l);this._trigger("resize",e,this.ui());return false},_mouseStop:function(h){this.resizing=false;var i=this.options,m=this;if(this._helper){var g=this._proportionallyResizeElements,e=g.length&&(/textarea/i).test(g[0].nodeName),f=e&&c.ui.hasScroll(g[0],"left")?0:m.sizeDiff.height,k=e?0:m.sizeDiff.width;var n={width:(m.helper.width()-k),height:(m.helper.height()-f)},j=(parseInt(m.element.css("left"),10)+(m.position.left-m.originalPosition.left))||null,l=(parseInt(m.element.css("top"),10)+(m.position.top-m.originalPosition.top))||null;if(!i.animate){this.element.css(c.extend(n,{top:l,left:j}))}m.helper.height(m.size.height);m.helper.width(m.size.width);if(this._helper&&!i.animate){this._proportionallyResize()}}c("body").css("cursor","auto");this.element.removeClass("ui-resizable-resizing");this._propagate("stop",h);if(this._helper){this.helper.remove()}return false},_updateVirtualBoundaries:function(g){var j=this.options,i,h,f,k,e;e={minWidth:a(j.minWidth)?j.minWidth:0,maxWidth:a(j.maxWidth)?j.maxWidth:Infinity,minHeight:a(j.minHeight)?j.minHeight:0,maxHeight:a(j.maxHeight)?j.maxHeight:Infinity};if(this._aspectRatio||g){i=e.minHeight*this.aspectRatio;f=e.minWidth/this.aspectRatio;h=e.maxHeight*this.aspectRatio;k=e.maxWidth/this.aspectRatio;if(i>e.minWidth){e.minWidth=i}if(f>e.minHeight){e.minHeight=f}if(hl.width),s=a(l.height)&&i.minHeight&&(i.minHeight>l.height);if(h){l.width=i.minWidth}if(s){l.height=i.minHeight}if(t){l.width=i.maxWidth}if(m){l.height=i.maxHeight}var f=this.originalPosition.left+this.originalSize.width,p=this.position.top+this.size.height;var k=/sw|nw|w/.test(q),e=/nw|ne|n/.test(q);if(h&&k){l.left=f-i.minWidth}if(t&&k){l.left=f-i.maxWidth}if(s&&e){l.top=p-i.minHeight}if(m&&e){l.top=p-i.maxHeight}var n=!l.width&&!l.height;if(n&&!l.left&&l.top){l.top=null}else{if(n&&!l.top&&l.left){l.left=null}}return l},_proportionallyResize:function(){var k=this.options;if(!this._proportionallyResizeElements.length){return}var g=this.helper||this.element;for(var f=0;f');var e=c.browser.msie&&c.browser.version<7,g=(e?1:0),h=(e?2:-1);this.helper.addClass(this._helper).css({width:this.element.outerWidth()+h,height:this.element.outerHeight()+h,position:"absolute",left:this.elementOffset.left-g+"px",top:this.elementOffset.top-g+"px",zIndex:++i.zIndex});this.helper.appendTo("body").disableSelection()}else{this.helper=this.element}},_change:{e:function(g,f,e){return{width:this.originalSize.width+f}},w:function(h,f,e){var j=this.options,g=this.originalSize,i=this.originalPosition;return{left:i.left+f,width:g.width-f}},n:function(h,f,e){var j=this.options,g=this.originalSize,i=this.originalPosition;return{top:i.top+e,height:g.height-e}},s:function(g,f,e){return{height:this.originalSize.height+e}},se:function(g,f,e){return c.extend(this._change.s.apply(this,arguments),this._change.e.apply(this,[g,f,e]))},sw:function(g,f,e){return c.extend(this._change.s.apply(this,arguments),this._change.w.apply(this,[g,f,e]))},ne:function(g,f,e){return c.extend(this._change.n.apply(this,arguments),this._change.e.apply(this,[g,f,e]))},nw:function(g,f,e){return c.extend(this._change.n.apply(this,arguments),this._change.w.apply(this,[g,f,e]))}},_propagate:function(f,e){c.ui.plugin.call(this,f,[e,this.ui()]);(f!="resize"&&this._trigger(f,e,this.ui()))},plugins:{},ui:function(){return{originalElement:this.originalElement,element:this.element,helper:this.helper,position:this.position,size:this.size,originalSize:this.originalSize,originalPosition:this.originalPosition}}});c.extend(c.ui.resizable,{version:"1.8.18"});c.ui.plugin.add("resizable","alsoResize",{start:function(f,g){var e=c(this).data("resizable"),i=e.options;var h=function(j){c(j).each(function(){var k=c(this);k.data("resizable-alsoresize",{width:parseInt(k.width(),10),height:parseInt(k.height(),10),left:parseInt(k.css("left"),10),top:parseInt(k.css("top"),10)})})};if(typeof(i.alsoResize)=="object"&&!i.alsoResize.parentNode){if(i.alsoResize.length){i.alsoResize=i.alsoResize[0];h(i.alsoResize)}else{c.each(i.alsoResize,function(j){h(j)})}}else{h(i.alsoResize)}},resize:function(g,i){var f=c(this).data("resizable"),j=f.options,h=f.originalSize,l=f.originalPosition;var k={height:(f.size.height-h.height)||0,width:(f.size.width-h.width)||0,top:(f.position.top-l.top)||0,left:(f.position.left-l.left)||0},e=function(m,n){c(m).each(function(){var q=c(this),r=c(this).data("resizable-alsoresize"),p={},o=n&&n.length?n:q.parents(i.originalElement[0]).length?["width","height"]:["width","height","top","left"];c.each(o,function(s,u){var t=(r[u]||0)+(k[u]||0);if(t&&t>=0){p[u]=t||null}});q.css(p)})};if(typeof(j.alsoResize)=="object"&&!j.alsoResize.nodeType){c.each(j.alsoResize,function(m,n){e(m,n)})}else{e(j.alsoResize)}},stop:function(e,f){c(this).removeData("resizable-alsoresize")}});c.ui.plugin.add("resizable","animate",{stop:function(i,n){var p=c(this).data("resizable"),j=p.options;var h=p._proportionallyResizeElements,e=h.length&&(/textarea/i).test(h[0].nodeName),f=e&&c.ui.hasScroll(h[0],"left")?0:p.sizeDiff.height,l=e?0:p.sizeDiff.width;var g={width:(p.size.width-l),height:(p.size.height-f)},k=(parseInt(p.element.css("left"),10)+(p.position.left-p.originalPosition.left))||null,m=(parseInt(p.element.css("top"),10)+(p.position.top-p.originalPosition.top))||null;p.element.animate(c.extend(g,m&&k?{top:m,left:k}:{}),{duration:j.animateDuration,easing:j.animateEasing,step:function(){var o={width:parseInt(p.element.css("width"),10),height:parseInt(p.element.css("height"),10),top:parseInt(p.element.css("top"),10),left:parseInt(p.element.css("left"),10)};if(h&&h.length){c(h[0]).css({width:o.width,height:o.height})}p._updateCache(o);p._propagate("resize",i)}})}});c.ui.plugin.add("resizable","containment",{start:function(f,r){var t=c(this).data("resizable"),j=t.options,l=t.element;var g=j.containment,k=(g instanceof c)?g.get(0):(/parent/.test(g))?l.parent().get(0):g;if(!k){return}t.containerElement=c(k);if(/document/.test(g)||g==document){t.containerOffset={left:0,top:0};t.containerPosition={left:0,top:0};t.parentData={element:c(document),left:0,top:0,width:c(document).width(),height:c(document).height()||document.body.parentNode.scrollHeight}}else{var n=c(k),i=[];c(["Top","Right","Left","Bottom"]).each(function(p,o){i[p]=b(n.css("padding"+o))});t.containerOffset=n.offset();t.containerPosition=n.position();t.containerSize={height:(n.innerHeight()-i[3]),width:(n.innerWidth()-i[1])};var q=t.containerOffset,e=t.containerSize.height,m=t.containerSize.width,h=(c.ui.hasScroll(k,"left")?k.scrollWidth:m),s=(c.ui.hasScroll(k)?k.scrollHeight:e);t.parentData={element:k,left:q.left,top:q.top,width:h,height:s}}},resize:function(g,q){var t=c(this).data("resizable"),i=t.options,f=t.containerSize,p=t.containerOffset,m=t.size,n=t.position,r=t._aspectRatio||g.shiftKey,e={top:0,left:0},h=t.containerElement;if(h[0]!=document&&(/static/).test(h.css("position"))){e=p}if(n.left<(t._helper?p.left:0)){t.size.width=t.size.width+(t._helper?(t.position.left-p.left):(t.position.left-e.left));if(r){t.size.height=t.size.width/i.aspectRatio}t.position.left=i.helper?p.left:0}if(n.top<(t._helper?p.top:0)){t.size.height=t.size.height+(t._helper?(t.position.top-p.top):t.position.top);if(r){t.size.width=t.size.height*i.aspectRatio}t.position.top=t._helper?p.top:0}t.offset.left=t.parentData.left+t.position.left;t.offset.top=t.parentData.top+t.position.top;var l=Math.abs((t._helper?t.offset.left-e.left:(t.offset.left-e.left))+t.sizeDiff.width),s=Math.abs((t._helper?t.offset.top-e.top:(t.offset.top-p.top))+t.sizeDiff.height);var k=t.containerElement.get(0)==t.element.parent().get(0),j=/relative|absolute/.test(t.containerElement.css("position"));if(k&&j){l-=t.parentData.left}if(l+t.size.width>=t.parentData.width){t.size.width=t.parentData.width-l;if(r){t.size.height=t.size.width/t.aspectRatio}}if(s+t.size.height>=t.parentData.height){t.size.height=t.parentData.height-s;if(r){t.size.width=t.size.height*t.aspectRatio}}},stop:function(f,n){var q=c(this).data("resizable"),g=q.options,l=q.position,m=q.containerOffset,e=q.containerPosition,i=q.containerElement;var j=c(q.helper),r=j.offset(),p=j.outerWidth()-q.sizeDiff.width,k=j.outerHeight()-q.sizeDiff.height;if(q._helper&&!g.animate&&(/relative/).test(i.css("position"))){c(this).css({left:r.left-e.left-m.left,width:p,height:k})}if(q._helper&&!g.animate&&(/static/).test(i.css("position"))){c(this).css({left:r.left-e.left-m.left,width:p,height:k})}}});c.ui.plugin.add("resizable","ghost",{start:function(g,h){var e=c(this).data("resizable"),i=e.options,f=e.size;e.ghost=e.originalElement.clone();e.ghost.css({opacity:0.25,display:"block",position:"relative",height:f.height,width:f.width,margin:0,left:0,top:0}).addClass("ui-resizable-ghost").addClass(typeof i.ghost=="string"?i.ghost:"");e.ghost.appendTo(e.helper)},resize:function(f,g){var e=c(this).data("resizable"),h=e.options;if(e.ghost){e.ghost.css({position:"relative",height:e.size.height,width:e.size.width})}},stop:function(f,g){var e=c(this).data("resizable"),h=e.options;if(e.ghost&&e.helper){e.helper.get(0).removeChild(e.ghost.get(0))}}});c.ui.plugin.add("resizable","grid",{resize:function(e,m){var p=c(this).data("resizable"),h=p.options,k=p.size,i=p.originalSize,j=p.originalPosition,n=p.axis,l=h._aspectRatio||e.shiftKey;h.grid=typeof h.grid=="number"?[h.grid,h.grid]:h.grid;var g=Math.round((k.width-i.width)/(h.grid[0]||1))*(h.grid[0]||1),f=Math.round((k.height-i.height)/(h.grid[1]||1))*(h.grid[1]||1);if(/^(se|s|e)$/.test(n)){p.size.width=i.width+g;p.size.height=i.height+f}else{if(/^(ne)$/.test(n)){p.size.width=i.width+g;p.size.height=i.height+f;p.position.top=j.top-f}else{if(/^(sw)$/.test(n)){p.size.width=i.width+g;p.size.height=i.height+f;p.position.left=j.left-g}else{p.size.width=i.width+g;p.size.height=i.height+f;p.position.top=j.top-f;p.position.left=j.left-g}}}}});var b=function(e){return parseInt(e,10)||0};var a=function(e){return !isNaN(parseInt(e,10))}})(jQuery);/*! + * jQuery hashchange event - v1.3 - 7/21/2010 + * http://benalman.com/projects/jquery-hashchange-plugin/ + * + * Copyright (c) 2010 "Cowboy" Ben Alman + * Dual licensed under the MIT and GPL licenses. + * http://benalman.com/about/license/ + */ +(function($,e,b){var c="hashchange",h=document,f,g=$.event.special,i=h.documentMode,d="on"+c in e&&(i===b||i>7);function a(j){j=j||location.href;return"#"+j.replace(/^[^#]*#?(.*)$/,"$1")}$.fn[c]=function(j){return j?this.bind(c,j):this.trigger(c)};$.fn[c].delay=50;g[c]=$.extend(g[c],{setup:function(){if(d){return false}$(f.start)},teardown:function(){if(d){return false}$(f.stop)}});f=(function(){var j={},p,m=a(),k=function(q){return q},l=k,o=k;j.start=function(){p||n()};j.stop=function(){p&&clearTimeout(p);p=b};function n(){var r=a(),q=o(m);if(r!==m){l(m=r,q);$(e).trigger(c)}else{if(q!==m){location.href=location.href.replace(/#.*/,"")+q}}p=setTimeout(n,$.fn[c].delay)}$.browser.msie&&!d&&(function(){var q,r;j.start=function(){if(!q){r=$.fn[c].src;r=r&&r+a();q=$(' + + +
+
+
SmartFactory_MQTTCommunication
+
+
+

The SmartFactroy_MQTTCommunication is an modular part of the SmartFactory Project.

+

MQTTCommunication establishes a WLAN-Connection and allows you to connect

+

with an MQTT-Broker to send and receive Message.

+

Incomming Messages need to be in a known JSON-Format and will be converted into a Struct.

+

These Messages-Structs are stored in a Circular-Buffer.

+

Table of Content

+

The SmartFactory Project

+

SmartFactory_MQTTCommunication is part of the SmartFactory-Project. It provides a library with basic MQTT-Communication functions.

+

Other SmartFactory-Components are:

+

A possible implementation of the SmartFactory-Project can be seen in the Sortic-Showcase:

+ +

The associated Repositorys are:

+

SmartFactory-Sortic

+

SmartFactory_Box-Sortic

+

SmartFactory_Vehicle-Sortic

+

SmartFactory_Vehicle-Basis

+

SmartFactory_MQTTCommunication

+

Tools and Technologies

+

The Source-code is written in C++. To achieve this project, the following tools and technologies were used.

+

Doxygen

+

Doxygen is used for the documentation of the source code.

+

An intorduction to Doxygen and how to install it can be found in the ArdFSM-Repo.

+

VSCode PlatformIO

+

The used IDE is VSCode with the PlatformIO-Extension.

+

MQTT

+

MQTT (Message Queuing Telemetry Transport) is a lightweight publish-subscribe messaging protocol and requires a broker to relay the messages. It's used for M2M (machine-to-machine) communication.

+

An MQTT-System always consist of a broker and one or multiple clients, which can be either subscriber or publisher.

+ +

[Image: MQTT101 - Eclispe Foundation]

+

A Client can subscribe and publish to one or multiple Topics. Topics are organized in a Tree similar to a Folder-structure in Windows. Here's an example of how such a Topic-Tree and published message can look like:

+ +

This Images also illustrates the scalability of MQTT appropriately.

+

For more Infos about MQTT and MQTT-Topics check out the MQTT-Wiki on Github.

+

[Source: Wiki:MQTT, MQTT ]

+

Circular Buffer

+

A Circular Buffer or a Ring-Buffer uses an buffer with fixed Size. If the Buffer is full the oldest Element gets overwritten.

+

+

+

[Image: Wiki: Circular buffer]

+

Documentation

+

Hardware

+

This Code needs a WLAN-Shield to function properly.

+

It's tested with a Adafruit Feather M0 WiFi - ATSAMD21 + ATWINC1500 from Adafruit.

+

Software

+

All functions and files are documented on the GitHub-Page with Doxygen

+

Dependency Graph

+

+

+

Click on the image to open doxygen-documentation.

+

+

+

External Libraries:

+

+

+

Collaboration Diagram

+

+

+

+

+

+

Click on the image to open doxygen-documentation.

+

+

+

+

Important Functions and Files

+

+

+

MQTTCommunication.h

+

+

The MQTTCommunication.h-File serves as Interface. It provides the functions for:

    +
  • Network-Connection
    • +
  • MQTT-Functionalities
    • +
  • access the Message-Storage (Cirrcular Buffer)
    • +
+

+

CommunicationConfiguration.h

+

+

In the CommunicationConfiguration.h-File are all important settings defined:

    +
  • WLAN SSID
    • +
  • WLAN password
    • +
  • WLAN Shield pins
    • +
  • MQTT Broker IP
    • +
  • JSON parse size
    • +
  • Cirrcular Buffer size
    • +
+

+

myJSONStr.h

+

+

In the myJSONStr.h-File is defined how the JSON-Message and hence the struct looks like.

+

This is how the JSON-Message (received as String) can look like:

{
"id": "hostname",
"topic": "topic/topic",
"status": "driving",
"sector": "transit",
"line": 1,
"ack":"hostname",
"req":"hostname",
"cargo":"beer",
"token":false;
"error":false
}

And the corresponding Struct in which the message gets parsed:

struct myJSONStr {
String id = "hostname";
String topic = "topic/topic";
String status = "driving";
String sector = "transit";
int line = 1;
String ack = "hostname";
String req = "hostname";
String cargo = "beer";
bool token = false;
bool error = false;
};

+

+

FAQ's

+

+

I'd like to use this code in my project. What do I need to know?

+

+

+

All you need to do is add the GitHub-Link to this Repo under lib_deps in your platformio.ini File and you're set up. All dependencies are downloaded automatic.

+
+

+

Where can I change the configurations like MQTT-Broker IP and WLAN-Credentials?

+

+

+

All the Configuration data is stored in the CommunicationConfiguration.h file and can be edited there.

+
+

+

I'd like to change the incoming JSON-Message. How can I do that?

+

+

+

Incoming messages need to be in a know JSON-Format which is defined in* myJSONStr.h* and needs to match the implementation in myJSON::parsingJSONToStruct. If you would like to change this format you need to adapt both files.

+
+

+

ToDo's

+

+

The open ToDo's can be found in the Documentation on the GitHub-Page

    +
  • [ ] Split the Code in 2 Repos: MQTTCommunication-Sortic and MQTTCommunication in order to increase reusability.
    • +
+

+

Contributors

+

+

+

+

Changelog

+

+

V 1.0 - Release BA FS19 - Luca Mazzoleni

+

License

+

+

+

MIT License

+
+
+ + + + + diff --git a/sw-modules/module-package-reader/docs/menu.js b/sw-modules/module-package-reader/docs/menu.js new file mode 100644 index 0000000..433c15b --- /dev/null +++ b/sw-modules/module-package-reader/docs/menu.js @@ -0,0 +1,50 @@ +/* + @licstart The following is the entire license notice for the + JavaScript code in this file. + + Copyright (C) 1997-2017 by Dimitri van Heesch + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + + @licend The above is the entire license notice + for the JavaScript code in this file + */ +function initMenu(relPath,searchEnabled,serverSide,searchPage,search) { + function makeTree(data,relPath) { + var result=''; + if ('children' in data) { + result+=''; + } + return result; + } + + $('#main-nav').append(makeTree(menudata,relPath)); + $('#main-nav').children(':first').addClass('sm sm-dox').attr('id','main-menu'); + if (searchEnabled) { + if (serverSide) { + $('#main-menu').append('
    • '); + } else { + $('#main-menu').append('
    • '); + } + } + $('#main-menu').smartmenus(); +} +/* @license-end */ diff --git a/sw-modules/module-package-reader/docs/menudata.js b/sw-modules/module-package-reader/docs/menudata.js new file mode 100644 index 0000000..b38e609 --- /dev/null +++ b/sw-modules/module-package-reader/docs/menudata.js @@ -0,0 +1,77 @@ +/* +@ @licstart The following is the entire license notice for the +JavaScript code in this file. + +Copyright (C) 1997-2017 by Dimitri van Heesch + +This program is free software; you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation; either version 2 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + +You should have received a copy of the GNU General Public License along +with this program; if not, write to the Free Software Foundation, Inc., +51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +@licend The above is the entire license notice +for the JavaScript code in this file +*/ +var menudata={children:[ +{text:"Main Page",url:"index.html"}, +{text:"Related Pages",url:"pages.html"}, +{text:"Classes",url:"annotated.html",children:[ +{text:"Class List",url:"annotated.html"}, +{text:"Class Index",url:"classes.html"}, +{text:"Class Members",url:"functions.html",children:[ +{text:"All",url:"functions.html",children:[ +{text:"a",url:"functions.html#index_a"}, +{text:"c",url:"functions.html#index_c"}, +{text:"d",url:"functions.html#index_d"}, +{text:"e",url:"functions.html#index_e"}, +{text:"f",url:"functions.html#index_f"}, +{text:"g",url:"functions.html#index_g"}, +{text:"i",url:"functions.html#index_i"}, +{text:"l",url:"functions.html#index_l"}, +{text:"m",url:"functions.html#index_m"}, +{text:"n",url:"functions.html#index_n"}, +{text:"p",url:"functions.html#index_p"}, +{text:"r",url:"functions.html#index_r"}, +{text:"s",url:"functions.html#index_s"}, +{text:"t",url:"functions.html#index_t"}, +{text:"u",url:"functions.html#index_u"}]}, +{text:"Functions",url:"functions_func.html",children:[ +{text:"c",url:"functions_func.html#index_c"}, +{text:"d",url:"functions_func.html#index_d"}, +{text:"f",url:"functions_func.html#index_f"}, +{text:"g",url:"functions_func.html#index_g"}, +{text:"i",url:"functions_func.html#index_i"}, +{text:"l",url:"functions_func.html#index_l"}, +{text:"m",url:"functions_func.html#index_m"}, +{text:"n",url:"functions_func.html#index_n"}, +{text:"p",url:"functions_func.html#index_p"}, +{text:"s",url:"functions_func.html#index_s"}, +{text:"u",url:"functions_func.html#index_u"}]}, +{text:"Variables",url:"functions_vars.html",children:[ +{text:"a",url:"functions_vars.html#index_a"}, +{text:"c",url:"functions_vars.html#index_c"}, +{text:"e",url:"functions_vars.html#index_e"}, +{text:"f",url:"functions_vars.html#index_f"}, +{text:"i",url:"functions_vars.html#index_i"}, +{text:"l",url:"functions_vars.html#index_l"}, +{text:"m",url:"functions_vars.html#index_m"}, +{text:"p",url:"functions_vars.html#index_p"}, +{text:"r",url:"functions_vars.html#index_r"}, +{text:"s",url:"functions_vars.html#index_s"}, +{text:"t",url:"functions_vars.html#index_t"}]}]}]}, +{text:"Files",url:"files.html",children:[ +{text:"File List",url:"files.html"}, +{text:"File Members",url:"globals.html",children:[ +{text:"All",url:"globals.html"}, +{text:"Functions",url:"globals_func.html"}, +{text:"Variables",url:"globals_vars.html"}, +{text:"Macros",url:"globals_defs.html"}]}]}]} diff --git a/sw-modules/module-package-reader/docs/my_j_s_o_n_8cpp.html b/sw-modules/module-package-reader/docs/my_j_s_o_n_8cpp.html new file mode 100644 index 0000000..6dac9ab --- /dev/null +++ b/sw-modules/module-package-reader/docs/my_j_s_o_n_8cpp.html @@ -0,0 +1,132 @@ + + + + + + + +MQTT Communication: myJSON.cpp File Reference + + + + + + + + + + + + + + +
    +
    +
    + + + + + +
    +
    MQTT Communication +
    +
    Smart Factory
    +
    + + + + + + + + + +
    + +
    +
    +
    + +
    + +
    +
    + + +
    + +
    + +
    +
    +
    myJSON.cpp File Reference
    +
    +
    + +

    Implementation of the myJSON-class. +More...

    +
    #include "myJSON.h"
    +
    +Include dependency graph for myJSON.cpp:
    +
    +
    + + + + + + + + +
    +
    +

    Go to the source code of this file.

    +

    Detailed Description

    +

    Implementation of the myJSON-class.

    +
    Author
    Luca Mazzoleni (luca..nosp@m.mazz.nosp@m.oleni.nosp@m.@hsr.nosp@m..ch)
    +
    Version
    1.0 - added JSON-Conversion - Luca Mazzoleni (luca..nosp@m.mazz.nosp@m.oleni.nosp@m.@hsr.nosp@m..ch) - 2019-04-17
    +
    Date
    2019-04-09
    +
    Copyright
    Copyright (c) 2019
    + +

    Definition in file myJSON.cpp.

    +
    +
    + + + + diff --git a/sw-modules/module-package-reader/docs/my_j_s_o_n_8cpp__incl.map b/sw-modules/module-package-reader/docs/my_j_s_o_n_8cpp__incl.map new file mode 100644 index 0000000..f6d453a --- /dev/null +++ b/sw-modules/module-package-reader/docs/my_j_s_o_n_8cpp__incl.map @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/sw-modules/module-package-reader/docs/my_j_s_o_n_8cpp__incl.md5 b/sw-modules/module-package-reader/docs/my_j_s_o_n_8cpp__incl.md5 new file mode 100644 index 0000000..3148303 --- /dev/null +++ b/sw-modules/module-package-reader/docs/my_j_s_o_n_8cpp__incl.md5 @@ -0,0 +1 @@ +ba5bccfd92938623f5bcf6f649e74e9b \ No newline at end of file diff --git a/sw-modules/module-package-reader/docs/my_j_s_o_n_8cpp__incl.png b/sw-modules/module-package-reader/docs/my_j_s_o_n_8cpp__incl.png new file mode 100644 index 0000000..4c5955f Binary files /dev/null and b/sw-modules/module-package-reader/docs/my_j_s_o_n_8cpp__incl.png differ diff --git a/sw-modules/module-package-reader/docs/my_j_s_o_n_8cpp_source.html b/sw-modules/module-package-reader/docs/my_j_s_o_n_8cpp_source.html new file mode 100644 index 0000000..0f93a2e --- /dev/null +++ b/sw-modules/module-package-reader/docs/my_j_s_o_n_8cpp_source.html @@ -0,0 +1,119 @@ + + + + + + + +MQTT Communication: myJSON.cpp Source File + + + + + + + + + + + + + + +
    +
    + + + + + + +
    +
    MQTT Communication +
    +
    Smart Factory
    +
    +
    + + + + + + + +
    +
    + +
    +
    +
    + +
    + +
    +
    + + +
    + +
    + +
    +
    +
    myJSON.cpp
    +
    +
    +Go to the documentation of this file.
    1 
    14 #include "myJSON.h"
    15 
    16 myJSON::myJSON(const size_t ParsCapacity) : pParsCapacity(ParsCapacity) {
    17 }
    18 
    19 myJSONStr myJSON::parsingJSONToStruct(const char* json) {
    20  DBFUNCCALLln("myJSON::parsingJSONToStruct(const char* json)");
    21  DBINFO3ln(json);
    22  myJSONStr tempStr;
    23  DynamicJsonDocument doc(pParsCapacity);
    24 
    25  DeserializationError error = deserializeJson(doc, json);
    26  if (error) {
    27  DBWARNING("deserializeJson() failed: ");
    28  DBWARNINGln(error.c_str());
    29  tempStr.id = "Pars failed";
    30  return tempStr;
    31  } else {
    32  // DBINFO1("deserializeJson() success: ");
    33  /* use excplicit cast to prevent ambiguity
    34  * https://arduinojson.org/v6/doc/deserialization/ S67
    35  */
    36 
    37  tempStr.id = doc["id"].as<String>(); // "SV46465"
    38  tempStr.status = doc["status"].as<String>(); // "driving"
    39  tempStr.sector = doc["sector"].as<String>(); // "sector"
    40  tempStr.line = doc["line"].as<int>(); // 1
    41  tempStr.ack = doc["ack"].as<String>(); // "hostname"
    42  tempStr.req = doc["req"].as<String>(); // "hostname"
    43  tempStr.cargo = doc["cargo"].as<String>(); // "gemuse"
    44  tempStr.token = doc["token"].as<bool>(); // false
    45  tempStr.error = doc["error"].as<bool>(); // false
    46  return tempStr;
    47  }
    48 }
    49 
    50 //Serializing program ===================================================
    51 // String myJSON::serializ(myJSONStr tempStr) {
    52 // // DynamicJsonDocument doc(pSerializCapacity);
    53 
    54 // // doc["urgent"] = tempStr.urgent;
    55 // // doc["topic"] = tempStr.topic;
    56 // // doc["hostname"] = tempStr.hostname;
    57 // // doc["request"] = tempStr.request;
    58 // // doc["level"] = tempStr.level;
    59 
    60 // // JsonArray vehicleParams = doc.createNestedArray("vehicleParams");
    61 // // vehicleParams.add(tempStr.vehicleParams);
    62 // // // vehicleParams.add(tempStr.vehicleParams[0]);
    63 // // // vehicleParams.add(tempStr.vehicleParams[1]));
    64 // // // vehicleParams.add(tempStr.vehicleParams[2]));
    65 // // // vehicleParams.add(tempStr.vehicleParams[3]));
    66 // // // vehicleParams.add(tempStr.vehicleParams[4]));
    67 
    68 // // serializeJson(doc, Serial);
    69 // // // serializeJsonPretty(doc, Serial);
    70 // }
    myJSONStr::req
    String req
    Request.
    Definition: myJSONStr.h:40
    +
    myJSON.h
    myJSON class handels the conversion from the JSON-Format into a struct
    +
    myJSONStr
    myJSON Struct defines the format of the messages
    Definition: myJSONStr.h:33
    +
    myJSON::pParsCapacity
    const size_t pParsCapacity
    Definition: myJSON.h:51
    +
    myJSONStr::cargo
    String cargo
    Cargo.
    Definition: myJSONStr.h:41
    +
    myJSONStr::line
    int line
    Line.
    Definition: myJSONStr.h:38
    +
    myJSON::myJSON
    myJSON(const size_t ParsCapacity)
    Construct a new myJSON object.
    Definition: myJSON.cpp:16
    +
    myJSONStr::error
    bool error
    Error-token.
    Definition: myJSONStr.h:43
    +
    myJSONStr::status
    String status
    Status.
    Definition: myJSONStr.h:36
    +
    myJSONStr::id
    String id
    Hostname.
    Definition: myJSONStr.h:34
    +
    myJSONStr::sector
    String sector
    Sector.
    Definition: myJSONStr.h:37
    +
    myJSON::parsingJSONToStruct
    myJSONStr parsingJSONToStruct(const char *json)
    Parsing JSON-Format into myJSONStr.
    Definition: myJSON.cpp:19
    +
    myJSONStr::ack
    String ack
    Acknoledgement.
    Definition: myJSONStr.h:39
    +
    myJSONStr::token
    bool token
    Gateway and Reset-token.
    Definition: myJSONStr.h:42
    +
    +
    + + + + diff --git a/sw-modules/module-package-reader/docs/my_j_s_o_n_8h.html b/sw-modules/module-package-reader/docs/my_j_s_o_n_8h.html new file mode 100644 index 0000000..d04de6c --- /dev/null +++ b/sw-modules/module-package-reader/docs/my_j_s_o_n_8h.html @@ -0,0 +1,154 @@ + + + + + + + +MQTT Communication: myJSON.h File Reference + + + + + + + + + + + + + + +
    +
    + + + + + + +
    +
    MQTT Communication +
    +
    Smart Factory
    +
    +
    + + + + + + + +
    +
    + +
    +
    +
    + +
    + +
    +
    + + +
    + +
    + +
    +
    +Classes
    +
    +
    myJSON.h File Reference
    +
    +
    + +

    myJSON class handels the conversion from the JSON-Format into a struct +More...

    +
    #include "Arduino.h"
    +#include "myJSONStr.h"
    +#include "LogConfiguration.h"
    +#include <ArduinoJson.h>
    +
    +Include dependency graph for myJSON.h:
    +
    +
    + + + + + + + +
    +
    +This graph shows which files directly or indirectly include this file:
    +
    +
    + + + + + + +
    +
    +

    Go to the source code of this file.

    + + + + + +

    +Classes

    class  myJSON
     myJSON class handels the conversion from the JSON-Format into a struct More...
     
    +

    Detailed Description

    +

    myJSON class handels the conversion from the JSON-Format into a struct

    +
    Author
    Luca Mazzoleni (luca..nosp@m.mazz.nosp@m.oleni.nosp@m.@hsr.nosp@m..ch)
    +
    Version
    1.0 - added JSON-Conversion - Luca Mazzoleni (luca..nosp@m.mazz.nosp@m.oleni.nosp@m.@hsr.nosp@m..ch) - 2019-04-17
    +
    Date
    2019-04-09
    +
    Copyright
    Copyright (c) 2019
    + +

    Definition in file myJSON.h.

    +
    +
    + + + + diff --git a/sw-modules/module-package-reader/docs/my_j_s_o_n_8h__dep__incl.map b/sw-modules/module-package-reader/docs/my_j_s_o_n_8h__dep__incl.map new file mode 100644 index 0000000..b8793a6 --- /dev/null +++ b/sw-modules/module-package-reader/docs/my_j_s_o_n_8h__dep__incl.map @@ -0,0 +1,6 @@ + + + + + + diff --git a/sw-modules/module-package-reader/docs/my_j_s_o_n_8h__dep__incl.md5 b/sw-modules/module-package-reader/docs/my_j_s_o_n_8h__dep__incl.md5 new file mode 100644 index 0000000..36ec4ba --- /dev/null +++ b/sw-modules/module-package-reader/docs/my_j_s_o_n_8h__dep__incl.md5 @@ -0,0 +1 @@ +cfb7b1d8ea3bca924c0c3652822582ec \ No newline at end of file diff --git a/sw-modules/module-package-reader/docs/my_j_s_o_n_8h__dep__incl.png b/sw-modules/module-package-reader/docs/my_j_s_o_n_8h__dep__incl.png new file mode 100644 index 0000000..e5eccb2 Binary files /dev/null and b/sw-modules/module-package-reader/docs/my_j_s_o_n_8h__dep__incl.png differ diff --git a/sw-modules/module-package-reader/docs/my_j_s_o_n_8h__incl.map b/sw-modules/module-package-reader/docs/my_j_s_o_n_8h__incl.map new file mode 100644 index 0000000..08b4417 --- /dev/null +++ b/sw-modules/module-package-reader/docs/my_j_s_o_n_8h__incl.map @@ -0,0 +1,7 @@ + + + + + + + diff --git a/sw-modules/module-package-reader/docs/my_j_s_o_n_8h__incl.md5 b/sw-modules/module-package-reader/docs/my_j_s_o_n_8h__incl.md5 new file mode 100644 index 0000000..dd5eb93 --- /dev/null +++ b/sw-modules/module-package-reader/docs/my_j_s_o_n_8h__incl.md5 @@ -0,0 +1 @@ +c6ef1b7822188610eafca986ef69dfde \ No newline at end of file diff --git a/sw-modules/module-package-reader/docs/my_j_s_o_n_8h__incl.png b/sw-modules/module-package-reader/docs/my_j_s_o_n_8h__incl.png new file mode 100644 index 0000000..05adb49 Binary files /dev/null and b/sw-modules/module-package-reader/docs/my_j_s_o_n_8h__incl.png differ diff --git a/sw-modules/module-package-reader/docs/my_j_s_o_n_8h_source.html b/sw-modules/module-package-reader/docs/my_j_s_o_n_8h_source.html new file mode 100644 index 0000000..b490b00 --- /dev/null +++ b/sw-modules/module-package-reader/docs/my_j_s_o_n_8h_source.html @@ -0,0 +1,112 @@ + + + + + + + +MQTT Communication: myJSON.h Source File + + + + + + + + + + + + + + +
    +
    + + + + + + +
    +
    MQTT Communication +
    +
    Smart Factory
    +
    +
    + + + + + + + +
    +
    + +
    +
    +
    + +
    + +
    +
    + + +
    + +
    + +
    +
    +
    myJSON.h
    +
    +
    +Go to the documentation of this file.
    1 
    14 #ifndef MYJSON_H__
    15 #define MYJSON_H__
    16 
    17 #include "Arduino.h"
    18 #include "myJSONStr.h"
    19 
    20 #include "LogConfiguration.h"
    21 
    22 #include <ArduinoJson.h> //https://arduinojson.org/
    23 
    28 class myJSON {
    29  public:
    34  myJSON(const size_t ParsCapacity);
    35 
    45  myJSONStr parsingJSONToStruct(const char* json);
    46 
    47  // String serialize(myJSONStr tempStr);
    48  String lastMessage = "init"; //lastMessage is used to store the last received message
    49 
    50  private:
    51  const size_t pParsCapacity;
    52 };
    53 #endif
    myJSONStr
    myJSON Struct defines the format of the messages
    Definition: myJSONStr.h:33
    +
    myJSON::pParsCapacity
    const size_t pParsCapacity
    Definition: myJSON.h:51
    +
    myJSON::myJSON
    myJSON(const size_t ParsCapacity)
    Construct a new myJSON object.
    Definition: myJSON.cpp:16
    +
    myJSON::lastMessage
    String lastMessage
    Definition: myJSON.h:48
    +
    myJSONStr.h
    myJSON Struct defines the format of the messages
    +
    myJSON::parsingJSONToStruct
    myJSONStr parsingJSONToStruct(const char *json)
    Parsing JSON-Format into myJSONStr.
    Definition: myJSON.cpp:19
    +
    myJSON
    myJSON class handels the conversion from the JSON-Format into a struct
    Definition: myJSON.h:28
    +
    +
    + + + + diff --git a/sw-modules/module-package-reader/docs/my_j_s_o_n_str_8h.html b/sw-modules/module-package-reader/docs/my_j_s_o_n_str_8h.html new file mode 100644 index 0000000..d279db4 --- /dev/null +++ b/sw-modules/module-package-reader/docs/my_j_s_o_n_str_8h.html @@ -0,0 +1,139 @@ + + + + + + + +MQTT Communication: myJSONStr.h File Reference + + + + + + + + + + + + + + +
    +
    + + + + + + +
    +
    MQTT Communication +
    +
    Smart Factory
    +
    +
    + + + + + + + +
    +
    + +
    +
    +
    + +
    + +
    +
    + + +
    + +
    + +
    +
    +Classes
    +
    +
    myJSONStr.h File Reference
    +
    +
    + +

    myJSON Struct defines the format of the messages +More...

    +
    +This graph shows which files directly or indirectly include this file:
    +
    +
    + + + + + + + +
    +
    +

    Go to the source code of this file.

    + + + + + +

    +Classes

    struct  myJSONStr
     myJSON Struct defines the format of the messages More...
     
    +

    Detailed Description

    +

    myJSON Struct defines the format of the messages

    +
    Author
    Luca Mazzoleni (luca..nosp@m.mazz.nosp@m.oleni.nosp@m.@hsr.nosp@m..ch)
    +
    Version
    1.0 - added JSON-Conversion - Luca Mazzoleni (luca..nosp@m.mazz.nosp@m.oleni.nosp@m.@hsr.nosp@m..ch) - 2019-04-17
    +
    Date
    2019-04-09
    +
    Copyright
    Copyright (c) 2019
    + +

    Definition in file myJSONStr.h.

    +
    +
    + + + + diff --git a/sw-modules/module-package-reader/docs/my_j_s_o_n_str_8h__dep__incl.map b/sw-modules/module-package-reader/docs/my_j_s_o_n_str_8h__dep__incl.map new file mode 100644 index 0000000..3c9ad71 --- /dev/null +++ b/sw-modules/module-package-reader/docs/my_j_s_o_n_str_8h__dep__incl.map @@ -0,0 +1,7 @@ + + + + + + + diff --git a/sw-modules/module-package-reader/docs/my_j_s_o_n_str_8h__dep__incl.md5 b/sw-modules/module-package-reader/docs/my_j_s_o_n_str_8h__dep__incl.md5 new file mode 100644 index 0000000..716ef1b --- /dev/null +++ b/sw-modules/module-package-reader/docs/my_j_s_o_n_str_8h__dep__incl.md5 @@ -0,0 +1 @@ +e2c1d84b014f83fd9615f78463ba08a8 \ No newline at end of file diff --git a/sw-modules/module-package-reader/docs/my_j_s_o_n_str_8h__dep__incl.png b/sw-modules/module-package-reader/docs/my_j_s_o_n_str_8h__dep__incl.png new file mode 100644 index 0000000..37fc77f Binary files /dev/null and b/sw-modules/module-package-reader/docs/my_j_s_o_n_str_8h__dep__incl.png differ diff --git a/sw-modules/module-package-reader/docs/my_j_s_o_n_str_8h_source.html b/sw-modules/module-package-reader/docs/my_j_s_o_n_str_8h_source.html new file mode 100644 index 0000000..f65f937 --- /dev/null +++ b/sw-modules/module-package-reader/docs/my_j_s_o_n_str_8h_source.html @@ -0,0 +1,115 @@ + + + + + + + +MQTT Communication: myJSONStr.h Source File + + + + + + + + + + + + + + +
    +
    + + + + + + +
    +
    MQTT Communication +
    +
    Smart Factory
    +
    +
    + + + + + + + +
    +
    + +
    +
    +
    + +
    + +
    +
    + + +
    + +
    + +
    +
    +
    myJSONStr.h
    +
    +
    +Go to the documentation of this file.
    1 
    13 #ifndef MYJSONSTR_H
    14 #define MYJSONSTR_H
    15 
    16 // {
    17 // "id": "hostanme",
    18 // "topic": "tpois/topic",
    19 // "status": "driving",
    20 // "sector": "transit",
    21 // "line": 1,
    22 // "ack":"hostname",
    23 // "req":"hostname",
    24 // "cargo":"gemuse",
    25 // "token":false;
    26 // "error":false
    27 // }
    28 
    33 struct myJSONStr {
    34  String id = "-1";
    35  String topic = "-1";
    36  String status = "-1";
    37  String sector = "-1";
    38  int line = -1;
    39  String ack = "-1";
    40  String req = "-1";
    41  String cargo = "-1";
    42  bool token = false;
    43  bool error = false;
    44 };
    45 #endif
    myJSONStr::req
    String req
    Request.
    Definition: myJSONStr.h:40
    +
    myJSONStr
    myJSON Struct defines the format of the messages
    Definition: myJSONStr.h:33
    +
    myJSONStr::cargo
    String cargo
    Cargo.
    Definition: myJSONStr.h:41
    +
    myJSONStr::line
    int line
    Line.
    Definition: myJSONStr.h:38
    +
    myJSONStr::error
    bool error
    Error-token.
    Definition: myJSONStr.h:43
    +
    myJSONStr::status
    String status
    Status.
    Definition: myJSONStr.h:36
    +
    myJSONStr::topic
    String topic
    MQTT topic.
    Definition: myJSONStr.h:35
    +
    myJSONStr::sector
    String sector
    Sector.
    Definition: myJSONStr.h:37
    +
    myJSONStr::ack
    String ack
    Acknoledgement.
    Definition: myJSONStr.h:39
    +
    myJSONStr::token
    bool token
    Gateway and Reset-token.
    Definition: myJSONStr.h:42
    +
    +
    + + + + diff --git a/sw-modules/module-package-reader/docs/my_m_q_t_t_8cpp.html b/sw-modules/module-package-reader/docs/my_m_q_t_t_8cpp.html new file mode 100644 index 0000000..151b880 --- /dev/null +++ b/sw-modules/module-package-reader/docs/my_m_q_t_t_8cpp.html @@ -0,0 +1,135 @@ + + + + + + + +MQTT Communication: myMQTT.cpp File Reference + + + + + + + + + + + + + + +
    +
    + + + + + + +
    +
    MQTT Communication +
    +
    Smart Factory
    +
    +
    + + + + + + + +
    +
    + +
    +
    +
    + +
    + +
    +
    + + +
    + +
    + +
    +
    +
    myMQTT.cpp File Reference
    +
    +
    + +

    Implementation of the myMQTT class. +More...

    +
    #include "myMQTT.h"
    +
    +Include dependency graph for myMQTT.cpp:
    +
    +
    + + + + + + + + + + +
    +
    +

    Go to the source code of this file.

    +

    Detailed Description

    +

    Implementation of the myMQTT class.

    +

    https://pubsubclient.knolleary.net

    +
    Author
    Luca Mazzoleni (luca..nosp@m.mazz.nosp@m.oleni.nosp@m.@hsr.nosp@m..ch)
    +
    Version
    1.0 - added MQTT-Connection - Luca Mazzoleni (luca..nosp@m.mazz.nosp@m.oleni.nosp@m.@hsr.nosp@m..ch) - 2019-04-16
    +
    Date
    2019-04-16
    +
    Copyright
    Copyright (c) 2019
    + +

    Definition in file myMQTT.cpp.

    +
    +
    + + + + diff --git a/sw-modules/module-package-reader/docs/my_m_q_t_t_8cpp__incl.map b/sw-modules/module-package-reader/docs/my_m_q_t_t_8cpp__incl.map new file mode 100644 index 0000000..dc29a86 --- /dev/null +++ b/sw-modules/module-package-reader/docs/my_m_q_t_t_8cpp__incl.map @@ -0,0 +1,10 @@ + + + + + + + + + + diff --git a/sw-modules/module-package-reader/docs/my_m_q_t_t_8cpp__incl.md5 b/sw-modules/module-package-reader/docs/my_m_q_t_t_8cpp__incl.md5 new file mode 100644 index 0000000..9e95d1d --- /dev/null +++ b/sw-modules/module-package-reader/docs/my_m_q_t_t_8cpp__incl.md5 @@ -0,0 +1 @@ +2dd8d9aa587ea9fd33121b9c56c4cdcd \ No newline at end of file diff --git a/sw-modules/module-package-reader/docs/my_m_q_t_t_8cpp__incl.png b/sw-modules/module-package-reader/docs/my_m_q_t_t_8cpp__incl.png new file mode 100644 index 0000000..7b864c5 Binary files /dev/null and b/sw-modules/module-package-reader/docs/my_m_q_t_t_8cpp__incl.png differ diff --git a/sw-modules/module-package-reader/docs/my_m_q_t_t_8cpp_source.html b/sw-modules/module-package-reader/docs/my_m_q_t_t_8cpp_source.html new file mode 100644 index 0000000..979d83d --- /dev/null +++ b/sw-modules/module-package-reader/docs/my_m_q_t_t_8cpp_source.html @@ -0,0 +1,118 @@ + + + + + + + +MQTT Communication: myMQTT.cpp Source File + + + + + + + + + + + + + + +
    +
    + + + + + + +
    +
    MQTT Communication +
    +
    Smart Factory
    +
    +
    + + + + + + + +
    +
    + +
    +
    +
    + +
    + +
    +
    + + +
    + +
    + +
    +
    +
    myMQTT.cpp
    +
    +
    +Go to the documentation of this file.
    1 
    16 #include "myMQTT.h"
    17 
    18 //=====PUBLIC====================================================================================
    19 myMQTT::myMQTT(String hostname,
    20  const int BrokerIP1,
    21  const int BrokerIP2,
    22  const int BrokerIP3,
    23  const int BrokerIP4,
    24  const int BrokerPort) : pHostname(hostname),
    25  pBrokerIP(BrokerIP1,
    26  BrokerIP2,
    27  BrokerIP3,
    28  BrokerIP4),
    29  pBrokerPort(BrokerPort) {
    30  // myMQTTclient.PubSubClient(pBrokerIP, pBrokerPort, pToCallback, *myClient);
    31 }
    32 
    33 void myMQTT::init(WiFiClient *myClient, void (*pToCallback)(char *, unsigned char *, unsigned int)) {
    34  DBFUNCCALLln("myMQTT::init()");
    35  myMQTTclient.setClient(*myClient);
    36  myMQTTclient.setServer(pBrokerIP, pBrokerPort);
    37  myMQTTclient.setCallback(pToCallback);
    38  connectToMQTT(); // connecting to MQTT-Broker
    39 }
    40 
    41 bool myMQTT::subscribe(const String topic) { // subscribes to a new MQTT topic
    42  DBFUNCCALLln("myMQTT::subscribe(const String topic) ");
    43  connectToMQTT();
    44  if (myMQTTclient.connected()) {
    45  DBINFO3("Subscribing to: " + topic);
    46  DBINFO3ln(" Client ID: " + pHostname);
    47  if (myMQTTclient.subscribe(topic.c_str())) {
    48  DBINFO1ln("suscription succesful");
    49  return true;
    50  } else {
    51  DBINFO1ln("suscription failed");
    52  return false;
    53  }
    54  }
    55  return false;
    56 }
    57 
    58 bool myMQTT::unsubscribe(const String topic) {
    59  DBFUNCCALLln("myMQTT::unsubscribe(const String topic)");
    60  connectToMQTT();
    61  if (myMQTTclient.connected()) {
    62  DBINFO3("Unsubscribe from " + topic);
    63  DBINFO3ln(" Client ID: " + pHostname);
    64  if (myMQTTclient.unsubscribe(topic.c_str())) {
    65  DBINFO3ln("unsubscribed successfully");
    66  return true;
    67  } else {
    68  DBWARNINGln("unsubscribe failed");
    69  return false;
    70  }
    71  }
    72  return false;
    73 }
    74 
    75 bool myMQTT::publishMessage(const String topic, const String msg) { // publishes a message to the server
    76  DBFUNCCALLln("myMQTT::publishMessage(const String topic, const String msg)");
    77  // DBINFO3ln("try to publish to[" + topic + "] message: " + msg);
    78  connectToMQTT();
    79  if (myMQTTclient.connected()) {
    80  if (myMQTTclient.publish(topic.c_str(), msg.c_str())) {
    81  DBINFO3ln("Publish to topic [" + topic + "] message:" + msg);
    82  return true;
    83  } else {
    84  DBWARNINGln("Publish failed");
    85  return false;
    86  }
    87  }
    88  return false;
    89 }
    90 
    91 //=====PRIVATE====================================================================================
    92 
    93 void myMQTT::connectToMQTT() {
    94  DBFUNCCALLln("myMQTT::connectToMQTT()");
    95  /*
    96  * loop() should be called regularly to allow
    97  * the client to process incoming messages and
    98  * maintain its connection to the server.
    99  * https://pubsubclient.knolleary.net/api.html#loop
    100  */
    101  myMQTTclient.loop();
    102  while (!myMQTTclient.connected()) {
    103  DBSTATUSln("Status: " + decodeMQTTstate(myMQTTclient.state()));
    104  DBINFO3ln("Attempting MQTT connection...");
    105  DBINFO3ln("MQTT Client ID: " + pHostname);
    106  if (myMQTTclient.connect(pHostname.c_str())) {
    107  DBINFO3ln("MQTT has successfully connected with hostname: " + pHostname);
    108  } else {
    109  MQTTConnectionFailed();
    110  DBINFO3ln("trying again in 3 seconds");
    111  delay(3000);
    112  }
    113  }
    114 }
    115 
    116 void myMQTT::MQTTConnectionFailed() {
    117  DBFUNCCALLln("NetworkManager::MQTTConnectionFailed()");
    118  DBERROR("MQTT connection failed: " + decodeMQTTstate(myMQTTclient.state()));
    119  DBINFO3ln("client status: " + decodeMQTTstate(myMQTTclient.state()));
    120 }
    121 
    122 String myMQTT::decodeMQTTstate(int errorcode) {
    123  DBFUNCCALLln("myMQTT::decodeMQTTstate(int errorcode)");
    124  switch (errorcode) {
    125  case -4:
    126  return "MQTT_CONNECTION_TIMEOUT";
    127  case -3:
    128  return "MQTT_CONNECTION_LOST";
    129  case -2:
    130  return "MQTT_CONNECT_FAILED";
    131  case -1:
    132  return "MQTT_DISCONNECTED";
    133  case 0:
    134  return "MQTT_CONNECTED";
    135  case 1:
    136  return "MQTT_CONNECT_BAD_PROTOCOL";
    137  case 2:
    138  return "MQTT_CONNECT_BAD_CLIENT_ID";
    139  case 3:
    140  return "MQTT_CONNECT_UNAVAILABLE";
    141  case 4:
    142  return "MQTT_CONNECT_BAD_CREDENTIALS";
    143  case 5:
    144  return "MQTT_CONNECT_UNAUTHORIZED";
    145  default:
    146  return "Error";
    147  }
    148 }
    myMQTT::pBrokerPort
    const int pBrokerPort
    port to connect to MQTT
    Definition: myMQTT.h:131
    +
    myMQTT::MQTTConnectionFailed
    void MQTTConnectionFailed()
    Writes Error-Message about MQTT connection.
    Definition: myMQTT.cpp:116
    +
    myMQTT::connectToMQTT
    void connectToMQTT()
    Connects to the MQTT-server.
    Definition: myMQTT.cpp:93
    +
    myMQTT::myMQTT
    myMQTT(String hostname, const int BrokerIP1, const int BrokerIP2, const int BrokerIP3, const int BrokerIP4, const int BrokerPort)
    Construct a new my M Q T T object.
    Definition: myMQTT.cpp:19
    +
    myMQTT::pBrokerIP
    IPAddress pBrokerIP
    the IP-address of the server/broker
    Definition: myMQTT.h:130
    +
    myMQTT.h
    This class handels the MQTT connection.
    +
    myMQTT::decodeMQTTstate
    String decodeMQTTstate(int errorcode)
    Decodes the Error Values from MQTT state() and returns a description.
    Definition: myMQTT.cpp:122
    +
    myMQTT::init
    void init(WiFiClient *myClient, void(*pToCallback)(char *, unsigned char *, unsigned int))
    Definition: myMQTT.cpp:33
    +
    myMQTT::unsubscribe
    bool unsubscribe(const String topic)
    unsubsribes from MQTT topic on Server
    Definition: myMQTT.cpp:58
    +
    myMQTT::subscribe
    bool subscribe(const String topic)
    subsribes to MQTT topic on Server
    Definition: myMQTT.cpp:41
    +
    myMQTT::myMQTTclient
    PubSubClient myMQTTclient
    instance of PubSubClient
    Definition: myMQTT.h:132
    +
    myMQTT::pHostname
    String pHostname
    Contains Hostname/Client ID.
    Definition: myMQTT.h:129
    +
    myMQTT::publishMessage
    bool publishMessage(const String topic, const String msg)
    handles outgoing MQTT messages to Server
    Definition: myMQTT.cpp:75
    +
    +
    + + + + diff --git a/sw-modules/module-package-reader/docs/my_m_q_t_t_8h.html b/sw-modules/module-package-reader/docs/my_m_q_t_t_8h.html new file mode 100644 index 0000000..cbbd30c --- /dev/null +++ b/sw-modules/module-package-reader/docs/my_m_q_t_t_8h.html @@ -0,0 +1,157 @@ + + + + + + + +MQTT Communication: myMQTT.h File Reference + + + + + + + + + + + + + + +
    +
    + + + + + + +
    +
    MQTT Communication +
    +
    Smart Factory
    +
    +
    + + + + + + + +
    +
    + +
    +
    +
    + +
    + +
    +
    + + +
    + +
    + +
    +
    +Classes
    +
    +
    myMQTT.h File Reference
    +
    +
    + +

    This class handels the MQTT connection. +More...

    +
    #include "Arduino.h"
    +#include "LogConfiguration.h"
    +#include "Network/Network.h"
    +#include <PubSubClient.h>
    +
    +Include dependency graph for myMQTT.h:
    +
    +
    + + + + + + + + + +
    +
    +This graph shows which files directly or indirectly include this file:
    +
    +
    + + + + + + +
    +
    +

    Go to the source code of this file.

    + + + + + +

    +Classes

    class  myMQTT
     Handels the MQTT connection. More...
     
    +

    Detailed Description

    +

    This class handels the MQTT connection.

    +
    Author
    Luca Mazzoleni (luca..nosp@m.mazz.nosp@m.oleni.nosp@m.@hsr.nosp@m..ch)
    +
    Version
    1.0 - added MQTT-Connection - Luca Mazzoleni (luca..nosp@m.mazz.nosp@m.oleni.nosp@m.@hsr.nosp@m..ch) - 2019-04-16
    +
    Date
    2019-04-16
    +
    Copyright
    Copyright (c) 2019
    +
    Todo:
    Add a function "unsubscirbeAll" which unsubscribes from all subscirbed topics. Hence you need to track all your subscribed topcis in an array.
    + +

    Definition in file myMQTT.h.

    +
    +
    + + + + diff --git a/sw-modules/module-package-reader/docs/my_m_q_t_t_8h__dep__incl.map b/sw-modules/module-package-reader/docs/my_m_q_t_t_8h__dep__incl.map new file mode 100644 index 0000000..c03611e --- /dev/null +++ b/sw-modules/module-package-reader/docs/my_m_q_t_t_8h__dep__incl.map @@ -0,0 +1,6 @@ + + + + + + diff --git a/sw-modules/module-package-reader/docs/my_m_q_t_t_8h__dep__incl.md5 b/sw-modules/module-package-reader/docs/my_m_q_t_t_8h__dep__incl.md5 new file mode 100644 index 0000000..e10143e --- /dev/null +++ b/sw-modules/module-package-reader/docs/my_m_q_t_t_8h__dep__incl.md5 @@ -0,0 +1 @@ +d39f1d3e1aa2ca7b8b04ed34ef6a9264 \ No newline at end of file diff --git a/sw-modules/module-package-reader/docs/my_m_q_t_t_8h__dep__incl.png b/sw-modules/module-package-reader/docs/my_m_q_t_t_8h__dep__incl.png new file mode 100644 index 0000000..870cd71 Binary files /dev/null and b/sw-modules/module-package-reader/docs/my_m_q_t_t_8h__dep__incl.png differ diff --git a/sw-modules/module-package-reader/docs/my_m_q_t_t_8h__incl.map b/sw-modules/module-package-reader/docs/my_m_q_t_t_8h__incl.map new file mode 100644 index 0000000..e963abc --- /dev/null +++ b/sw-modules/module-package-reader/docs/my_m_q_t_t_8h__incl.map @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/sw-modules/module-package-reader/docs/my_m_q_t_t_8h__incl.md5 b/sw-modules/module-package-reader/docs/my_m_q_t_t_8h__incl.md5 new file mode 100644 index 0000000..318b08c --- /dev/null +++ b/sw-modules/module-package-reader/docs/my_m_q_t_t_8h__incl.md5 @@ -0,0 +1 @@ +cf2bbaa7ea4c28803187fe4ed2c25dfd \ No newline at end of file diff --git a/sw-modules/module-package-reader/docs/my_m_q_t_t_8h__incl.png b/sw-modules/module-package-reader/docs/my_m_q_t_t_8h__incl.png new file mode 100644 index 0000000..aecf18c Binary files /dev/null and b/sw-modules/module-package-reader/docs/my_m_q_t_t_8h__incl.png differ diff --git a/sw-modules/module-package-reader/docs/my_m_q_t_t_8h_source.html b/sw-modules/module-package-reader/docs/my_m_q_t_t_8h_source.html new file mode 100644 index 0000000..28f65fd --- /dev/null +++ b/sw-modules/module-package-reader/docs/my_m_q_t_t_8h_source.html @@ -0,0 +1,120 @@ + + + + + + + +MQTT Communication: myMQTT.h Source File + + + + + + + + + + + + + + +
    +
    + + + + + + +
    +
    MQTT Communication +
    +
    Smart Factory
    +
    +
    + + + + + + + +
    +
    + +
    +
    +
    + +
    + +
    +
    + + +
    + +
    + +
    +
    +
    myMQTT.h
    +
    +
    +Go to the documentation of this file.
    1 
    16 #ifndef MYMQTT_H__
    17 #define MYMQTT_H__
    18 
    19 #include "Arduino.h"
    20 
    21 #include "LogConfiguration.h"
    22 
    23 #include "Network/Network.h"
    24 // #include <WiFi101.h>
    25 #include <PubSubClient.h>
    26 
    32 class myMQTT {
    33  //=====PUBLIC====================================================================================
    34  public:
    45  myMQTT(String hostname, const int BrokerIP1, const int BrokerIP2, const int BrokerIP3, const int BrokerIP4, const int BrokerPort);
    46 
    53  void init(WiFiClient *myClient, void (*pToCallback)(char *, unsigned char *, unsigned int));
    54 
    65  bool subscribe(const String topic);
    66 
    76  bool unsubscribe(const String topic);
    77 
    91  bool publishMessage(const String topic, const String msg);
    92 
    101  inline bool loop() {
    102  return myMQTTclient.loop();
    103  };
    104 
    105  //=====PRIVATE====================================================================================
    106  private:
    113  void connectToMQTT();
    114 
    121  String decodeMQTTstate(int errorcode);
    122 
    127  void MQTTConnectionFailed();
    128 
    129  String pHostname;
    130  IPAddress pBrokerIP;
    131  const int pBrokerPort;
    132  PubSubClient myMQTTclient;
    133 };
    134 #endif
    myMQTT::pBrokerPort
    const int pBrokerPort
    port to connect to MQTT
    Definition: myMQTT.h:131
    +
    Network.h
    The Network class establishes a WLAN-Connection.
    +
    myMQTT::loop
    bool loop()
    This should be called regularly to allow the client to process incoming messages and maintain its con...
    Definition: myMQTT.h:101
    +
    myMQTT::MQTTConnectionFailed
    void MQTTConnectionFailed()
    Writes Error-Message about MQTT connection.
    Definition: myMQTT.cpp:116
    +
    myMQTT::connectToMQTT
    void connectToMQTT()
    Connects to the MQTT-server.
    Definition: myMQTT.cpp:93
    +
    myMQTT
    Handels the MQTT connection.
    Definition: myMQTT.h:32
    +
    myMQTT::myMQTT
    myMQTT(String hostname, const int BrokerIP1, const int BrokerIP2, const int BrokerIP3, const int BrokerIP4, const int BrokerPort)
    Construct a new my M Q T T object.
    Definition: myMQTT.cpp:19
    +
    myMQTT::pBrokerIP
    IPAddress pBrokerIP
    the IP-address of the server/broker
    Definition: myMQTT.h:130
    +
    myMQTT::decodeMQTTstate
    String decodeMQTTstate(int errorcode)
    Decodes the Error Values from MQTT state() and returns a description.
    Definition: myMQTT.cpp:122
    +
    myMQTT::init
    void init(WiFiClient *myClient, void(*pToCallback)(char *, unsigned char *, unsigned int))
    Definition: myMQTT.cpp:33
    +
    myMQTT::unsubscribe
    bool unsubscribe(const String topic)
    unsubsribes from MQTT topic on Server
    Definition: myMQTT.cpp:58
    +
    myMQTT::subscribe
    bool subscribe(const String topic)
    subsribes to MQTT topic on Server
    Definition: myMQTT.cpp:41
    +
    myMQTT::myMQTTclient
    PubSubClient myMQTTclient
    instance of PubSubClient
    Definition: myMQTT.h:132
    +
    myMQTT::pHostname
    String pHostname
    Contains Hostname/Client ID.
    Definition: myMQTT.h:129
    +
    myMQTT::publishMessage
    bool publishMessage(const String topic, const String msg)
    handles outgoing MQTT messages to Server
    Definition: myMQTT.cpp:75
    +
    +
    + + + + diff --git a/sw-modules/module-package-reader/docs/nav_f.png b/sw-modules/module-package-reader/docs/nav_f.png new file mode 100644 index 0000000..72a58a5 Binary files /dev/null and b/sw-modules/module-package-reader/docs/nav_f.png differ diff --git a/sw-modules/module-package-reader/docs/nav_g.png b/sw-modules/module-package-reader/docs/nav_g.png new file mode 100644 index 0000000..2093a23 Binary files /dev/null and b/sw-modules/module-package-reader/docs/nav_g.png differ diff --git a/sw-modules/module-package-reader/docs/nav_h.png b/sw-modules/module-package-reader/docs/nav_h.png new file mode 100644 index 0000000..33389b1 Binary files /dev/null and b/sw-modules/module-package-reader/docs/nav_h.png differ diff --git a/sw-modules/module-package-reader/docs/navtree.css b/sw-modules/module-package-reader/docs/navtree.css new file mode 100644 index 0000000..33341a6 --- /dev/null +++ b/sw-modules/module-package-reader/docs/navtree.css @@ -0,0 +1,146 @@ +#nav-tree .children_ul { + margin:0; + padding:4px; +} + +#nav-tree ul { + list-style:none outside none; + margin:0px; + padding:0px; +} + +#nav-tree li { + white-space:nowrap; + margin:0px; + padding:0px; +} + +#nav-tree .plus { + margin:0px; +} + +#nav-tree .selected { + background-image: url('tab_a.png'); + background-repeat:repeat-x; + color: #fff; + text-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0); +} + +#nav-tree img { + margin:0px; + padding:0px; + border:0px; + vertical-align: middle; +} + +#nav-tree a { + text-decoration:none; + padding:0px; + margin:0px; + outline:none; +} + +#nav-tree .label { + margin:0px; + padding:0px; + font: 12px 'Lucida Grande',Geneva,Helvetica,Arial,sans-serif; +} + +#nav-tree .label a { + padding:2px; +} + +#nav-tree .selected a { + text-decoration:none; + color:#fff; +} + +#nav-tree .children_ul { + margin:0px; + padding:0px; +} + +#nav-tree .item { + margin:0px; + padding:0px; +} + +#nav-tree { + padding: 0px 0px; + background-color: #FAFAFF; + font-size:14px; + overflow:auto; +} + +#doc-content { + overflow:auto; + display:block; + padding:0px; + margin:0px; + -webkit-overflow-scrolling : touch; /* iOS 5+ */ +} + +#side-nav { + padding:0 6px 0 0; + margin: 0px; + display:block; + position: absolute; + left: 0px; + width: 250px; +} + +.ui-resizable .ui-resizable-handle { + display:block; +} + +.ui-resizable-e { + background-image:url("splitbar.png"); + background-size:100%; + background-repeat:repeat-y; + background-attachment: scroll; + cursor:ew-resize; + height:100%; + right:0; + top:0; + width:6px; +} + +.ui-resizable-handle { + display:none; + font-size:0.1px; + position:absolute; + z-index:1; +} + +#nav-tree-contents { + margin: 6px 0px 0px 0px; +} + +#nav-tree { + background-image:url('nav_h.png'); + background-repeat:repeat-x; + background-color: #F9FAFC; + -webkit-overflow-scrolling : touch; /* iOS 5+ */ +} + +#nav-sync { + position:absolute; + top:5px; + right:24px; + z-index:0; +} + +#nav-sync img { + opacity:0.3; +} + +#nav-sync img:hover { + opacity:0.9; +} + +@media print +{ + #nav-tree { display: none; } + div.ui-resizable-handle { display: none; position: relative; } +} + diff --git a/sw-modules/module-package-reader/docs/navtree.js b/sw-modules/module-package-reader/docs/navtree.js new file mode 100644 index 0000000..7ce2935 --- /dev/null +++ b/sw-modules/module-package-reader/docs/navtree.js @@ -0,0 +1,540 @@ +/* + @licstart The following is the entire license notice for the + JavaScript code in this file. + + Copyright (C) 1997-2017 by Dimitri van Heesch + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + + @licend The above is the entire license notice + for the JavaScript code in this file + */ +var navTreeSubIndices = new Array(); +var arrowDown = '▼'; +var arrowRight = '►'; + +function getData(varName) +{ + var i = varName.lastIndexOf('/'); + var n = i>=0 ? varName.substring(i+1) : varName; + return eval(n.replace(/\-/g,'_')); +} + +function stripPath(uri) +{ + return uri.substring(uri.lastIndexOf('/')+1); +} + +function stripPath2(uri) +{ + var i = uri.lastIndexOf('/'); + var s = uri.substring(i+1); + var m = uri.substring(0,i+1).match(/\/d\w\/d\w\w\/$/); + return m ? uri.substring(i-6) : s; +} + +function hashValue() +{ + return $(location).attr('hash').substring(1).replace(/[^\w\-]/g,''); +} + +function hashUrl() +{ + return '#'+hashValue(); +} + +function pathName() +{ + return $(location).attr('pathname').replace(/[^-A-Za-z0-9+&@#/%?=~_|!:,.;\(\)]/g, ''); +} + +function localStorageSupported() +{ + try { + return 'localStorage' in window && window['localStorage'] !== null && window.localStorage.getItem; + } + catch(e) { + return false; + } +} + + +function storeLink(link) +{ + if (!$("#nav-sync").hasClass('sync') && localStorageSupported()) { + window.localStorage.setItem('navpath',link); + } +} + +function deleteLink() +{ + if (localStorageSupported()) { + window.localStorage.setItem('navpath',''); + } +} + +function cachedLink() +{ + if (localStorageSupported()) { + return window.localStorage.getItem('navpath'); + } else { + return ''; + } +} + +function getScript(scriptName,func,show) +{ + var head = document.getElementsByTagName("head")[0]; + var script = document.createElement('script'); + script.id = scriptName; + script.type = 'text/javascript'; + script.onload = func; + script.src = scriptName+'.js'; + if ($.browser.msie && $.browser.version<=8) { + // script.onload does not work with older versions of IE + script.onreadystatechange = function() { + if (script.readyState=='complete' || script.readyState=='loaded') { + func(); if (show) showRoot(); + } + } + } + head.appendChild(script); +} + +function createIndent(o,domNode,node,level) +{ + var level=-1; + var n = node; + while (n.parentNode) { level++; n=n.parentNode; } + if (node.childrenData) { + var imgNode = document.createElement("span"); + imgNode.className = 'arrow'; + imgNode.style.paddingLeft=(16*level).toString()+'px'; + imgNode.innerHTML=arrowRight; + node.plus_img = imgNode; + node.expandToggle = document.createElement("a"); + node.expandToggle.href = "javascript:void(0)"; + node.expandToggle.onclick = function() { + if (node.expanded) { + $(node.getChildrenUL()).slideUp("fast"); + node.plus_img.innerHTML=arrowRight; + node.expanded = false; + } else { + expandNode(o, node, false, false); + } + } + node.expandToggle.appendChild(imgNode); + domNode.appendChild(node.expandToggle); + } else { + var span = document.createElement("span"); + span.className = 'arrow'; + span.style.width = 16*(level+1)+'px'; + span.innerHTML = ' '; + domNode.appendChild(span); + } +} + +var animationInProgress = false; + +function gotoAnchor(anchor,aname,updateLocation) +{ + var pos, docContent = $('#doc-content'); + var ancParent = $(anchor.parent()); + if (ancParent.hasClass('memItemLeft') || + ancParent.hasClass('fieldname') || + ancParent.hasClass('fieldtype') || + ancParent.is(':header')) + { + pos = ancParent.position().top; + } else if (anchor.position()) { + pos = anchor.position().top; + } + if (pos) { + var dist = Math.abs(Math.min( + pos-docContent.offset().top, + docContent[0].scrollHeight- + docContent.height()-docContent.scrollTop())); + animationInProgress=true; + docContent.animate({ + scrollTop: pos + docContent.scrollTop() - docContent.offset().top + },Math.max(50,Math.min(500,dist)),function(){ + if (updateLocation) window.location.href=aname; + animationInProgress=false; + }); + } +} + +function newNode(o, po, text, link, childrenData, lastNode) +{ + var node = new Object(); + node.children = Array(); + node.childrenData = childrenData; + node.depth = po.depth + 1; + node.relpath = po.relpath; + node.isLast = lastNode; + + node.li = document.createElement("li"); + po.getChildrenUL().appendChild(node.li); + node.parentNode = po; + + node.itemDiv = document.createElement("div"); + node.itemDiv.className = "item"; + + node.labelSpan = document.createElement("span"); + node.labelSpan.className = "label"; + + createIndent(o,node.itemDiv,node,0); + node.itemDiv.appendChild(node.labelSpan); + node.li.appendChild(node.itemDiv); + + var a = document.createElement("a"); + node.labelSpan.appendChild(a); + node.label = document.createTextNode(text); + node.expanded = false; + a.appendChild(node.label); + if (link) { + var url; + if (link.substring(0,1)=='^') { + url = link.substring(1); + link = url; + } else { + url = node.relpath+link; + } + a.className = stripPath(link.replace('#',':')); + if (link.indexOf('#')!=-1) { + var aname = '#'+link.split('#')[1]; + var srcPage = stripPath(pathName()); + var targetPage = stripPath(link.split('#')[0]); + a.href = srcPage!=targetPage ? url : "javascript:void(0)"; + a.onclick = function(){ + storeLink(link); + if (!$(a).parent().parent().hasClass('selected')) + { + $('.item').removeClass('selected'); + $('.item').removeAttr('id'); + $(a).parent().parent().addClass('selected'); + $(a).parent().parent().attr('id','selected'); + } + var anchor = $(aname); + gotoAnchor(anchor,aname,true); + }; + } else { + a.href = url; + a.onclick = function() { storeLink(link); } + } + } else { + if (childrenData != null) + { + a.className = "nolink"; + a.href = "javascript:void(0)"; + a.onclick = node.expandToggle.onclick; + } + } + + node.childrenUL = null; + node.getChildrenUL = function() { + if (!node.childrenUL) { + node.childrenUL = document.createElement("ul"); + node.childrenUL.className = "children_ul"; + node.childrenUL.style.display = "none"; + node.li.appendChild(node.childrenUL); + } + return node.childrenUL; + }; + + return node; +} + +function showRoot() +{ + var headerHeight = $("#top").height(); + var footerHeight = $("#nav-path").height(); + var windowHeight = $(window).height() - headerHeight - footerHeight; + (function (){ // retry until we can scroll to the selected item + try { + var navtree=$('#nav-tree'); + navtree.scrollTo('#selected',0,{offset:-windowHeight/2}); + } catch (err) { + setTimeout(arguments.callee, 0); + } + })(); +} + +function expandNode(o, node, imm, showRoot) +{ + if (node.childrenData && !node.expanded) { + if (typeof(node.childrenData)==='string') { + var varName = node.childrenData; + getScript(node.relpath+varName,function(){ + node.childrenData = getData(varName); + expandNode(o, node, imm, showRoot); + }, showRoot); + } else { + if (!node.childrenVisited) { + getNode(o, node); + } if (imm || ($.browser.msie && $.browser.version>8)) { + // somehow slideDown jumps to the start of tree for IE9 :-( + $(node.getChildrenUL()).show(); + } else { + $(node.getChildrenUL()).slideDown("fast"); + } + node.plus_img.innerHTML = arrowDown; + node.expanded = true; + } + } +} + +function glowEffect(n,duration) +{ + n.addClass('glow').delay(duration).queue(function(next){ + $(this).removeClass('glow');next(); + }); +} + +function highlightAnchor() +{ + var aname = hashUrl(); + var anchor = $(aname); + if (anchor.parent().attr('class')=='memItemLeft'){ + var rows = $('.memberdecls tr[class$="'+hashValue()+'"]'); + glowEffect(rows.children(),300); // member without details + } else if (anchor.parent().attr('class')=='fieldname'){ + glowEffect(anchor.parent().parent(),1000); // enum value + } else if (anchor.parent().attr('class')=='fieldtype'){ + glowEffect(anchor.parent().parent(),1000); // struct field + } else if (anchor.parent().is(":header")) { + glowEffect(anchor.parent(),1000); // section header + } else { + glowEffect(anchor.next(),1000); // normal member + } + gotoAnchor(anchor,aname,false); +} + +function selectAndHighlight(hash,n) +{ + var a; + if (hash) { + var link=stripPath(pathName())+':'+hash.substring(1); + a=$('.item a[class$="'+link+'"]'); + } + if (a && a.length) { + a.parent().parent().addClass('selected'); + a.parent().parent().attr('id','selected'); + highlightAnchor(); + } else if (n) { + $(n.itemDiv).addClass('selected'); + $(n.itemDiv).attr('id','selected'); + } + if ($('#nav-tree-contents .item:first').hasClass('selected')) { + $('#nav-sync').css('top','30px'); + } else { + $('#nav-sync').css('top','5px'); + } + showRoot(); +} + +function showNode(o, node, index, hash) +{ + if (node && node.childrenData) { + if (typeof(node.childrenData)==='string') { + var varName = node.childrenData; + getScript(node.relpath+varName,function(){ + node.childrenData = getData(varName); + showNode(o,node,index,hash); + },true); + } else { + if (!node.childrenVisited) { + getNode(o, node); + } + $(node.getChildrenUL()).css({'display':'block'}); + node.plus_img.innerHTML = arrowDown; + node.expanded = true; + var n = node.children[o.breadcrumbs[index]]; + if (index+11) hash = '#'+parts[1].replace(/[^\w\-]/g,''); + else hash=''; + } + if (hash.match(/^#l\d+$/)) { + var anchor=$('a[name='+hash.substring(1)+']'); + glowEffect(anchor.parent(),1000); // line number + hash=''; // strip line number anchors + } + var url=root+hash; + var i=-1; + while (NAVTREEINDEX[i+1]<=url) i++; + if (i==-1) { i=0; root=NAVTREE[0][1]; } // fallback: show index + if (navTreeSubIndices[i]) { + gotoNode(o,i,root,hash,relpath) + } else { + getScript(relpath+'navtreeindex'+i,function(){ + navTreeSubIndices[i] = eval('NAVTREEINDEX'+i); + if (navTreeSubIndices[i]) { + gotoNode(o,i,root,hash,relpath); + } + },true); + } +} + +function showSyncOff(n,relpath) +{ + n.html(''); +} + +function showSyncOn(n,relpath) +{ + n.html(''); +} + +function toggleSyncButton(relpath) +{ + var navSync = $('#nav-sync'); + if (navSync.hasClass('sync')) { + navSync.removeClass('sync'); + showSyncOff(navSync,relpath); + storeLink(stripPath2(pathName())+hashUrl()); + } else { + navSync.addClass('sync'); + showSyncOn(navSync,relpath); + deleteLink(); + } +} + +function initNavTree(toroot,relpath) +{ + var o = new Object(); + o.toroot = toroot; + o.node = new Object(); + o.node.li = document.getElementById("nav-tree-contents"); + o.node.childrenData = NAVTREE; + o.node.children = new Array(); + o.node.childrenUL = document.createElement("ul"); + o.node.getChildrenUL = function() { return o.node.childrenUL; }; + o.node.li.appendChild(o.node.childrenUL); + o.node.depth = 0; + o.node.relpath = relpath; + o.node.expanded = false; + o.node.isLast = true; + o.node.plus_img = document.createElement("span"); + o.node.plus_img.className = 'arrow'; + o.node.plus_img.innerHTML = arrowRight; + + if (localStorageSupported()) { + var navSync = $('#nav-sync'); + if (cachedLink()) { + showSyncOff(navSync,relpath); + navSync.removeClass('sync'); + } else { + showSyncOn(navSync,relpath); + } + navSync.click(function(){ toggleSyncButton(relpath); }); + } + + $(window).load(function(){ + navTo(o,toroot,hashUrl(),relpath); + showRoot(); + }); + + $(window).bind('hashchange', function(){ + if (window.location.hash && window.location.hash.length>1){ + var a; + if ($(location).attr('hash')){ + var clslink=stripPath(pathName())+':'+hashValue(); + a=$('.item a[class$="'+clslink.replace(/ + + + + + + +MQTT Communication: Related Pages + + + + + + + + + + + + + + +
    +
    + + + + + + +
    +
    MQTT Communication +
    +
    Smart Factory
    +
    +
    + + + + + + + +
    +
    + +
    +
    +
    + +
    + +
    +
    + + +
    + +
    + +
    +
    +
    Related Pages
    +
    +
    +
    Here is a list of all related documentation pages:
    + + + +
     SmartFactory_MQTTCommunication
     Todo List
    +
    +
    +
    + + + + diff --git a/sw-modules/module-package-reader/docs/resize.js b/sw-modules/module-package-reader/docs/resize.js new file mode 100644 index 0000000..6617aee --- /dev/null +++ b/sw-modules/module-package-reader/docs/resize.js @@ -0,0 +1,136 @@ +/* + @licstart The following is the entire license notice for the + JavaScript code in this file. + + Copyright (C) 1997-2017 by Dimitri van Heesch + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + + @licend The above is the entire license notice + for the JavaScript code in this file + */ +function initResizable() +{ + var cookie_namespace = 'doxygen'; + var sidenav,navtree,content,header,collapsed,collapsedWidth=0,barWidth=6,desktop_vp=768,titleHeight; + + function readCookie(cookie) + { + var myCookie = cookie_namespace+"_"+cookie+"="; + if (document.cookie) { + var index = document.cookie.indexOf(myCookie); + if (index != -1) { + var valStart = index + myCookie.length; + var valEnd = document.cookie.indexOf(";", valStart); + if (valEnd == -1) { + valEnd = document.cookie.length; + } + var val = document.cookie.substring(valStart, valEnd); + return val; + } + } + return 0; + } + + function writeCookie(cookie, val, expiration) + { + if (val==undefined) return; + if (expiration == null) { + var date = new Date(); + date.setTime(date.getTime()+(10*365*24*60*60*1000)); // default expiration is one week + expiration = date.toGMTString(); + } + document.cookie = cookie_namespace + "_" + cookie + "=" + val + "; expires=" + expiration+"; path=/"; + } + + function resizeWidth() + { + var windowWidth = $(window).width() + "px"; + var sidenavWidth = $(sidenav).outerWidth(); + content.css({marginLeft:parseInt(sidenavWidth)+"px"}); + writeCookie('width',sidenavWidth-barWidth, null); + } + + function restoreWidth(navWidth) + { + var windowWidth = $(window).width() + "px"; + content.css({marginLeft:parseInt(navWidth)+barWidth+"px"}); + sidenav.css({width:navWidth + "px"}); + } + + function resizeHeight() + { + var headerHeight = header.outerHeight(); + var footerHeight = footer.outerHeight(); + var windowHeight = $(window).height() - headerHeight - footerHeight; + content.css({height:windowHeight + "px"}); + navtree.css({height:windowHeight + "px"}); + sidenav.css({height:windowHeight + "px"}); + var width=$(window).width(); + if (width!=collapsedWidth) { + if (width=desktop_vp) { + if (!collapsed) { + collapseExpand(); + } + } else if (width>desktop_vp && collapsedWidth0) { + restoreWidth(0); + collapsed=true; + } + else { + var width = readCookie('width'); + if (width>200 && width<$(window).width()) { restoreWidth(width); } else { restoreWidth(200); } + collapsed=false; + } + } + + header = $("#top"); + sidenav = $("#side-nav"); + content = $("#doc-content"); + navtree = $("#nav-tree"); + footer = $("#nav-path"); + $(".side-nav-resizable").resizable({resize: function(e, ui) { resizeWidth(); } }); + $(sidenav).resizable({ minWidth: 0 }); + $(window).resize(function() { resizeHeight(); }); + var device = navigator.userAgent.toLowerCase(); + var touch_device = device.match(/(iphone|ipod|ipad|android)/); + if (touch_device) { /* wider split bar for touch only devices */ + $(sidenav).css({ paddingRight:'20px' }); + $('.ui-resizable-e').css({ width:'20px' }); + $('#nav-sync').css({ right:'34px' }); + barWidth=20; + } + var width = readCookie('width'); + if (width) { restoreWidth(width); } else { resizeWidth(); } + resizeHeight(); + var url = location.href; + var i=url.indexOf("#"); + if (i>=0) window.location.hash=url.substr(i); + var _preventDefault = function(evt) { evt.preventDefault(); }; + $("#splitbar").bind("dragstart", _preventDefault).bind("selectstart", _preventDefault); + $(".ui-resizable-handle").dblclick(collapseExpand); + $(window).load(resizeHeight); +} +/* @license-end */ diff --git a/sw-modules/module-package-reader/docs/search/all_0.html b/sw-modules/module-package-reader/docs/search/all_0.html new file mode 100644 index 0000000..5330204 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/all_0.html @@ -0,0 +1,30 @@ + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/sw-modules/module-package-reader/docs/search/all_0.js b/sw-modules/module-package-reader/docs/search/all_0.js new file mode 100644 index 0000000..dfb4c75 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/all_0.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['_5fbuffer',['_buffer',['../_m_q_t_t_communication_8cpp.html#ac88e2994c014e5e95aa2497a7501ea6a',1,'_buffer(): MQTTCommunication.cpp'],['../_m_q_t_t_communication_8h.html#ac88e2994c014e5e95aa2497a7501ea6a',1,'_buffer(): MQTTCommunication.cpp']]], + ['_5fmyjson',['_myjson',['../_m_q_t_t_communication_8cpp.html#a4283a95f69f867cc1506b5c3ef038644',1,'_myjson(): MQTTCommunication.cpp'],['../_m_q_t_t_communication_8h.html#a7b53ade1cc8486457ead86c3c41a0c7e',1,'_myjson(): MQTTCommunication.h']]] +]; diff --git a/sw-modules/module-package-reader/docs/search/all_1.html b/sw-modules/module-package-reader/docs/search/all_1.html new file mode 100644 index 0000000..2f46793 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/all_1.html @@ -0,0 +1,30 @@ + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/sw-modules/module-package-reader/docs/search/all_1.js b/sw-modules/module-package-reader/docs/search/all_1.js new file mode 100644 index 0000000..f7a8f62 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/all_1.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['ack',['ack',['../structmy_j_s_o_n_str.html#a35f72407798562c604aa8ce4517979db',1,'myJSONStr']]] +]; diff --git a/sw-modules/module-package-reader/docs/search/all_10.html b/sw-modules/module-package-reader/docs/search/all_10.html new file mode 100644 index 0000000..170dc09 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/all_10.html @@ -0,0 +1,30 @@ + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/sw-modules/module-package-reader/docs/search/all_10.js b/sw-modules/module-package-reader/docs/search/all_10.js new file mode 100644 index 0000000..f45235a --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/all_10.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['unsubscribe',['unsubscribe',['../class_communication.html#a6be65dea68cf039e41df2986386dac61',1,'Communication::unsubscribe()'],['../classmy_m_q_t_t.html#a215cee06699f991dd068e92e302563a5',1,'myMQTT::unsubscribe()']]] +]; diff --git a/sw-modules/module-package-reader/docs/search/all_2.html b/sw-modules/module-package-reader/docs/search/all_2.html new file mode 100644 index 0000000..4c33d85 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/all_2.html @@ -0,0 +1,30 @@ + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/sw-modules/module-package-reader/docs/search/all_2.js b/sw-modules/module-package-reader/docs/search/all_2.js new file mode 100644 index 0000000..9eb2c6d --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/all_2.js @@ -0,0 +1,10 @@ +var searchData= +[ + ['callback',['callback',['../_m_q_t_t_communication_8cpp.html#ac3a129f66dc859e2b7279565f4e1de78',1,'callback(char *topic, byte *payload, unsigned int length): MQTTCommunication.cpp'],['../_m_q_t_t_communication_8h.html#ac3a129f66dc859e2b7279565f4e1de78',1,'callback(char *topic, byte *payload, unsigned int length): MQTTCommunication.cpp']]], + ['cargo',['cargo',['../structmy_j_s_o_n_str.html#a06a829e44e957ec5e05976a50866138f',1,'myJSONStr']]], + ['clear',['clear',['../class_communication.html#ab1c097a0ede778d6edd57be55fed77d6',1,'Communication']]], + ['communication',['Communication',['../class_communication.html',1,'Communication'],['../class_communication.html#ab88eb4c3af7925175dc96a1781da7437',1,'Communication::Communication()']]], + ['communicationconfiguration_2eh',['CommunicationConfiguration.h',['../_communication_configuration_8h.html',1,'']]], + ['connecttomqtt',['connectToMQTT',['../classmy_m_q_t_t.html#a6d495c08a06513954b95d961f0595959',1,'myMQTT']]], + ['connecttowifi',['connectToWiFi',['../class_network.html#ad7fff536b31740411da0e7c8f281eda9',1,'Network']]] +]; diff --git a/sw-modules/module-package-reader/docs/search/all_3.html b/sw-modules/module-package-reader/docs/search/all_3.html new file mode 100644 index 0000000..b634070 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/all_3.html @@ -0,0 +1,30 @@ + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/sw-modules/module-package-reader/docs/search/all_3.js b/sw-modules/module-package-reader/docs/search/all_3.js new file mode 100644 index 0000000..76c0ae8 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/all_3.js @@ -0,0 +1,17 @@ +var searchData= +[ + ['decodeencryptiontype',['decodeEncryptionType',['../class_network.html#a07eee94a1b113e65c9d1c6b8c6c6ee44',1,'Network']]], + ['decodemqttstate',['decodeMQTTstate',['../classmy_m_q_t_t.html#ae4372969b093a2487479005ccb398cbc',1,'myMQTT']]], + ['decodewifistate',['decodeWiFistate',['../class_network.html#a31ebd477ecb0f08f85b7fa52b9f2bb7a',1,'Network']]], + ['default_5fmqtt_5fbroker_5fip1',['DEFAULT_MQTT_BROKER_IP1',['../_communication_configuration_8h.html#a5d22797e1aecb523d51e001e4b18bfcd',1,'CommunicationConfiguration.h']]], + ['default_5fmqtt_5fbroker_5fip2',['DEFAULT_MQTT_BROKER_IP2',['../_communication_configuration_8h.html#a3d7bfc12d81b39f60b4c466d73b0f9bd',1,'CommunicationConfiguration.h']]], + ['default_5fmqtt_5fbroker_5fip3',['DEFAULT_MQTT_BROKER_IP3',['../_communication_configuration_8h.html#a5bef8a41df9bae6c18ba9a7cbe7334b1',1,'CommunicationConfiguration.h']]], + ['default_5fmqtt_5fbroker_5fip4',['DEFAULT_MQTT_BROKER_IP4',['../_communication_configuration_8h.html#acd98270e14f470dde211dbf10ab236d5',1,'CommunicationConfiguration.h']]], + ['default_5fmqtt_5fport',['DEFAULT_MQTT_PORT',['../_communication_configuration_8h.html#a01342056d524ed0b20f9e0ccc800d1db',1,'CommunicationConfiguration.h']]], + ['default_5fwifi_5fcs',['DEFAULT_WIFI_CS',['../_communication_configuration_8h.html#a3975cc64a3caa3ee968344f9ac96de46',1,'CommunicationConfiguration.h']]], + ['default_5fwifi_5fen',['DEFAULT_WIFI_EN',['../_communication_configuration_8h.html#a2c1b2ad8f5142dd54d142524127844ce',1,'CommunicationConfiguration.h']]], + ['default_5fwifi_5firq',['DEFAULT_WIFI_IRQ',['../_communication_configuration_8h.html#a2d6cfb023346bcee1140b5579e96133e',1,'CommunicationConfiguration.h']]], + ['default_5fwifi_5fpassword',['DEFAULT_WIFI_PASSWORD',['../_communication_configuration_8h.html#a151690ecdd7d2c7b69586e6df164676c',1,'CommunicationConfiguration.h']]], + ['default_5fwifi_5frst',['DEFAULT_WIFI_RST',['../_communication_configuration_8h.html#a8849f0b55abf9c367def4f2e2faad104',1,'CommunicationConfiguration.h']]], + ['default_5fwifi_5fssid',['DEFAULT_WIFI_SSID',['../_communication_configuration_8h.html#a7ea92631acc3bc41ae5eadc069323267',1,'CommunicationConfiguration.h']]] +]; diff --git a/sw-modules/module-package-reader/docs/search/all_4.html b/sw-modules/module-package-reader/docs/search/all_4.html new file mode 100644 index 0000000..dd062ae --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/all_4.html @@ -0,0 +1,30 @@ + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/sw-modules/module-package-reader/docs/search/all_4.js b/sw-modules/module-package-reader/docs/search/all_4.js new file mode 100644 index 0000000..94e4f3e --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/all_4.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['error',['error',['../structmy_j_s_o_n_str.html#a47cc65fe9a93c0436c7c1f977be884db',1,'myJSONStr']]] +]; diff --git a/sw-modules/module-package-reader/docs/search/all_5.html b/sw-modules/module-package-reader/docs/search/all_5.html new file mode 100644 index 0000000..f0780fd --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/all_5.html @@ -0,0 +1,30 @@ + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/sw-modules/module-package-reader/docs/search/all_5.js b/sw-modules/module-package-reader/docs/search/all_5.js new file mode 100644 index 0000000..2d02efe --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/all_5.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['first',['first',['../class_communication.html#ab188e8647d1b8abba12dba6101fe4096',1,'Communication']]], + ['funcpointer',['funcPointer',['../class_communication.html#a0b8c2ab44fad41881b8da21367a02da4',1,'Communication']]] +]; diff --git a/sw-modules/module-package-reader/docs/search/all_6.html b/sw-modules/module-package-reader/docs/search/all_6.html new file mode 100644 index 0000000..39b0f55 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/all_6.html @@ -0,0 +1,30 @@ + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/sw-modules/module-package-reader/docs/search/all_6.js b/sw-modules/module-package-reader/docs/search/all_6.js new file mode 100644 index 0000000..2bbb2c9 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/all_6.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['getelement',['getElement',['../class_communication.html#a39b312c42c6977923b275047a84e81fe',1,'Communication']]] +]; diff --git a/sw-modules/module-package-reader/docs/search/all_7.html b/sw-modules/module-package-reader/docs/search/all_7.html new file mode 100644 index 0000000..9cd0196 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/all_7.html @@ -0,0 +1,30 @@ + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/sw-modules/module-package-reader/docs/search/all_7.js b/sw-modules/module-package-reader/docs/search/all_7.js new file mode 100644 index 0000000..3aea06b --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/all_7.js @@ -0,0 +1,6 @@ +var searchData= +[ + ['id',['id',['../structmy_j_s_o_n_str.html#a78a5f8711dd64c450d7f01d6a5c337fa',1,'myJSONStr']]], + ['init',['init',['../class_communication.html#aa526fb8aa735ea4457dc56d1f0a4fe00',1,'Communication::init()'],['../classmy_m_q_t_t.html#a5f19e4308e3dc2d748291d3ca1cd9228',1,'myMQTT::init()'],['../class_network.html#a92193e6fe7a1dc2c7a42d9c9cfed81ed',1,'Network::init()']]], + ['isempty',['isEmpty',['../class_communication.html#ada2063efe2e5667c4317319c2e91ccd3',1,'Communication']]] +]; diff --git a/sw-modules/module-package-reader/docs/search/all_8.html b/sw-modules/module-package-reader/docs/search/all_8.html new file mode 100644 index 0000000..1e8fb9c --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/all_8.html @@ -0,0 +1,30 @@ + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/sw-modules/module-package-reader/docs/search/all_8.js b/sw-modules/module-package-reader/docs/search/all_8.js new file mode 100644 index 0000000..dfaace4 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/all_8.js @@ -0,0 +1,7 @@ +var searchData= +[ + ['last',['last',['../class_communication.html#a699d7c382d121bd4c0bd74687363315d',1,'Communication']]], + ['lastmessage',['lastMessage',['../classmy_j_s_o_n.html#ace499de7665ab481672fb942788955c9',1,'myJSON']]], + ['line',['line',['../structmy_j_s_o_n_str.html#ad3c04a3cb9e92d80d2719a76169b97fb',1,'myJSONStr']]], + ['loop',['loop',['../class_communication.html#a751d7d863cb0d5a93cd3490012984c55',1,'Communication::loop()'],['../classmy_m_q_t_t.html#a16792912f95306c1de19dd10d9ee9d87',1,'myMQTT::loop()']]] +]; diff --git a/sw-modules/module-package-reader/docs/search/all_9.html b/sw-modules/module-package-reader/docs/search/all_9.html new file mode 100644 index 0000000..27df366 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/all_9.html @@ -0,0 +1,30 @@ + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/sw-modules/module-package-reader/docs/search/all_9.js b/sw-modules/module-package-reader/docs/search/all_9.js new file mode 100644 index 0000000..a886925 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/all_9.js @@ -0,0 +1,17 @@ +var searchData= +[ + ['max_5fjson_5fmessages_5fsaved',['MAX_JSON_MESSAGES_SAVED',['../_communication_configuration_8h.html#acf4afb55aa7d1288ad9dffc623360a8c',1,'CommunicationConfiguration.h']]], + ['max_5fjson_5fparse_5fsize',['MAX_JSON_PARSE_SIZE',['../_communication_configuration_8h.html#a268cecf8b27e3323864627d776dee31d',1,'CommunicationConfiguration.h']]], + ['mqttcommunication_2ecpp',['MQTTCommunication.cpp',['../_m_q_t_t_communication_8cpp.html',1,'']]], + ['mqttcommunication_2eh',['MQTTCommunication.h',['../_m_q_t_t_communication_8h.html',1,'']]], + ['mqttconnectionfailed',['MQTTConnectionFailed',['../classmy_m_q_t_t.html#a260a10a835dc83e7268bc901c5a45a00',1,'myMQTT']]], + ['myjson',['myJSON',['../classmy_j_s_o_n.html',1,'myJSON'],['../classmy_j_s_o_n.html#a895059270e63b6b2ad9c292cb9ecb861',1,'myJSON::myJSON()']]], + ['myjson_2ecpp',['myJSON.cpp',['../my_j_s_o_n_8cpp.html',1,'']]], + ['myjson_2eh',['myJSON.h',['../my_j_s_o_n_8h.html',1,'']]], + ['myjsonstr',['myJSONStr',['../structmy_j_s_o_n_str.html',1,'']]], + ['myjsonstr_2eh',['myJSONStr.h',['../my_j_s_o_n_str_8h.html',1,'']]], + ['mymqtt',['myMQTT',['../classmy_m_q_t_t.html',1,'myMQTT'],['../classmy_m_q_t_t.html#a279474d24c098fcf26a6d433bf794160',1,'myMQTT::myMQTT()']]], + ['mymqtt_2ecpp',['myMQTT.cpp',['../my_m_q_t_t_8cpp.html',1,'']]], + ['mymqtt_2eh',['myMQTT.h',['../my_m_q_t_t_8h.html',1,'']]], + ['mymqttclient',['myMQTTclient',['../classmy_m_q_t_t.html#a3a747c468141e67bcd20c955850e142d',1,'myMQTT']]] +]; diff --git a/sw-modules/module-package-reader/docs/search/all_a.html b/sw-modules/module-package-reader/docs/search/all_a.html new file mode 100644 index 0000000..63f9254 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/all_a.html @@ -0,0 +1,30 @@ + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/sw-modules/module-package-reader/docs/search/all_a.js b/sw-modules/module-package-reader/docs/search/all_a.js new file mode 100644 index 0000000..105f8f1 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/all_a.js @@ -0,0 +1,6 @@ +var searchData= +[ + ['network',['Network',['../class_network.html',1,'Network'],['../class_network.html#a0dfd4ee86e18346c40a7ec13c66c679d',1,'Network::Network()']]], + ['network_2ecpp',['Network.cpp',['../_network_8cpp.html',1,'']]], + ['network_2eh',['Network.h',['../_network_8h.html',1,'']]] +]; diff --git a/sw-modules/module-package-reader/docs/search/all_b.html b/sw-modules/module-package-reader/docs/search/all_b.html new file mode 100644 index 0000000..44ae3e4 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/all_b.html @@ -0,0 +1,30 @@ + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/sw-modules/module-package-reader/docs/search/all_b.js b/sw-modules/module-package-reader/docs/search/all_b.js new file mode 100644 index 0000000..31f4996 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/all_b.js @@ -0,0 +1,28 @@ +var searchData= +[ + ['parsingjsontostruct',['parsingJSONToStruct',['../classmy_j_s_o_n.html#ad655cf00d966cba2100ceb5ed89f3215',1,'myJSON']]], + ['pbrokerip',['pBrokerIP',['../classmy_m_q_t_t.html#a86a31975764922935b74f610c1477497',1,'myMQTT']]], + ['pbrokerport',['pBrokerPort',['../classmy_m_q_t_t.html#a353d2fe6752bcdfe04dd98f1e137ab05',1,'myMQTT']]], + ['pclient',['pClient',['../class_communication.html#aacb5eaa628281d49ca2972b23c8ac652',1,'Communication']]], + ['pencryption',['pEncryption',['../class_network.html#a20c58da03c41b7a9f1b5145e2ce320ea',1,'Network']]], + ['phostname',['pHostname',['../class_communication.html#aa6d4be2b35368ae426852d1cd2b03ef8',1,'Communication::pHostname()'],['../classmy_m_q_t_t.html#a4a0245cabf326ffe19716458e97617d5',1,'myMQTT::pHostname()']]], + ['piplocal',['pIPLocal',['../class_network.html#a9b9b7c16c50e1f7cdda59447b66af4f9',1,'Network']]], + ['pmac',['pMac',['../class_network.html#a48797e41acbbfd72643633e482b97f9f',1,'Network']]], + ['pmacrouter',['pMacRouter',['../class_network.html#a59728fee5cb48783f2f6531d64602dee',1,'Network']]], + ['pmymqtt',['pMymqtt',['../class_communication.html#ae827543871f89ae91a3451dd7299695e',1,'Communication']]], + ['pnetwork',['pNetwork',['../class_communication.html#aa6bf0a64203030930e74ee61153edd3a',1,'Communication']]], + ['pop',['pop',['../class_communication.html#a57ed030b569780ab4937c1b76cb825ea',1,'Communication']]], + ['pparscapacity',['pParsCapacity',['../classmy_j_s_o_n.html#ac76c8f7f3a8d3631406177ca44ccd2cd',1,'myJSON']]], + ['ppassword',['pPassword',['../class_network.html#a45441e8f4bb03d725e1c59504cf744ba',1,'Network']]], + ['printcurrentnet',['printCurrentNet',['../class_network.html#ad2735cbfe5093d27985c310728e166b6',1,'Network']]], + ['printmacaddress',['printMacAddress',['../class_network.html#aa141de92c8e5807f8d69f544fa497705',1,'Network']]], + ['printnetworkinfo',['printNetworkInfo',['../class_communication.html#a712771a08b90a572d4b2115fd5a7c4bd',1,'Communication::printNetworkInfo()'],['../class_network.html#a268526f3cebea91d533596f707b9ee01',1,'Network::printNetworkInfo()']]], + ['printwifidata',['printWiFiData',['../class_network.html#a0a51c159d16b9c5abce7e25231a0776a',1,'Network']]], + ['prssi',['pRssi',['../class_network.html#aff68bd617b4f085f650a21d6982cacc7',1,'Network']]], + ['pssid',['pSsid',['../class_network.html#a37b8b3f25aed35e0813c78e494ea8575',1,'Network']]], + ['publishmessage',['publishMessage',['../class_communication.html#aa59e118e1ed15e911ae2534274ab2e58',1,'Communication::publishMessage()'],['../classmy_m_q_t_t.html#ae15c915d8f868cc4cf5505c20f3d9816',1,'myMQTT::publishMessage()']]], + ['pwifi_5fcs',['pWifi_CS',['../class_network.html#a30246c34ee6f97772dbf27f685c21943',1,'Network']]], + ['pwifi_5fen',['pWifi_EN',['../class_network.html#a7d8d5e27f99515be28c396bcf2694cd3',1,'Network']]], + ['pwifi_5firq',['pWiFi_IRQ',['../class_network.html#ac72ce5aa90e751a2254d01e035adc6c5',1,'Network']]], + ['pwifi_5frst',['pWifi_RST',['../class_network.html#af3c6ee0460d5f234a1339516aeb52564',1,'Network']]] +]; diff --git a/sw-modules/module-package-reader/docs/search/all_c.html b/sw-modules/module-package-reader/docs/search/all_c.html new file mode 100644 index 0000000..3de1586 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/all_c.html @@ -0,0 +1,30 @@ + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/sw-modules/module-package-reader/docs/search/all_c.js b/sw-modules/module-package-reader/docs/search/all_c.js new file mode 100644 index 0000000..689d309 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/all_c.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['readme_2emd',['README.md',['../_r_e_a_d_m_e_8md.html',1,'']]], + ['req',['req',['../structmy_j_s_o_n_str.html#a130d0b0169922d5e7860e7dbebdcff08',1,'myJSONStr']]] +]; diff --git a/sw-modules/module-package-reader/docs/search/all_d.html b/sw-modules/module-package-reader/docs/search/all_d.html new file mode 100644 index 0000000..a2d5bd7 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/all_d.html @@ -0,0 +1,30 @@ + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/sw-modules/module-package-reader/docs/search/all_d.js b/sw-modules/module-package-reader/docs/search/all_d.js new file mode 100644 index 0000000..46c0069 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/all_d.js @@ -0,0 +1,9 @@ +var searchData= +[ + ['smartfactory_5fmqttcommunication',['SmartFactory_MQTTCommunication',['../md__v_1__git__smart_factory__m_q_t_t_communication__r_e_a_d_m_e.html',1,'']]], + ['sector',['sector',['../structmy_j_s_o_n_str.html#a9af6b277c881ad4811835102ce45d82b',1,'myJSONStr']]], + ['shift',['shift',['../class_communication.html#a0925e5cd26fc4fc3a0f99c1997bf0644',1,'Communication']]], + ['size',['size',['../class_communication.html#a097f09aba41fec80fd226c75b91c1cd5',1,'Communication']]], + ['status',['status',['../structmy_j_s_o_n_str.html#aa20d4e1d49713bde35d6e0ad4d215429',1,'myJSONStr']]], + ['subscribe',['subscribe',['../class_communication.html#ae7600b9fe0f1249effde2852e8101593',1,'Communication::subscribe()'],['../classmy_m_q_t_t.html#a55566e23e8705bf3390b6f8209cbd9a1',1,'myMQTT::subscribe()']]] +]; diff --git a/sw-modules/module-package-reader/docs/search/all_e.html b/sw-modules/module-package-reader/docs/search/all_e.html new file mode 100644 index 0000000..f9a056d --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/all_e.html @@ -0,0 +1,30 @@ + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/sw-modules/module-package-reader/docs/search/all_e.js b/sw-modules/module-package-reader/docs/search/all_e.js new file mode 100644 index 0000000..eaf49b6 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/all_e.js @@ -0,0 +1,6 @@ +var searchData= +[ + ['todo_20list',['Todo List',['../todo.html',1,'']]], + ['token',['token',['../structmy_j_s_o_n_str.html#a4e0b6411cf746085506489ed3f5b66f8',1,'myJSONStr']]], + ['topic',['topic',['../structmy_j_s_o_n_str.html#aff87d3e159f45872701dd70a6e74b996',1,'myJSONStr']]] +]; diff --git a/sw-modules/module-package-reader/docs/search/all_f.html b/sw-modules/module-package-reader/docs/search/all_f.html new file mode 100644 index 0000000..f6997fa --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/all_f.html @@ -0,0 +1,30 @@ + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/sw-modules/module-package-reader/docs/search/all_f.js b/sw-modules/module-package-reader/docs/search/all_f.js new file mode 100644 index 0000000..f45235a --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/all_f.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['unsubscribe',['unsubscribe',['../class_communication.html#a6be65dea68cf039e41df2986386dac61',1,'Communication::unsubscribe()'],['../classmy_m_q_t_t.html#a215cee06699f991dd068e92e302563a5',1,'myMQTT::unsubscribe()']]] +]; diff --git a/sw-modules/module-package-reader/docs/search/classes_0.html b/sw-modules/module-package-reader/docs/search/classes_0.html new file mode 100644 index 0000000..b3c6ec6 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/classes_0.html @@ -0,0 +1,30 @@ + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/sw-modules/module-package-reader/docs/search/classes_0.js b/sw-modules/module-package-reader/docs/search/classes_0.js new file mode 100644 index 0000000..3832383 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/classes_0.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['communication',['Communication',['../class_communication.html',1,'']]] +]; diff --git a/sw-modules/module-package-reader/docs/search/classes_1.html b/sw-modules/module-package-reader/docs/search/classes_1.html new file mode 100644 index 0000000..b744c4d --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/classes_1.html @@ -0,0 +1,30 @@ + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/sw-modules/module-package-reader/docs/search/classes_1.js b/sw-modules/module-package-reader/docs/search/classes_1.js new file mode 100644 index 0000000..f412f23 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/classes_1.js @@ -0,0 +1,6 @@ +var searchData= +[ + ['myjson',['myJSON',['../classmy_j_s_o_n.html',1,'']]], + ['myjsonstr',['myJSONStr',['../structmy_j_s_o_n_str.html',1,'']]], + ['mymqtt',['myMQTT',['../classmy_m_q_t_t.html',1,'']]] +]; diff --git a/sw-modules/module-package-reader/docs/search/classes_2.html b/sw-modules/module-package-reader/docs/search/classes_2.html new file mode 100644 index 0000000..7878acb --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/classes_2.html @@ -0,0 +1,30 @@ + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/sw-modules/module-package-reader/docs/search/classes_2.js b/sw-modules/module-package-reader/docs/search/classes_2.js new file mode 100644 index 0000000..5ed710e --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/classes_2.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['network',['Network',['../class_network.html',1,'']]] +]; diff --git a/sw-modules/module-package-reader/docs/search/close.png b/sw-modules/module-package-reader/docs/search/close.png new file mode 100644 index 0000000..9342d3d Binary files /dev/null and b/sw-modules/module-package-reader/docs/search/close.png differ diff --git a/sw-modules/module-package-reader/docs/search/defines_0.html b/sw-modules/module-package-reader/docs/search/defines_0.html new file mode 100644 index 0000000..dbe0642 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/defines_0.html @@ -0,0 +1,30 @@ + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/sw-modules/module-package-reader/docs/search/defines_0.js b/sw-modules/module-package-reader/docs/search/defines_0.js new file mode 100644 index 0000000..288e11f --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/defines_0.js @@ -0,0 +1,14 @@ +var searchData= +[ + ['default_5fmqtt_5fbroker_5fip1',['DEFAULT_MQTT_BROKER_IP1',['../_communication_configuration_8h.html#a5d22797e1aecb523d51e001e4b18bfcd',1,'CommunicationConfiguration.h']]], + ['default_5fmqtt_5fbroker_5fip2',['DEFAULT_MQTT_BROKER_IP2',['../_communication_configuration_8h.html#a3d7bfc12d81b39f60b4c466d73b0f9bd',1,'CommunicationConfiguration.h']]], + ['default_5fmqtt_5fbroker_5fip3',['DEFAULT_MQTT_BROKER_IP3',['../_communication_configuration_8h.html#a5bef8a41df9bae6c18ba9a7cbe7334b1',1,'CommunicationConfiguration.h']]], + ['default_5fmqtt_5fbroker_5fip4',['DEFAULT_MQTT_BROKER_IP4',['../_communication_configuration_8h.html#acd98270e14f470dde211dbf10ab236d5',1,'CommunicationConfiguration.h']]], + ['default_5fmqtt_5fport',['DEFAULT_MQTT_PORT',['../_communication_configuration_8h.html#a01342056d524ed0b20f9e0ccc800d1db',1,'CommunicationConfiguration.h']]], + ['default_5fwifi_5fcs',['DEFAULT_WIFI_CS',['../_communication_configuration_8h.html#a3975cc64a3caa3ee968344f9ac96de46',1,'CommunicationConfiguration.h']]], + ['default_5fwifi_5fen',['DEFAULT_WIFI_EN',['../_communication_configuration_8h.html#a2c1b2ad8f5142dd54d142524127844ce',1,'CommunicationConfiguration.h']]], + ['default_5fwifi_5firq',['DEFAULT_WIFI_IRQ',['../_communication_configuration_8h.html#a2d6cfb023346bcee1140b5579e96133e',1,'CommunicationConfiguration.h']]], + ['default_5fwifi_5fpassword',['DEFAULT_WIFI_PASSWORD',['../_communication_configuration_8h.html#a151690ecdd7d2c7b69586e6df164676c',1,'CommunicationConfiguration.h']]], + ['default_5fwifi_5frst',['DEFAULT_WIFI_RST',['../_communication_configuration_8h.html#a8849f0b55abf9c367def4f2e2faad104',1,'CommunicationConfiguration.h']]], + ['default_5fwifi_5fssid',['DEFAULT_WIFI_SSID',['../_communication_configuration_8h.html#a7ea92631acc3bc41ae5eadc069323267',1,'CommunicationConfiguration.h']]] +]; diff --git a/sw-modules/module-package-reader/docs/search/defines_1.html b/sw-modules/module-package-reader/docs/search/defines_1.html new file mode 100644 index 0000000..7af9324 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/defines_1.html @@ -0,0 +1,30 @@ + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/sw-modules/module-package-reader/docs/search/defines_1.js b/sw-modules/module-package-reader/docs/search/defines_1.js new file mode 100644 index 0000000..cf18956 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/defines_1.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['max_5fjson_5fmessages_5fsaved',['MAX_JSON_MESSAGES_SAVED',['../_communication_configuration_8h.html#acf4afb55aa7d1288ad9dffc623360a8c',1,'CommunicationConfiguration.h']]], + ['max_5fjson_5fparse_5fsize',['MAX_JSON_PARSE_SIZE',['../_communication_configuration_8h.html#a268cecf8b27e3323864627d776dee31d',1,'CommunicationConfiguration.h']]] +]; diff --git a/sw-modules/module-package-reader/docs/search/files_0.html b/sw-modules/module-package-reader/docs/search/files_0.html new file mode 100644 index 0000000..40cd455 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/files_0.html @@ -0,0 +1,30 @@ + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/sw-modules/module-package-reader/docs/search/files_0.js b/sw-modules/module-package-reader/docs/search/files_0.js new file mode 100644 index 0000000..a124513 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/files_0.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['communicationconfiguration_2eh',['CommunicationConfiguration.h',['../_communication_configuration_8h.html',1,'']]] +]; diff --git a/sw-modules/module-package-reader/docs/search/files_1.html b/sw-modules/module-package-reader/docs/search/files_1.html new file mode 100644 index 0000000..646d1f4 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/files_1.html @@ -0,0 +1,30 @@ + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/sw-modules/module-package-reader/docs/search/files_1.js b/sw-modules/module-package-reader/docs/search/files_1.js new file mode 100644 index 0000000..9f4920e --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/files_1.js @@ -0,0 +1,10 @@ +var searchData= +[ + ['mqttcommunication_2ecpp',['MQTTCommunication.cpp',['../_m_q_t_t_communication_8cpp.html',1,'']]], + ['mqttcommunication_2eh',['MQTTCommunication.h',['../_m_q_t_t_communication_8h.html',1,'']]], + ['myjson_2ecpp',['myJSON.cpp',['../my_j_s_o_n_8cpp.html',1,'']]], + ['myjson_2eh',['myJSON.h',['../my_j_s_o_n_8h.html',1,'']]], + ['myjsonstr_2eh',['myJSONStr.h',['../my_j_s_o_n_str_8h.html',1,'']]], + ['mymqtt_2ecpp',['myMQTT.cpp',['../my_m_q_t_t_8cpp.html',1,'']]], + ['mymqtt_2eh',['myMQTT.h',['../my_m_q_t_t_8h.html',1,'']]] +]; diff --git a/sw-modules/module-package-reader/docs/search/files_2.html b/sw-modules/module-package-reader/docs/search/files_2.html new file mode 100644 index 0000000..9e47a77 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/files_2.html @@ -0,0 +1,30 @@ + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/sw-modules/module-package-reader/docs/search/files_2.js b/sw-modules/module-package-reader/docs/search/files_2.js new file mode 100644 index 0000000..1ece8c4 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/files_2.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['network_2ecpp',['Network.cpp',['../_network_8cpp.html',1,'']]], + ['network_2eh',['Network.h',['../_network_8h.html',1,'']]] +]; diff --git a/sw-modules/module-package-reader/docs/search/files_3.html b/sw-modules/module-package-reader/docs/search/files_3.html new file mode 100644 index 0000000..167679b --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/files_3.html @@ -0,0 +1,30 @@ + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/sw-modules/module-package-reader/docs/search/files_3.js b/sw-modules/module-package-reader/docs/search/files_3.js new file mode 100644 index 0000000..66a27ec --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/files_3.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['readme_2emd',['README.md',['../_r_e_a_d_m_e_8md.html',1,'']]] +]; diff --git a/sw-modules/module-package-reader/docs/search/functions_0.html b/sw-modules/module-package-reader/docs/search/functions_0.html new file mode 100644 index 0000000..bc73761 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/functions_0.html @@ -0,0 +1,30 @@ + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/sw-modules/module-package-reader/docs/search/functions_0.js b/sw-modules/module-package-reader/docs/search/functions_0.js new file mode 100644 index 0000000..fcd9038 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/functions_0.js @@ -0,0 +1,8 @@ +var searchData= +[ + ['callback',['callback',['../_m_q_t_t_communication_8cpp.html#ac3a129f66dc859e2b7279565f4e1de78',1,'callback(char *topic, byte *payload, unsigned int length): MQTTCommunication.cpp'],['../_m_q_t_t_communication_8h.html#ac3a129f66dc859e2b7279565f4e1de78',1,'callback(char *topic, byte *payload, unsigned int length): MQTTCommunication.cpp']]], + ['clear',['clear',['../class_communication.html#ab1c097a0ede778d6edd57be55fed77d6',1,'Communication']]], + ['communication',['Communication',['../class_communication.html#ab88eb4c3af7925175dc96a1781da7437',1,'Communication']]], + ['connecttomqtt',['connectToMQTT',['../classmy_m_q_t_t.html#a6d495c08a06513954b95d961f0595959',1,'myMQTT']]], + ['connecttowifi',['connectToWiFi',['../class_network.html#ad7fff536b31740411da0e7c8f281eda9',1,'Network']]] +]; diff --git a/sw-modules/module-package-reader/docs/search/functions_1.html b/sw-modules/module-package-reader/docs/search/functions_1.html new file mode 100644 index 0000000..bfcf880 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/functions_1.html @@ -0,0 +1,30 @@ + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/sw-modules/module-package-reader/docs/search/functions_1.js b/sw-modules/module-package-reader/docs/search/functions_1.js new file mode 100644 index 0000000..5af03d9 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/functions_1.js @@ -0,0 +1,6 @@ +var searchData= +[ + ['decodeencryptiontype',['decodeEncryptionType',['../class_network.html#a07eee94a1b113e65c9d1c6b8c6c6ee44',1,'Network']]], + ['decodemqttstate',['decodeMQTTstate',['../classmy_m_q_t_t.html#ae4372969b093a2487479005ccb398cbc',1,'myMQTT']]], + ['decodewifistate',['decodeWiFistate',['../class_network.html#a31ebd477ecb0f08f85b7fa52b9f2bb7a',1,'Network']]] +]; diff --git a/sw-modules/module-package-reader/docs/search/functions_2.html b/sw-modules/module-package-reader/docs/search/functions_2.html new file mode 100644 index 0000000..2b44474 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/functions_2.html @@ -0,0 +1,30 @@ + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/sw-modules/module-package-reader/docs/search/functions_2.js b/sw-modules/module-package-reader/docs/search/functions_2.js new file mode 100644 index 0000000..a85eb70 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/functions_2.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['first',['first',['../class_communication.html#ab188e8647d1b8abba12dba6101fe4096',1,'Communication']]] +]; diff --git a/sw-modules/module-package-reader/docs/search/functions_3.html b/sw-modules/module-package-reader/docs/search/functions_3.html new file mode 100644 index 0000000..3dca367 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/functions_3.html @@ -0,0 +1,30 @@ + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/sw-modules/module-package-reader/docs/search/functions_3.js b/sw-modules/module-package-reader/docs/search/functions_3.js new file mode 100644 index 0000000..2bbb2c9 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/functions_3.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['getelement',['getElement',['../class_communication.html#a39b312c42c6977923b275047a84e81fe',1,'Communication']]] +]; diff --git a/sw-modules/module-package-reader/docs/search/functions_4.html b/sw-modules/module-package-reader/docs/search/functions_4.html new file mode 100644 index 0000000..e713f28 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/functions_4.html @@ -0,0 +1,30 @@ + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/sw-modules/module-package-reader/docs/search/functions_4.js b/sw-modules/module-package-reader/docs/search/functions_4.js new file mode 100644 index 0000000..d1ad2fa --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/functions_4.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['init',['init',['../class_communication.html#aa526fb8aa735ea4457dc56d1f0a4fe00',1,'Communication::init()'],['../classmy_m_q_t_t.html#a5f19e4308e3dc2d748291d3ca1cd9228',1,'myMQTT::init()'],['../class_network.html#a92193e6fe7a1dc2c7a42d9c9cfed81ed',1,'Network::init()']]], + ['isempty',['isEmpty',['../class_communication.html#ada2063efe2e5667c4317319c2e91ccd3',1,'Communication']]] +]; diff --git a/sw-modules/module-package-reader/docs/search/functions_5.html b/sw-modules/module-package-reader/docs/search/functions_5.html new file mode 100644 index 0000000..cfe6b17 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/functions_5.html @@ -0,0 +1,30 @@ + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/sw-modules/module-package-reader/docs/search/functions_5.js b/sw-modules/module-package-reader/docs/search/functions_5.js new file mode 100644 index 0000000..cb49396 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/functions_5.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['last',['last',['../class_communication.html#a699d7c382d121bd4c0bd74687363315d',1,'Communication']]], + ['loop',['loop',['../class_communication.html#a751d7d863cb0d5a93cd3490012984c55',1,'Communication::loop()'],['../classmy_m_q_t_t.html#a16792912f95306c1de19dd10d9ee9d87',1,'myMQTT::loop()']]] +]; diff --git a/sw-modules/module-package-reader/docs/search/functions_6.html b/sw-modules/module-package-reader/docs/search/functions_6.html new file mode 100644 index 0000000..a78ec13 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/functions_6.html @@ -0,0 +1,30 @@ + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/sw-modules/module-package-reader/docs/search/functions_6.js b/sw-modules/module-package-reader/docs/search/functions_6.js new file mode 100644 index 0000000..3c9b9ee --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/functions_6.js @@ -0,0 +1,6 @@ +var searchData= +[ + ['mqttconnectionfailed',['MQTTConnectionFailed',['../classmy_m_q_t_t.html#a260a10a835dc83e7268bc901c5a45a00',1,'myMQTT']]], + ['myjson',['myJSON',['../classmy_j_s_o_n.html#a895059270e63b6b2ad9c292cb9ecb861',1,'myJSON']]], + ['mymqtt',['myMQTT',['../classmy_m_q_t_t.html#a279474d24c098fcf26a6d433bf794160',1,'myMQTT']]] +]; diff --git a/sw-modules/module-package-reader/docs/search/functions_7.html b/sw-modules/module-package-reader/docs/search/functions_7.html new file mode 100644 index 0000000..7842361 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/functions_7.html @@ -0,0 +1,30 @@ + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/sw-modules/module-package-reader/docs/search/functions_7.js b/sw-modules/module-package-reader/docs/search/functions_7.js new file mode 100644 index 0000000..11a9ef0 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/functions_7.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['network',['Network',['../class_network.html#a0dfd4ee86e18346c40a7ec13c66c679d',1,'Network']]] +]; diff --git a/sw-modules/module-package-reader/docs/search/functions_8.html b/sw-modules/module-package-reader/docs/search/functions_8.html new file mode 100644 index 0000000..48feafe --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/functions_8.html @@ -0,0 +1,30 @@ + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/sw-modules/module-package-reader/docs/search/functions_8.js b/sw-modules/module-package-reader/docs/search/functions_8.js new file mode 100644 index 0000000..a806074 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/functions_8.js @@ -0,0 +1,10 @@ +var searchData= +[ + ['parsingjsontostruct',['parsingJSONToStruct',['../classmy_j_s_o_n.html#ad655cf00d966cba2100ceb5ed89f3215',1,'myJSON']]], + ['pop',['pop',['../class_communication.html#a57ed030b569780ab4937c1b76cb825ea',1,'Communication']]], + ['printcurrentnet',['printCurrentNet',['../class_network.html#ad2735cbfe5093d27985c310728e166b6',1,'Network']]], + ['printmacaddress',['printMacAddress',['../class_network.html#aa141de92c8e5807f8d69f544fa497705',1,'Network']]], + ['printnetworkinfo',['printNetworkInfo',['../class_communication.html#a712771a08b90a572d4b2115fd5a7c4bd',1,'Communication::printNetworkInfo()'],['../class_network.html#a268526f3cebea91d533596f707b9ee01',1,'Network::printNetworkInfo()']]], + ['printwifidata',['printWiFiData',['../class_network.html#a0a51c159d16b9c5abce7e25231a0776a',1,'Network']]], + ['publishmessage',['publishMessage',['../class_communication.html#aa59e118e1ed15e911ae2534274ab2e58',1,'Communication::publishMessage()'],['../classmy_m_q_t_t.html#ae15c915d8f868cc4cf5505c20f3d9816',1,'myMQTT::publishMessage()']]] +]; diff --git a/sw-modules/module-package-reader/docs/search/functions_9.html b/sw-modules/module-package-reader/docs/search/functions_9.html new file mode 100644 index 0000000..0f05a8b --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/functions_9.html @@ -0,0 +1,30 @@ + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/sw-modules/module-package-reader/docs/search/functions_9.js b/sw-modules/module-package-reader/docs/search/functions_9.js new file mode 100644 index 0000000..76df6a7 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/functions_9.js @@ -0,0 +1,6 @@ +var searchData= +[ + ['shift',['shift',['../class_communication.html#a0925e5cd26fc4fc3a0f99c1997bf0644',1,'Communication']]], + ['size',['size',['../class_communication.html#a097f09aba41fec80fd226c75b91c1cd5',1,'Communication']]], + ['subscribe',['subscribe',['../class_communication.html#ae7600b9fe0f1249effde2852e8101593',1,'Communication::subscribe()'],['../classmy_m_q_t_t.html#a55566e23e8705bf3390b6f8209cbd9a1',1,'myMQTT::subscribe()']]] +]; diff --git a/sw-modules/module-package-reader/docs/search/functions_a.html b/sw-modules/module-package-reader/docs/search/functions_a.html new file mode 100644 index 0000000..03faad2 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/functions_a.html @@ -0,0 +1,30 @@ + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/sw-modules/module-package-reader/docs/search/functions_a.js b/sw-modules/module-package-reader/docs/search/functions_a.js new file mode 100644 index 0000000..f45235a --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/functions_a.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['unsubscribe',['unsubscribe',['../class_communication.html#a6be65dea68cf039e41df2986386dac61',1,'Communication::unsubscribe()'],['../classmy_m_q_t_t.html#a215cee06699f991dd068e92e302563a5',1,'myMQTT::unsubscribe()']]] +]; diff --git a/sw-modules/module-package-reader/docs/search/mag_sel.png b/sw-modules/module-package-reader/docs/search/mag_sel.png new file mode 100644 index 0000000..39c0ed5 Binary files /dev/null and b/sw-modules/module-package-reader/docs/search/mag_sel.png differ diff --git a/sw-modules/module-package-reader/docs/search/nomatches.html b/sw-modules/module-package-reader/docs/search/nomatches.html new file mode 100644 index 0000000..4377320 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/nomatches.html @@ -0,0 +1,12 @@ + + + + + + + +
    +
    No Matches
    +
    + + diff --git a/sw-modules/module-package-reader/docs/search/pages_0.html b/sw-modules/module-package-reader/docs/search/pages_0.html new file mode 100644 index 0000000..3d06b05 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/pages_0.html @@ -0,0 +1,30 @@ + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/sw-modules/module-package-reader/docs/search/pages_0.js b/sw-modules/module-package-reader/docs/search/pages_0.js new file mode 100644 index 0000000..f1a9da6 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/pages_0.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['smartfactory_5fmqttcommunication',['SmartFactory_MQTTCommunication',['../md__v_1__git__smart_factory__m_q_t_t_communication__r_e_a_d_m_e.html',1,'']]] +]; diff --git a/sw-modules/module-package-reader/docs/search/pages_1.html b/sw-modules/module-package-reader/docs/search/pages_1.html new file mode 100644 index 0000000..06f1e40 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/pages_1.html @@ -0,0 +1,30 @@ + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/sw-modules/module-package-reader/docs/search/pages_1.js b/sw-modules/module-package-reader/docs/search/pages_1.js new file mode 100644 index 0000000..441b2de --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/pages_1.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['todo_20list',['Todo List',['../todo.html',1,'']]] +]; diff --git a/sw-modules/module-package-reader/docs/search/pages_2.html b/sw-modules/module-package-reader/docs/search/pages_2.html new file mode 100644 index 0000000..703f781 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/pages_2.html @@ -0,0 +1,30 @@ + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/sw-modules/module-package-reader/docs/search/pages_2.js b/sw-modules/module-package-reader/docs/search/pages_2.js new file mode 100644 index 0000000..441b2de --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/pages_2.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['todo_20list',['Todo List',['../todo.html',1,'']]] +]; diff --git a/sw-modules/module-package-reader/docs/search/search.css b/sw-modules/module-package-reader/docs/search/search.css new file mode 100644 index 0000000..3cf9df9 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/search.css @@ -0,0 +1,271 @@ +/*---------------- Search Box */ + +#FSearchBox { + float: left; +} + +#MSearchBox { + white-space : nowrap; + float: none; + margin-top: 8px; + right: 0px; + width: 170px; + height: 24px; + z-index: 102; +} + +#MSearchBox .left +{ + display:block; + position:absolute; + left:10px; + width:20px; + height:19px; + background:url('search_l.png') no-repeat; + background-position:right; +} + +#MSearchSelect { + display:block; + position:absolute; + width:20px; + height:19px; +} + +.left #MSearchSelect { + left:4px; +} + +.right #MSearchSelect { + right:5px; +} + +#MSearchField { + display:block; + position:absolute; + height:19px; + background:url('search_m.png') repeat-x; + border:none; + width:115px; + margin-left:20px; + padding-left:4px; + color: #909090; + outline: none; + font: 9pt Arial, Verdana, sans-serif; + -webkit-border-radius: 0px; +} + +#FSearchBox #MSearchField { + margin-left:15px; +} + +#MSearchBox .right { + display:block; + position:absolute; + right:10px; + top:8px; + width:20px; + height:19px; + background:url('search_r.png') no-repeat; + background-position:left; +} + +#MSearchClose { + display: none; + position: absolute; + top: 4px; + background : none; + border: none; + margin: 0px 4px 0px 0px; + padding: 0px 0px; + outline: none; +} + +.left #MSearchClose { + left: 6px; +} + +.right #MSearchClose { + right: 2px; +} + +.MSearchBoxActive #MSearchField { + color: #000000; +} + +/*---------------- Search filter selection */ + +#MSearchSelectWindow { + display: none; + position: absolute; + left: 0; top: 0; + border: 1px solid #90A5CE; + background-color: #F9FAFC; + z-index: 10001; + padding-top: 4px; + padding-bottom: 4px; + -moz-border-radius: 4px; + -webkit-border-top-left-radius: 4px; + -webkit-border-top-right-radius: 4px; + -webkit-border-bottom-left-radius: 4px; + -webkit-border-bottom-right-radius: 4px; + -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); +} + +.SelectItem { + font: 8pt Arial, Verdana, sans-serif; + padding-left: 2px; + padding-right: 12px; + border: 0px; +} + +span.SelectionMark { + margin-right: 4px; + font-family: monospace; + outline-style: none; + text-decoration: none; +} + +a.SelectItem { + display: block; + outline-style: none; + color: #000000; + text-decoration: none; + padding-left: 6px; + padding-right: 12px; +} + +a.SelectItem:focus, +a.SelectItem:active { + color: #000000; + outline-style: none; + text-decoration: none; +} + +a.SelectItem:hover { + color: #FFFFFF; + background-color: #3D578C; + outline-style: none; + text-decoration: none; + cursor: pointer; + display: block; +} + +/*---------------- Search results window */ + +iframe#MSearchResults { + width: 60ex; + height: 15em; +} + +#MSearchResultsWindow { + display: none; + position: absolute; + left: 0; top: 0; + border: 1px solid #000; + background-color: #EEF1F7; + z-index:10000; +} + +/* ----------------------------------- */ + + +#SRIndex { + clear:both; + padding-bottom: 15px; +} + +.SREntry { + font-size: 10pt; + padding-left: 1ex; +} + +.SRPage .SREntry { + font-size: 8pt; + padding: 1px 5px; +} + +body.SRPage { + margin: 5px 2px; +} + +.SRChildren { + padding-left: 3ex; padding-bottom: .5em +} + +.SRPage .SRChildren { + display: none; +} + +.SRSymbol { + font-weight: bold; + color: #425E97; + font-family: Arial, Verdana, sans-serif; + text-decoration: none; + outline: none; +} + +a.SRScope { + display: block; + color: #425E97; + font-family: Arial, Verdana, sans-serif; + text-decoration: none; + outline: none; +} + +a.SRSymbol:focus, a.SRSymbol:active, +a.SRScope:focus, a.SRScope:active { + text-decoration: underline; +} + +span.SRScope { + padding-left: 4px; +} + +.SRPage .SRStatus { + padding: 2px 5px; + font-size: 8pt; + font-style: italic; +} + +.SRResult { + display: none; +} + +DIV.searchresults { + margin-left: 10px; + margin-right: 10px; +} + +/*---------------- External search page results */ + +.searchresult { + background-color: #F0F3F8; +} + +.pages b { + color: white; + padding: 5px 5px 3px 5px; + background-image: url("../tab_a.png"); + background-repeat: repeat-x; + text-shadow: 0 1px 1px #000000; +} + +.pages { + line-height: 17px; + margin-left: 4px; + text-decoration: none; +} + +.hl { + font-weight: bold; +} + +#searchresults { + margin-bottom: 20px; +} + +.searchpages { + margin-top: 10px; +} + diff --git a/sw-modules/module-package-reader/docs/search/search.js b/sw-modules/module-package-reader/docs/search/search.js new file mode 100644 index 0000000..a554ab9 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/search.js @@ -0,0 +1,814 @@ +/* + @licstart The following is the entire license notice for the + JavaScript code in this file. + + Copyright (C) 1997-2017 by Dimitri van Heesch + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + + @licend The above is the entire license notice + for the JavaScript code in this file + */ +function convertToId(search) +{ + var result = ''; + for (i=0;i do a search + { + this.Search(); + } + } + + this.OnSearchSelectKey = function(evt) + { + var e = (evt) ? evt : window.event; // for IE + if (e.keyCode==40 && this.searchIndex0) // Up + { + this.searchIndex--; + this.OnSelectItem(this.searchIndex); + } + else if (e.keyCode==13 || e.keyCode==27) + { + this.OnSelectItem(this.searchIndex); + this.CloseSelectionWindow(); + this.DOMSearchField().focus(); + } + return false; + } + + // --------- Actions + + // Closes the results window. + this.CloseResultsWindow = function() + { + this.DOMPopupSearchResultsWindow().style.display = 'none'; + this.DOMSearchClose().style.display = 'none'; + this.Activate(false); + } + + this.CloseSelectionWindow = function() + { + this.DOMSearchSelectWindow().style.display = 'none'; + } + + // Performs a search. + this.Search = function() + { + this.keyTimeout = 0; + + // strip leading whitespace + var searchValue = this.DOMSearchField().value.replace(/^ +/, ""); + + var code = searchValue.toLowerCase().charCodeAt(0); + var idxChar = searchValue.substr(0, 1).toLowerCase(); + if ( 0xD800 <= code && code <= 0xDBFF && searchValue > 1) // surrogate pair + { + idxChar = searchValue.substr(0, 2); + } + + var resultsPage; + var resultsPageWithSearch; + var hasResultsPage; + + var idx = indexSectionsWithContent[this.searchIndex].indexOf(idxChar); + if (idx!=-1) + { + var hexCode=idx.toString(16); + resultsPage = this.resultsPath + '/' + indexSectionNames[this.searchIndex] + '_' + hexCode + '.html'; + resultsPageWithSearch = resultsPage+'?'+escape(searchValue); + hasResultsPage = true; + } + else // nothing available for this search term + { + resultsPage = this.resultsPath + '/nomatches.html'; + resultsPageWithSearch = resultsPage; + hasResultsPage = false; + } + + window.frames.MSearchResults.location = resultsPageWithSearch; + var domPopupSearchResultsWindow = this.DOMPopupSearchResultsWindow(); + + if (domPopupSearchResultsWindow.style.display!='block') + { + var domSearchBox = this.DOMSearchBox(); + this.DOMSearchClose().style.display = 'inline'; + if (this.insideFrame) + { + var domPopupSearchResults = this.DOMPopupSearchResults(); + domPopupSearchResultsWindow.style.position = 'relative'; + domPopupSearchResultsWindow.style.display = 'block'; + var width = document.body.clientWidth - 8; // the -8 is for IE :-( + domPopupSearchResultsWindow.style.width = width + 'px'; + domPopupSearchResults.style.width = width + 'px'; + } + else + { + var domPopupSearchResults = this.DOMPopupSearchResults(); + var left = getXPos(domSearchBox) + 150; // domSearchBox.offsetWidth; + var top = getYPos(domSearchBox) + 20; // domSearchBox.offsetHeight + 1; + domPopupSearchResultsWindow.style.display = 'block'; + left -= domPopupSearchResults.offsetWidth; + domPopupSearchResultsWindow.style.top = top + 'px'; + domPopupSearchResultsWindow.style.left = left + 'px'; + } + } + + this.lastSearchValue = searchValue; + this.lastResultsPage = resultsPage; + } + + // -------- Activation Functions + + // Activates or deactivates the search panel, resetting things to + // their default values if necessary. + this.Activate = function(isActive) + { + if (isActive || // open it + this.DOMPopupSearchResultsWindow().style.display == 'block' + ) + { + this.DOMSearchBox().className = 'MSearchBoxActive'; + + var searchField = this.DOMSearchField(); + + if (searchField.value == this.searchLabel) // clear "Search" term upon entry + { + searchField.value = ''; + this.searchActive = true; + } + } + else if (!isActive) // directly remove the panel + { + this.DOMSearchBox().className = 'MSearchBoxInactive'; + this.DOMSearchField().value = this.searchLabel; + this.searchActive = false; + this.lastSearchValue = '' + this.lastResultsPage = ''; + } + } +} + +// ----------------------------------------------------------------------- + +// The class that handles everything on the search results page. +function SearchResults(name) +{ + // The number of matches from the last run of . + this.lastMatchCount = 0; + this.lastKey = 0; + this.repeatOn = false; + + // Toggles the visibility of the passed element ID. + this.FindChildElement = function(id) + { + var parentElement = document.getElementById(id); + var element = parentElement.firstChild; + + while (element && element!=parentElement) + { + if (element.nodeName == 'DIV' && element.className == 'SRChildren') + { + return element; + } + + if (element.nodeName == 'DIV' && element.hasChildNodes()) + { + element = element.firstChild; + } + else if (element.nextSibling) + { + element = element.nextSibling; + } + else + { + do + { + element = element.parentNode; + } + while (element && element!=parentElement && !element.nextSibling); + + if (element && element!=parentElement) + { + element = element.nextSibling; + } + } + } + } + + this.Toggle = function(id) + { + var element = this.FindChildElement(id); + if (element) + { + if (element.style.display == 'block') + { + element.style.display = 'none'; + } + else + { + element.style.display = 'block'; + } + } + } + + // Searches for the passed string. If there is no parameter, + // it takes it from the URL query. + // + // Always returns true, since other documents may try to call it + // and that may or may not be possible. + this.Search = function(search) + { + if (!search) // get search word from URL + { + search = window.location.search; + search = search.substring(1); // Remove the leading '?' + search = unescape(search); + } + + search = search.replace(/^ +/, ""); // strip leading spaces + search = search.replace(/ +$/, ""); // strip trailing spaces + search = search.toLowerCase(); + search = convertToId(search); + + var resultRows = document.getElementsByTagName("div"); + var matches = 0; + + var i = 0; + while (i < resultRows.length) + { + var row = resultRows.item(i); + if (row.className == "SRResult") + { + var rowMatchName = row.id.toLowerCase(); + rowMatchName = rowMatchName.replace(/^sr\d*_/, ''); // strip 'sr123_' + + if (search.length<=rowMatchName.length && + rowMatchName.substr(0, search.length)==search) + { + row.style.display = 'block'; + matches++; + } + else + { + row.style.display = 'none'; + } + } + i++; + } + document.getElementById("Searching").style.display='none'; + if (matches == 0) // no results + { + document.getElementById("NoMatches").style.display='block'; + } + else // at least one result + { + document.getElementById("NoMatches").style.display='none'; + } + this.lastMatchCount = matches; + return true; + } + + // return the first item with index index or higher that is visible + this.NavNext = function(index) + { + var focusItem; + while (1) + { + var focusName = 'Item'+index; + focusItem = document.getElementById(focusName); + if (focusItem && focusItem.parentNode.parentNode.style.display=='block') + { + break; + } + else if (!focusItem) // last element + { + break; + } + focusItem=null; + index++; + } + return focusItem; + } + + this.NavPrev = function(index) + { + var focusItem; + while (1) + { + var focusName = 'Item'+index; + focusItem = document.getElementById(focusName); + if (focusItem && focusItem.parentNode.parentNode.style.display=='block') + { + break; + } + else if (!focusItem) // last element + { + break; + } + focusItem=null; + index--; + } + return focusItem; + } + + this.ProcessKeys = function(e) + { + if (e.type == "keydown") + { + this.repeatOn = false; + this.lastKey = e.keyCode; + } + else if (e.type == "keypress") + { + if (!this.repeatOn) + { + if (this.lastKey) this.repeatOn = true; + return false; // ignore first keypress after keydown + } + } + else if (e.type == "keyup") + { + this.lastKey = 0; + this.repeatOn = false; + } + return this.lastKey!=0; + } + + this.Nav = function(evt,itemIndex) + { + var e = (evt) ? evt : window.event; // for IE + if (e.keyCode==13) return true; + if (!this.ProcessKeys(e)) return false; + + if (this.lastKey==38) // Up + { + var newIndex = itemIndex-1; + var focusItem = this.NavPrev(newIndex); + if (focusItem) + { + var child = this.FindChildElement(focusItem.parentNode.parentNode.id); + if (child && child.style.display == 'block') // children visible + { + var n=0; + var tmpElem; + while (1) // search for last child + { + tmpElem = document.getElementById('Item'+newIndex+'_c'+n); + if (tmpElem) + { + focusItem = tmpElem; + } + else // found it! + { + break; + } + n++; + } + } + } + if (focusItem) + { + focusItem.focus(); + } + else // return focus to search field + { + parent.document.getElementById("MSearchField").focus(); + } + } + else if (this.lastKey==40) // Down + { + var newIndex = itemIndex+1; + var focusItem; + var item = document.getElementById('Item'+itemIndex); + var elem = this.FindChildElement(item.parentNode.parentNode.id); + if (elem && elem.style.display == 'block') // children visible + { + focusItem = document.getElementById('Item'+itemIndex+'_c0'); + } + if (!focusItem) focusItem = this.NavNext(newIndex); + if (focusItem) focusItem.focus(); + } + else if (this.lastKey==39) // Right + { + var item = document.getElementById('Item'+itemIndex); + var elem = this.FindChildElement(item.parentNode.parentNode.id); + if (elem) elem.style.display = 'block'; + } + else if (this.lastKey==37) // Left + { + var item = document.getElementById('Item'+itemIndex); + var elem = this.FindChildElement(item.parentNode.parentNode.id); + if (elem) elem.style.display = 'none'; + } + else if (this.lastKey==27) // Escape + { + parent.searchBox.CloseResultsWindow(); + parent.document.getElementById("MSearchField").focus(); + } + else if (this.lastKey==13) // Enter + { + return true; + } + return false; + } + + this.NavChild = function(evt,itemIndex,childIndex) + { + var e = (evt) ? evt : window.event; // for IE + if (e.keyCode==13) return true; + if (!this.ProcessKeys(e)) return false; + + if (this.lastKey==38) // Up + { + if (childIndex>0) + { + var newIndex = childIndex-1; + document.getElementById('Item'+itemIndex+'_c'+newIndex).focus(); + } + else // already at first child, jump to parent + { + document.getElementById('Item'+itemIndex).focus(); + } + } + else if (this.lastKey==40) // Down + { + var newIndex = childIndex+1; + var elem = document.getElementById('Item'+itemIndex+'_c'+newIndex); + if (!elem) // last child, jump to parent next parent + { + elem = this.NavNext(itemIndex+1); + } + if (elem) + { + elem.focus(); + } + } + else if (this.lastKey==27) // Escape + { + parent.searchBox.CloseResultsWindow(); + parent.document.getElementById("MSearchField").focus(); + } + else if (this.lastKey==13) // Enter + { + return true; + } + return false; + } +} + +function setKeyActions(elem,action) +{ + elem.setAttribute('onkeydown',action); + elem.setAttribute('onkeypress',action); + elem.setAttribute('onkeyup',action); +} + +function setClassAttr(elem,attr) +{ + elem.setAttribute('class',attr); + elem.setAttribute('className',attr); +} + +function createResults() +{ + var results = document.getElementById("SRResults"); + for (var e=0; e + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/sw-modules/module-package-reader/docs/search/variables_0.js b/sw-modules/module-package-reader/docs/search/variables_0.js new file mode 100644 index 0000000..dfb4c75 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/variables_0.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['_5fbuffer',['_buffer',['../_m_q_t_t_communication_8cpp.html#ac88e2994c014e5e95aa2497a7501ea6a',1,'_buffer(): MQTTCommunication.cpp'],['../_m_q_t_t_communication_8h.html#ac88e2994c014e5e95aa2497a7501ea6a',1,'_buffer(): MQTTCommunication.cpp']]], + ['_5fmyjson',['_myjson',['../_m_q_t_t_communication_8cpp.html#a4283a95f69f867cc1506b5c3ef038644',1,'_myjson(): MQTTCommunication.cpp'],['../_m_q_t_t_communication_8h.html#a7b53ade1cc8486457ead86c3c41a0c7e',1,'_myjson(): MQTTCommunication.h']]] +]; diff --git a/sw-modules/module-package-reader/docs/search/variables_1.html b/sw-modules/module-package-reader/docs/search/variables_1.html new file mode 100644 index 0000000..b784017 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/variables_1.html @@ -0,0 +1,30 @@ + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/sw-modules/module-package-reader/docs/search/variables_1.js b/sw-modules/module-package-reader/docs/search/variables_1.js new file mode 100644 index 0000000..f7a8f62 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/variables_1.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['ack',['ack',['../structmy_j_s_o_n_str.html#a35f72407798562c604aa8ce4517979db',1,'myJSONStr']]] +]; diff --git a/sw-modules/module-package-reader/docs/search/variables_2.html b/sw-modules/module-package-reader/docs/search/variables_2.html new file mode 100644 index 0000000..0cb98d3 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/variables_2.html @@ -0,0 +1,30 @@ + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/sw-modules/module-package-reader/docs/search/variables_2.js b/sw-modules/module-package-reader/docs/search/variables_2.js new file mode 100644 index 0000000..9c93558 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/variables_2.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['cargo',['cargo',['../structmy_j_s_o_n_str.html#a06a829e44e957ec5e05976a50866138f',1,'myJSONStr']]] +]; diff --git a/sw-modules/module-package-reader/docs/search/variables_3.html b/sw-modules/module-package-reader/docs/search/variables_3.html new file mode 100644 index 0000000..1e83bf5 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/variables_3.html @@ -0,0 +1,30 @@ + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/sw-modules/module-package-reader/docs/search/variables_3.js b/sw-modules/module-package-reader/docs/search/variables_3.js new file mode 100644 index 0000000..94e4f3e --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/variables_3.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['error',['error',['../structmy_j_s_o_n_str.html#a47cc65fe9a93c0436c7c1f977be884db',1,'myJSONStr']]] +]; diff --git a/sw-modules/module-package-reader/docs/search/variables_4.html b/sw-modules/module-package-reader/docs/search/variables_4.html new file mode 100644 index 0000000..39883bd --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/variables_4.html @@ -0,0 +1,30 @@ + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/sw-modules/module-package-reader/docs/search/variables_4.js b/sw-modules/module-package-reader/docs/search/variables_4.js new file mode 100644 index 0000000..eb5b6ec --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/variables_4.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['funcpointer',['funcPointer',['../class_communication.html#a0b8c2ab44fad41881b8da21367a02da4',1,'Communication']]] +]; diff --git a/sw-modules/module-package-reader/docs/search/variables_5.html b/sw-modules/module-package-reader/docs/search/variables_5.html new file mode 100644 index 0000000..f25879c --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/variables_5.html @@ -0,0 +1,30 @@ + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/sw-modules/module-package-reader/docs/search/variables_5.js b/sw-modules/module-package-reader/docs/search/variables_5.js new file mode 100644 index 0000000..4a6353f --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/variables_5.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['id',['id',['../structmy_j_s_o_n_str.html#a78a5f8711dd64c450d7f01d6a5c337fa',1,'myJSONStr']]] +]; diff --git a/sw-modules/module-package-reader/docs/search/variables_6.html b/sw-modules/module-package-reader/docs/search/variables_6.html new file mode 100644 index 0000000..0fcd6c2 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/variables_6.html @@ -0,0 +1,30 @@ + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/sw-modules/module-package-reader/docs/search/variables_6.js b/sw-modules/module-package-reader/docs/search/variables_6.js new file mode 100644 index 0000000..33ef934 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/variables_6.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['lastmessage',['lastMessage',['../classmy_j_s_o_n.html#ace499de7665ab481672fb942788955c9',1,'myJSON']]], + ['line',['line',['../structmy_j_s_o_n_str.html#ad3c04a3cb9e92d80d2719a76169b97fb',1,'myJSONStr']]] +]; diff --git a/sw-modules/module-package-reader/docs/search/variables_7.html b/sw-modules/module-package-reader/docs/search/variables_7.html new file mode 100644 index 0000000..ad2fa37 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/variables_7.html @@ -0,0 +1,30 @@ + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/sw-modules/module-package-reader/docs/search/variables_7.js b/sw-modules/module-package-reader/docs/search/variables_7.js new file mode 100644 index 0000000..6a861ed --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/variables_7.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['mymqttclient',['myMQTTclient',['../classmy_m_q_t_t.html#a3a747c468141e67bcd20c955850e142d',1,'myMQTT']]] +]; diff --git a/sw-modules/module-package-reader/docs/search/variables_8.html b/sw-modules/module-package-reader/docs/search/variables_8.html new file mode 100644 index 0000000..23887d7 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/variables_8.html @@ -0,0 +1,30 @@ + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/sw-modules/module-package-reader/docs/search/variables_8.js b/sw-modules/module-package-reader/docs/search/variables_8.js new file mode 100644 index 0000000..3ec8bda --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/variables_8.js @@ -0,0 +1,21 @@ +var searchData= +[ + ['pbrokerip',['pBrokerIP',['../classmy_m_q_t_t.html#a86a31975764922935b74f610c1477497',1,'myMQTT']]], + ['pbrokerport',['pBrokerPort',['../classmy_m_q_t_t.html#a353d2fe6752bcdfe04dd98f1e137ab05',1,'myMQTT']]], + ['pclient',['pClient',['../class_communication.html#aacb5eaa628281d49ca2972b23c8ac652',1,'Communication']]], + ['pencryption',['pEncryption',['../class_network.html#a20c58da03c41b7a9f1b5145e2ce320ea',1,'Network']]], + ['phostname',['pHostname',['../class_communication.html#aa6d4be2b35368ae426852d1cd2b03ef8',1,'Communication::pHostname()'],['../classmy_m_q_t_t.html#a4a0245cabf326ffe19716458e97617d5',1,'myMQTT::pHostname()']]], + ['piplocal',['pIPLocal',['../class_network.html#a9b9b7c16c50e1f7cdda59447b66af4f9',1,'Network']]], + ['pmac',['pMac',['../class_network.html#a48797e41acbbfd72643633e482b97f9f',1,'Network']]], + ['pmacrouter',['pMacRouter',['../class_network.html#a59728fee5cb48783f2f6531d64602dee',1,'Network']]], + ['pmymqtt',['pMymqtt',['../class_communication.html#ae827543871f89ae91a3451dd7299695e',1,'Communication']]], + ['pnetwork',['pNetwork',['../class_communication.html#aa6bf0a64203030930e74ee61153edd3a',1,'Communication']]], + ['pparscapacity',['pParsCapacity',['../classmy_j_s_o_n.html#ac76c8f7f3a8d3631406177ca44ccd2cd',1,'myJSON']]], + ['ppassword',['pPassword',['../class_network.html#a45441e8f4bb03d725e1c59504cf744ba',1,'Network']]], + ['prssi',['pRssi',['../class_network.html#aff68bd617b4f085f650a21d6982cacc7',1,'Network']]], + ['pssid',['pSsid',['../class_network.html#a37b8b3f25aed35e0813c78e494ea8575',1,'Network']]], + ['pwifi_5fcs',['pWifi_CS',['../class_network.html#a30246c34ee6f97772dbf27f685c21943',1,'Network']]], + ['pwifi_5fen',['pWifi_EN',['../class_network.html#a7d8d5e27f99515be28c396bcf2694cd3',1,'Network']]], + ['pwifi_5firq',['pWiFi_IRQ',['../class_network.html#ac72ce5aa90e751a2254d01e035adc6c5',1,'Network']]], + ['pwifi_5frst',['pWifi_RST',['../class_network.html#af3c6ee0460d5f234a1339516aeb52564',1,'Network']]] +]; diff --git a/sw-modules/module-package-reader/docs/search/variables_9.html b/sw-modules/module-package-reader/docs/search/variables_9.html new file mode 100644 index 0000000..f446649 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/variables_9.html @@ -0,0 +1,30 @@ + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/sw-modules/module-package-reader/docs/search/variables_9.js b/sw-modules/module-package-reader/docs/search/variables_9.js new file mode 100644 index 0000000..8368edd --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/variables_9.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['req',['req',['../structmy_j_s_o_n_str.html#a130d0b0169922d5e7860e7dbebdcff08',1,'myJSONStr']]] +]; diff --git a/sw-modules/module-package-reader/docs/search/variables_a.html b/sw-modules/module-package-reader/docs/search/variables_a.html new file mode 100644 index 0000000..59633b3 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/variables_a.html @@ -0,0 +1,30 @@ + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/sw-modules/module-package-reader/docs/search/variables_a.js b/sw-modules/module-package-reader/docs/search/variables_a.js new file mode 100644 index 0000000..aec1c51 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/variables_a.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['sector',['sector',['../structmy_j_s_o_n_str.html#a9af6b277c881ad4811835102ce45d82b',1,'myJSONStr']]], + ['status',['status',['../structmy_j_s_o_n_str.html#aa20d4e1d49713bde35d6e0ad4d215429',1,'myJSONStr']]] +]; diff --git a/sw-modules/module-package-reader/docs/search/variables_b.html b/sw-modules/module-package-reader/docs/search/variables_b.html new file mode 100644 index 0000000..1721609 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/variables_b.html @@ -0,0 +1,30 @@ + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/sw-modules/module-package-reader/docs/search/variables_b.js b/sw-modules/module-package-reader/docs/search/variables_b.js new file mode 100644 index 0000000..1d4ffa7 --- /dev/null +++ b/sw-modules/module-package-reader/docs/search/variables_b.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['token',['token',['../structmy_j_s_o_n_str.html#a4e0b6411cf746085506489ed3f5b66f8',1,'myJSONStr']]], + ['topic',['topic',['../structmy_j_s_o_n_str.html#aff87d3e159f45872701dd70a6e74b996',1,'myJSONStr']]] +]; diff --git a/sw-modules/module-package-reader/docs/splitbar.png b/sw-modules/module-package-reader/docs/splitbar.png new file mode 100644 index 0000000..fe895f2 Binary files /dev/null and b/sw-modules/module-package-reader/docs/splitbar.png differ diff --git a/sw-modules/module-package-reader/docs/structmy_j_s_o_n_str-members.html b/sw-modules/module-package-reader/docs/structmy_j_s_o_n_str-members.html new file mode 100644 index 0000000..2622ba9 --- /dev/null +++ b/sw-modules/module-package-reader/docs/structmy_j_s_o_n_str-members.html @@ -0,0 +1,117 @@ + + + + + + + +MQTT Communication: Member List + + + + + + + + + + + + + + +
    +
    + + + + + + +
    +
    MQTT Communication +
    +
    Smart Factory
    +
    +
    + + + + + + + +
    +
    + +
    +
    +
    + +
    + +
    +
    + + +
    + +
    + +
    +
    +
    myJSONStr Member List
    +
    +
    + +

    This is the complete list of members for myJSONStr, including all inherited members.

    + + + + + + + + + + + +
    ackmyJSONStr
    cargomyJSONStr
    errormyJSONStr
    idmyJSONStr
    linemyJSONStr
    reqmyJSONStr
    sectormyJSONStr
    statusmyJSONStr
    tokenmyJSONStr
    topicmyJSONStr
    +
    + + + + diff --git a/sw-modules/module-package-reader/docs/structmy_j_s_o_n_str.html b/sw-modules/module-package-reader/docs/structmy_j_s_o_n_str.html new file mode 100644 index 0000000..1aaf318 --- /dev/null +++ b/sw-modules/module-package-reader/docs/structmy_j_s_o_n_str.html @@ -0,0 +1,335 @@ + + + + + + + +MQTT Communication: myJSONStr Struct Reference + + + + + + + + + + + + + + +
    +
    + + + + + + +
    +
    MQTT Communication +
    +
    Smart Factory
    +
    +
    + + + + + + + +
    +
    + +
    +
    +
    + +
    + +
    +
    + + +
    + +
    + +
    +
    +Public Attributes | +List of all members
    +
    +
    myJSONStr Struct Reference
    +
    +
    + +

    myJSON Struct defines the format of the messages + More...

    + +

    #include <myJSONStr.h>

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Public Attributes

    String id = "-1"
     Hostname. More...
     
    String topic = "-1"
     MQTT topic. More...
     
    String status = "-1"
     Status. More...
     
    String sector = "-1"
     Sector. More...
     
    int line = -1
     Line. More...
     
    String ack = "-1"
     Acknoledgement. More...
     
    String req = "-1"
     Request. More...
     
    String cargo = "-1"
     Cargo. More...
     
    bool token = false
     Gateway and Reset-token. More...
     
    bool error = false
     Error-token. More...
     
    +

    Detailed Description

    +

    myJSON Struct defines the format of the messages

    + +

    Definition at line 33 of file myJSONStr.h.

    +

    Member Data Documentation

    + +

    ◆ ack

    + +
    +
    + + + + +
    String myJSONStr::ack = "-1"
    +
    + +

    Acknoledgement.

    + +

    Definition at line 39 of file myJSONStr.h.

    + +
    +
    + +

    ◆ cargo

    + +
    +
    + + + + +
    String myJSONStr::cargo = "-1"
    +
    + +

    Cargo.

    + +

    Definition at line 41 of file myJSONStr.h.

    + +
    +
    + +

    ◆ error

    + +
    +
    + + + + +
    bool myJSONStr::error = false
    +
    + +

    Error-token.

    + +

    Definition at line 43 of file myJSONStr.h.

    + +
    +
    + +

    ◆ id

    + +
    +
    + + + + +
    String myJSONStr::id = "-1"
    +
    + +

    Hostname.

    + +

    Definition at line 34 of file myJSONStr.h.

    + +
    +
    + +

    ◆ line

    + +
    +
    + + + + +
    int myJSONStr::line = -1
    +
    + +

    Line.

    + +

    Definition at line 38 of file myJSONStr.h.

    + +
    +
    + +

    ◆ req

    + +
    +
    + + + + +
    String myJSONStr::req = "-1"
    +
    + +

    Request.

    + +

    Definition at line 40 of file myJSONStr.h.

    + +
    +
    + +

    ◆ sector

    + +
    +
    + + + + +
    String myJSONStr::sector = "-1"
    +
    + +

    Sector.

    + +

    Definition at line 37 of file myJSONStr.h.

    + +
    +
    + +

    ◆ status

    + +
    +
    + + + + +
    String myJSONStr::status = "-1"
    +
    + +

    Status.

    + +

    Definition at line 36 of file myJSONStr.h.

    + +
    +
    + +

    ◆ token

    + +
    +
    + + + + +
    bool myJSONStr::token = false
    +
    + +

    Gateway and Reset-token.

    + +

    Definition at line 42 of file myJSONStr.h.

    + +
    +
    + +

    ◆ topic

    + +
    +
    + + + + +
    String myJSONStr::topic = "-1"
    +
    + +

    MQTT topic.

    + +

    Definition at line 35 of file myJSONStr.h.

    + +
    +
    +
    The documentation for this struct was generated from the following file: +
    +
    + + + + diff --git a/sw-modules/module-package-reader/docs/structmy_j_s_o_n_str.js b/sw-modules/module-package-reader/docs/structmy_j_s_o_n_str.js new file mode 100644 index 0000000..67140ed --- /dev/null +++ b/sw-modules/module-package-reader/docs/structmy_j_s_o_n_str.js @@ -0,0 +1,13 @@ +var structmy_j_s_o_n_str = +[ + [ "ack", "structmy_j_s_o_n_str.html#a35f72407798562c604aa8ce4517979db", null ], + [ "cargo", "structmy_j_s_o_n_str.html#a06a829e44e957ec5e05976a50866138f", null ], + [ "error", "structmy_j_s_o_n_str.html#a47cc65fe9a93c0436c7c1f977be884db", null ], + [ "id", "structmy_j_s_o_n_str.html#a78a5f8711dd64c450d7f01d6a5c337fa", null ], + [ "line", "structmy_j_s_o_n_str.html#ad3c04a3cb9e92d80d2719a76169b97fb", null ], + [ "req", "structmy_j_s_o_n_str.html#a130d0b0169922d5e7860e7dbebdcff08", null ], + [ "sector", "structmy_j_s_o_n_str.html#a9af6b277c881ad4811835102ce45d82b", null ], + [ "status", "structmy_j_s_o_n_str.html#aa20d4e1d49713bde35d6e0ad4d215429", null ], + [ "token", "structmy_j_s_o_n_str.html#a4e0b6411cf746085506489ed3f5b66f8", null ], + [ "topic", "structmy_j_s_o_n_str.html#aff87d3e159f45872701dd70a6e74b996", null ] +]; \ No newline at end of file diff --git a/sw-modules/module-package-reader/docs/sync_off.png b/sw-modules/module-package-reader/docs/sync_off.png new file mode 100644 index 0000000..3b443fc Binary files /dev/null and b/sw-modules/module-package-reader/docs/sync_off.png differ diff --git a/sw-modules/module-package-reader/docs/sync_on.png b/sw-modules/module-package-reader/docs/sync_on.png new file mode 100644 index 0000000..e08320f Binary files /dev/null and b/sw-modules/module-package-reader/docs/sync_on.png differ diff --git a/sw-modules/module-package-reader/docs/tab_a.png b/sw-modules/module-package-reader/docs/tab_a.png new file mode 100644 index 0000000..3b725c4 Binary files /dev/null and b/sw-modules/module-package-reader/docs/tab_a.png differ diff --git a/sw-modules/module-package-reader/docs/tab_b.png b/sw-modules/module-package-reader/docs/tab_b.png new file mode 100644 index 0000000..e2b4a86 Binary files /dev/null and b/sw-modules/module-package-reader/docs/tab_b.png differ diff --git a/sw-modules/module-package-reader/docs/tab_h.png b/sw-modules/module-package-reader/docs/tab_h.png new file mode 100644 index 0000000..fd5cb70 Binary files /dev/null and b/sw-modules/module-package-reader/docs/tab_h.png differ diff --git a/sw-modules/module-package-reader/docs/tab_s.png b/sw-modules/module-package-reader/docs/tab_s.png new file mode 100644 index 0000000..ab478c9 Binary files /dev/null and b/sw-modules/module-package-reader/docs/tab_s.png differ diff --git a/sw-modules/module-package-reader/docs/tabs.css b/sw-modules/module-package-reader/docs/tabs.css new file mode 100644 index 0000000..8ea7d54 --- /dev/null +++ b/sw-modules/module-package-reader/docs/tabs.css @@ -0,0 +1 @@ +.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.sm-dox{background-image:url("tab_b.png")}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:"Lucida Grande","Geneva","Helvetica",Arial,sans-serif;font-size:13px;font-weight:bold;line-height:36px;text-decoration:none;text-shadow:0 1px 1px rgba(255,255,255,0.9);color:#283a5d;outline:0}.sm-dox a:hover{background-image:url("tab_a.png");background-repeat:repeat-x;color:white;text-shadow:0 1px 1px black}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;background:rgba(255,255,255,0.5);-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:rgba(162,162,162,0.1)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:white;background-image:none}.sm-dox ul a:hover{background-image:url("tab_a.png");background-repeat:repeat-x;color:white;text-shadow:0 1px 1px black}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-image:url("tab_b.png");line-height:36px}.sm-dox a span.sub-arrow{top:50%;margin-top:-2px;right:12px;width:0;height:0;border-width:4px;border-style:solid dashed dashed dashed;border-color:#283a5d transparent transparent transparent;background:transparent;-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 12px;background-image:url("tab_s.png");background-repeat:no-repeat;background-position:right;-moz-border-radius:0 !important;-webkit-border-radius:0;border-radius:0 !important}.sm-dox a:hover{background-image:url("tab_a.png");background-repeat:repeat-x;color:white;text-shadow:0 1px 1px black}.sm-dox a:hover span.sub-arrow{border-color:white transparent transparent transparent}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent #fff transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:#fff;-moz-border-radius:5px !important;-webkit-border-radius:5px;border-radius:5px !important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-color:transparent transparent transparent #555;border-style:dashed dashed dashed solid}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:#555;background-image:none;border:0 !important;color:#555;background-image:none}.sm-dox ul a:hover{background-image:url("tab_a.png");background-repeat:repeat-x;color:white;text-shadow:0 1px 1px black}.sm-dox ul a:hover span.sub-arrow{border-color:transparent transparent transparent white}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:#fff;height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent #555 transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:#555 transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:12px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:12px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a.disabled{background-image:url("tab_b.png")}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:#fff}} \ No newline at end of file diff --git a/sw-modules/module-package-reader/docs/todo.html b/sw-modules/module-package-reader/docs/todo.html new file mode 100644 index 0000000..9767489 --- /dev/null +++ b/sw-modules/module-package-reader/docs/todo.html @@ -0,0 +1,118 @@ + + + + + + + +MQTT Communication: Todo List + + + + + + + + + + + + + + +
    +
    + + + + + + +
    +
    MQTT Communication +
    +
    Smart Factory
    +
    +
    + + + + + + + +
    +
    + +
    +
    +
    + +
    + +
    +
    + + +
    + +
    + +
    +
    +
    Todo List
    +
    +
    +
    +
    Member callback (char *topic, byte *payload, unsigned int length)
    +
    Change global implementation of callback. Maybe with static?
    +
    File CommunicationConfiguration.h
    +
    Switch Password to .ini file
    +https://community.platformio.org/t/how-to-specify-ota-upload-password-outside-platformio-ini/3588
    +http://docs.platformio.org/en/latest/envvars.html#building
    +
    File MQTTCommunication.h
    +
    Split the Code into two Repos: SmartFactory_Communication-Sortic
    +and SmartFactory_MQTTCommunication-Basis to simplify modular use.
    +
    File myMQTT.h
    +
    Add a function "unsubscirbeAll" which unsubscribes from all subscirbed topics. Hence you need to track all your subscribed topcis in an array.
    +
    +
    +
    +
    + + + + diff --git a/sw-modules/module-package-reader/doxygen/Doxyfile b/sw-modules/module-package-reader/doxygen/Doxyfile new file mode 100644 index 0000000..b3260f4 --- /dev/null +++ b/sw-modules/module-package-reader/doxygen/Doxyfile @@ -0,0 +1,2565 @@ +# Doxyfile 1.8.15 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the configuration +# file that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# https://www.gnu.org/software/libiconv/ for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "MQTT Communication" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = "Smart Factory" + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = .\..\docs + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all generated output in the proper direction. +# Possible values are: None, LTR, RTL and Context. +# The default value is: None. + +OUTPUT_TEXT_DIRECTION = None + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = NO + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines (in the resulting output). You can put ^^ in the value part of an +# alias to insert a newline as if a physical newline was in the original file. +# When you need a literal { or } or , in the value part of an alias you have to +# escape them by means of a backslash (\), this can lead to conflicts with the +# commands \{ and \} for these it is advised to use the version @{ and @} or use +# a double escape (\\{ and \\}) + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice +# sources only. Doxygen will then generate output that is more tailored for that +# language. For instance, namespaces will be presented as modules, types will be +# separated into more groups, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_SLICE = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, +# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: +# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser +# tries to guess whether the code is fixed or free formatted code, this is the +# default for Fortran type files), VHDL, tcl. For instance to make doxygen treat +# .inc files as Fortran files (default is PHP), and .f files as C (default is +# Fortran), use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See https://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 0. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 0 + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = YES + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = YES + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = YES + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO, these declarations will be +# included in the documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES, upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES = NO + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong or incomplete +# parameter documentation, but not about the absence of documentation. If +# EXTRACT_ALL is set to YES then this flag will automatically be disabled. +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. +# The default value is: NO. + +WARN_AS_ERROR = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = .\..\ + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: https://www.gnu.org/software/libiconv/) for the list of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, +# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, +# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, +# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice. + +FILE_PATTERNS = *.c \ + *.cc \ + *.cxx \ + *.cpp \ + *.c++ \ + *.java \ + *.ii \ + *.ixx \ + *.ipp \ + *.i++ \ + *.inl \ + *.idl \ + *.ddl \ + *.odl \ + *.h \ + *.hh \ + *.hxx \ + *.hpp \ + *.h++ \ + *.cs \ + *.d \ + *.php \ + *.php4 \ + *.php5 \ + *.phtml \ + *.inc \ + *.m \ + *.markdown \ + *.md \ + *.mm \ + *.dox \ + *.py \ + *.pyw \ + *.f90 \ + *.f95 \ + *.f03 \ + *.f08 \ + *.f \ + *.for \ + *.tcl \ + *.vhd \ + *.vhdl \ + *.ucf \ + *.qsf \ + *.ice + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = * + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = .\..\ + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = YES + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# entity all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see https://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the +# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the +# cost of reduced performance. This can be particularly helpful with template +# rich C++ code for which doxygen's built-in parser lacks the necessary type +# information. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse_libclang=ON option for CMake. +# The default value is: NO. + +CLANG_ASSISTED_PARSING = NO + +# If clang assisted parsing is enabled you can provide the compiler with command +# line options that you would normally use when invoking the compiler. Note that +# the include paths will already be set by doxygen for the files and directories +# specified with INPUT and INCLUDE_PATH. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_OPTIONS = + +# If clang assisted parsing is enabled you can provide the clang parser with the +# path to the compilation database (see: +# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) used when the files +# were built. This is equivalent to specifying the "-p" option to a clang tool, +# such as clang-check. These options will then be passed to the parser. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse_libclang=ON option for CMake. + +CLANG_DATABASE_PATH = + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = . + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# https://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to YES can help to show when doxygen was last run and thus if the +# documentation is up to date. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = NO + +# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML +# documentation will contain a main index with vertical navigation menus that +# are dynamically created via Javascript. If disabled, the navigation index will +# consists of multiple levels of tabs that are statically embedded in every HTML +# page. Disable this option to support browsers that do not have Javascript, +# like the Qt help browser. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_MENUS = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: https://developer.apple.com/xcode/), introduced with OSX +# 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy +# genXcode/_index.html for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the master .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = YES + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANSPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# https://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from https://www.mathjax.org before deployment. +# The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/ + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /