Brewery/gravitymon
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update documentation

Browse Source
This commit is contained in:
GitHub Action 2022-01-08 15:37:55 +00:00
parent 935fec3237
commit 738879740e
39 changed files with 32256 additions and 20796 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/_images/perf1.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 85 KiB

30
docs/_sources/backlog.rst.txt
View File

@ -1,15 +1,15 @@
Backlog of changes Backlog of changes
################## ##################
Documentation Documentation
------------- -------------
- Write contribution instructions - Write contribution instructions
Code Code
------------- -------------
- Support for MQTT - Support for MQTT
- Support for plato - Support for plato
- Use pre-commit for validating check-in - Use pre-commit for validating check-in
- Automatic builds via github actions - Automatic builds via github actions

208
docs/_sources/compiling.rst.txt
View File

@ -1,104 +1,104 @@
Compiling the software Compiling the software
----------------------- -----------------------
Tools Tools
===== =====
I use the following tools in order to build and manage the software: I use the following tools in order to build and manage the software:
* Visual Studio Code * Visual Studio Code
* PlatformIO * PlatformIO
* Git for Windows * Git for Windows
* VSCode plugin: Minify (used to minimise the html files) * VSCode plugin: Minify (used to minimise the html files)
Code Formatting Code Formatting
=============== ===============
I use pre-commit and their cpp style checks to validate the code. Plugin defintions are found in **.pre-commit-config.yaml** I use pre-commit and their cpp style checks to validate the code. Plugin defintions are found in **.pre-commit-config.yaml**
https://www.pre-commit.com https://www.pre-commit.com
.. note:: .. note::
There is not yet any automatic checks since this does not work on Windows. It works if running under WSL2 with Ubuntu. There is not yet any automatic checks since this does not work on Windows. It works if running under WSL2 with Ubuntu.
Targets Targets
======= =======
In the repository there are 3 targets defined In the repository there are 3 targets defined
* gravity-debug; Maximum logging for trouble shooting, deep sleep is disabled. * gravity-debug; Maximum logging for trouble shooting, deep sleep is disabled.
* gravity-release; Standard release * gravity-release; Standard release
* gravity-perf; Standard release but contains code for measuring performance * gravity-perf; Standard release but contains code for measuring performance
Source structure Source structure
================ ================
.. list-table:: Directory structure .. list-table:: Directory structure
:widths: 40 60 :widths: 40 60
:header-rows: 1 :header-rows: 1
* - path * - path
- content - content
* - /bin * - /bin
- Contains compiled binaries - Contains compiled binaries
* - /data * - /data
- Directory for flashing device filesystem - Directory for flashing device filesystem
* - /doc * - /doc
- Various external documents used as input - Various external documents used as input
* - /docs * - /docs
- Folder published to github pages - Folder published to github pages
* - /html * - /html
- Source for html files - Source for html files
* - /img * - /img
- Images uses in README.md - Images uses in README.md
* - /lib * - /lib
- External libraries used when compiling - External libraries used when compiling
* - /script * - /script
- Scripts used in build process - Scripts used in build process
* - /src * - /src
- Source code for software - Source code for software
* - /src_docs * - /src_docs
- Source code for documentation - Source code for documentation
* - /stl * - /stl
- 3d models - 3d models
* - /test * - /test
- Test data for developing html files - Test data for developing html files
Options Options
======= =======
This is a list of C++ defines that is used to enable/disable functions in the code. This is a list of C++ defines that is used to enable/disable functions in the code.
.. list-table:: Defines .. list-table:: Defines
:widths: 40 60 :widths: 40 60
:header-rows: 1 :header-rows: 1
* - define * - define
- description - description
* - ACTIVATE_OTA * - ACTIVATE_OTA
- Enables the OTA functionallity in the code - Enables the OTA functionallity in the code
* - USE_GYRO_TEMP * - USE_GYRO_TEMP
- Uses temperature from gyro instead of DS18B20 (experimental) - Uses temperature from gyro instead of DS18B20 (experimental)
* - SKIP_SLEEPMODE * - SKIP_SLEEPMODE
- THe device never goes into sleep mode, useful when developing. - THe device never goes into sleep mode, useful when developing.
* - CFG_DISABLE_LOGGING * - CFG_DISABLE_LOGGING
- Done include verbose logging in Config class. Excessive logging may crash device. - Done include verbose logging in Config class. Excessive logging may crash device.
* - GYRO_DISABLE_LOGGING * - GYRO_DISABLE_LOGGING
- Done include verbose logging in Gyro class. Excessive logging may crash device. - Done include verbose logging in Gyro class. Excessive logging may crash device.
* - PUSH_DISABLE_LOGGING * - PUSH_DISABLE_LOGGING
- Done include verbose logging in PushTarget class. Excessive logging may crash device. - Done include verbose logging in PushTarget class. Excessive logging may crash device.
* - TSEN_DISABLE_LOGGING * - TSEN_DISABLE_LOGGING
- Done include verbose logging in TempSensor class. Excessive logging may crash device. - Done include verbose logging in TempSensor class. Excessive logging may crash device.
* - WEB_DISABLE_LOGGING * - WEB_DISABLE_LOGGING
- Done include verbose logging in WebServer class. Excessive logging may crash device. - Done include verbose logging in WebServer class. Excessive logging may crash device.
* - MAIN_DISABLE_LOGGING * - MAIN_DISABLE_LOGGING
- Done include verbose logging in Main class. Excessive logging may crash device. - Done include verbose logging in Main class. Excessive logging may crash device.
* - USE_LITTLEFS * - USE_LITTLEFS
- Use the new filesystem in Ardurino - Use the new filesystem in Ardurino
* - EMBED_HTML * - EMBED_HTML
- Html files are included in code, if not defined they are served from the file system. - Html files are included in code, if not defined they are served from the file system.
* - USER_SSID * - USER_SSID
- If defined the device will always use this SSID - If defined the device will always use this SSID
* - USER_SSID_PWD * - USER_SSID_PWD
- Password to the SSID - Password to the SSID
* - CFG_APPVER * - CFG_APPVER
- Defines the version of the compiled software - Defines the version of the compiled software

954
docs/_sources/configuration.rst.txt
View File

@ -1,477 +1,477 @@
Configuration Configuration
----------------------- -----------------------
The device can operate in two modes and must be in `configuration mode` in order for the web server to be active. The device can operate in two modes and must be in `configuration mode` in order for the web server to be active.
One of the following conditions will place the device in `configuration mode`: One of the following conditions will place the device in `configuration mode`:
- Gyro has not been calibrated - Gyro has not been calibrated
- Sleep mode has been disabled in the web interface - Sleep mode has been disabled in the web interface
- Placed in horizontal mode 85-90 degrees - Placed in horizontal mode 85-90 degrees
- Charger connected >4.15V - Charger connected >4.15V
Status Status
====== ======
URL: (http://gravmon.local) URL: (http://gravmon.local)
.. image:: images/index.png .. image:: images/index.png
:width: 800 :width: 800
:alt: Index page :alt: Index page
Configuration is accessed by entering the URL for the device, this will be the mDNS name *device.local* or the IP adress. The following chapter assumes the device name is *gravmon*. Configuration is accessed by entering the URL for the device, this will be the mDNS name *device.local* or the IP adress. The following chapter assumes the device name is *gravmon*.
The main page shows the device readings; gravity, angle, temperature and battery charge. If the checkbox is active then the device will never go into sleep mode. This is useful if The main page shows the device readings; gravity, angle, temperature and battery charge. If the checkbox is active then the device will never go into sleep mode. This is useful if
you are collecting angle/tilt for calibration. If this is unchecked the device will change mode as explained before. you are collecting angle/tilt for calibration. If this is unchecked the device will change mode as explained before.
.. note:: .. note::
If you are connected to the device via a serial console (speed: 115200) you can see the connection sequence and get the Unique ID and IP adress from there. If you are connected to the device via a serial console (speed: 115200) you can see the connection sequence and get the Unique ID and IP adress from there.
Device Device
====== ======
URL: (http://gravmon.local/device) URL: (http://gravmon.local/device)
.. image:: images/device.png .. image:: images/device.png
:width: 800 :width: 800
:alt: Device Settings :alt: Device Settings
* **Version:** * **Version:**
Installed version of the code and html files. Installed version of the code and html files.
* **Device name:** * **Device name:**
This is unique name of the device. This is unique name of the device.
* **Device ID:** * **Device ID:**
This is unique identifier for the device (ESP8266 id), this is required when using the API as an API Key to safeguard against faulty requests. This is unique identifier for the device (ESP8266 id), this is required when using the API as an API Key to safeguard against faulty requests.
Configuration Configuration
============= =============
URL: (http://gravmon.local/config) URL: (http://gravmon.local/config)
Device Setting Device Setting
************** **************
.. image:: images/config1.png .. image:: images/config1.png
:width: 800 :width: 800
:alt: Device Settings :alt: Device Settings
* **Device name:** * **Device name:**
This is unique name for the device. It will be used in pushing data as well as mDNS name on the network (<name>.local) This is unique name for the device. It will be used in pushing data as well as mDNS name on the network (<name>.local)
* **Temperature format:** * **Temperature format:**
Choose between Celsius and Farenheight Choose between Celsius and Farenheight
* **Interval:** * **Interval:**
This defines how long the device should be sleeping between the readings when in `gravity monitoring` mode. You will also see the values in minutes/seconds to easier set the interval. 900s is a recommended interval. This defines how long the device should be sleeping between the readings when in `gravity monitoring` mode. You will also see the values in minutes/seconds to easier set the interval. 900s is a recommended interval.
.. note:: .. note::
The sleep interval can be set between 10 - 3600 seconds (60 minutes). The sleep interval can be set between 10 - 3600 seconds (60 minutes).
* **Calibration values:** * **Calibration values:**
These are calibration data for the gyro. Place the device flat on a table and press the button to save the default orientation values. Without this calibration we cannot calculate the correct angle/tilt. These are calibration data for the gyro. Place the device flat on a table and press the button to save the default orientation values. Without this calibration we cannot calculate the correct angle/tilt.
.. note:: .. note::
The device will **not** go into `gravity monitoring` mode unless calibrated The device will **not** go into `gravity monitoring` mode unless calibrated
Push Settings Push Settings
************* *************
.. image:: images/config2.png .. image:: images/config2.png
:width: 800 :width: 800
:alt: Push Settings :alt: Push Settings
* **HTTP URL 1:** * **HTTP URL 1:**
Endpoint to send data via http. Format used is standard iSpindle format (see format section). Endpoint to send data via http. Format used is standard iSpindle format (see format section).
* **HTTP URL 2:** * **HTTP URL 2:**
Endpoint to send data via http. Format used is standard iSpindle format (see format section). Endpoint to send data via http. Format used is standard iSpindle format (see format section).
* **Brewfather URL:** * **Brewfather URL:**
Endpoint to send data via http to brewfather. Format used is defined by brewfather (see format section). Endpoint to send data via http to brewfather. Format used is defined by brewfather (see format section).
* **Influx DB v2 URL:** * **Influx DB v2 URL:**
Endpoint to send data via http to InfluxDB. For format (see format section). Endpoint to send data via http to InfluxDB. For format (see format section).
* **Influx DB v2 Organisation:** * **Influx DB v2 Organisation:**
Name of organisation in Influx. Name of organisation in Influx.
* **Influx DB v2 Bucket:** * **Influx DB v2 Bucket:**
Identifier for bucket. Identifier for bucket.
* **Influx DB v2 Token:** * **Influx DB v2 Token:**
Token with write access to bucket. Token with write access to bucket.
Gravity Settings Gravity Settings
**************** ****************
.. image:: images/config3.png .. image:: images/config3.png
:width: 800 :width: 800
:alt: Gravity Settings :alt: Gravity Settings
* **Gravity formula:** * **Gravity formula:**
Gravity formula is compatible with standard iSpindle formulas so any existing calculation option can be used. Is updated if the calibration function is used. Gravity formula is compatible with standard iSpindle formulas so any existing calculation option can be used. Is updated if the calibration function is used.
* **Temperature correct gravity:** * **Temperature correct gravity:**
Will apply a temperature calibration formula to the gravity as a second step. Will apply a temperature calibration formula to the gravity as a second step.
This is the formula used for temperature calibration (temp is in F). Cal = 20C. This is the formula used for temperature calibration (temp is in F). Cal = 20C.
.. code-block:: .. code-block::
gravity*((1.00130346-0.000134722124*temp+0.00000204052596*temp^2-0.00000000232820948*temp^3)/(1.00130346-0.000134722124*cal+0.00000204052596*cal^2-0.00000000232820948*cal^3)) gravity*((1.00130346-0.000134722124*temp+0.00000204052596*temp^2-0.00000000232820948*temp^3)/(1.00130346-0.000134722124*cal+0.00000204052596*cal^2-0.00000000232820948*cal^3))
Hardware Settings Hardware Settings
***************** *****************
.. image:: images/config4.png .. image:: images/config4.png
:width: 800 :width: 800
:alt: Hardware Settings :alt: Hardware Settings
* **Voltage factor:** * **Voltage factor:**
Factor used to calcualate the battery voltage. If you get a too low/high voltage you can adjust this value. Factor used to calcualate the battery voltage. If you get a too low/high voltage you can adjust this value.
* **Temperature correction:** * **Temperature correction:**
This value will be added to the temperature reading (negative value will reduce temperature reading). This value will be added to the temperature reading (negative value will reduce temperature reading).
* **OTA URL:** * **OTA URL:**
Should point to a URL where the .bin file + version.json file is located. Should point to a URL where the .bin file + version.json file is located.
For the OTA to work, place the following files (version.json + firmware.bin) at the location that you pointed out in OTA URL. If the version number in the json file is newer than in the For the OTA to work, place the following files (version.json + firmware.bin) at the location that you pointed out in OTA URL. If the version number in the json file is newer than in the
code the update will be done during startup. code the update will be done during startup.
Example; OTA URL (don't forget trailing dash), the name of the file should be firmware.bin Example; OTA URL (don't forget trailing dash), the name of the file should be firmware.bin
.. code-block:: .. code-block::
http://192.168.1.1/firmware/gravmon/ http://192.168.1.1/firmware/gravmon/
Create formula Create formula
============================= =============================
.. image:: images/formula1.png .. image:: images/formula1.png
:width: 800 :width: 800
:alt: Formula data :alt: Formula data
Here you can enter up to 5 values (angles + gravity) that is then used to create the formula. Angles equal to zero will be regarded as empty even if there is a gravity reading. Here you can enter up to 5 values (angles + gravity) that is then used to create the formula. Angles equal to zero will be regarded as empty even if there is a gravity reading.
.. image:: images/formula2.png .. image:: images/formula2.png
:width: 800 :width: 800
:alt: Formula graph :alt: Formula graph
Once the formula is created a graph over the entered values and a simulation of the formula will give you a nice overview on how the formula will work. Once the formula is created a graph over the entered values and a simulation of the formula will give you a nice overview on how the formula will work.
REST API REST API
============================= =============================
All the API's use a key called ``ID`` which is the unique device id (chip id). This is used as an API key when sending requests to the device. All the API's use a key called ``ID`` which is the unique device id (chip id). This is used as an API key when sending requests to the device.
GET: /api/config GET: /api/config
**************** ****************
Retrive the current configuation of the device via an HTTP GET command. Payload is in JSON format. Retrive the current configuation of the device via an HTTP GET command. Payload is in JSON format.
* ``temp-format`` can be either ``C`` or ``F`` * ``temp-format`` can be either ``C`` or ``F``
* ``gravity-format`` is always ``G`` (plato is not yet supported) * ``gravity-format`` is always ``G`` (plato is not yet supported)
Other parameters are the same as in the configuration guide. Other parameters are the same as in the configuration guide.
.. code-block:: json .. code-block:: json
{ {
"mdns": "gravmon", "mdns": "gravmon",
"id": "ee1bfc", "id": "ee1bfc",
"ota-url": "http://192.168.1.50:80/firmware/gravmon/", "ota-url": "http://192.168.1.50:80/firmware/gravmon/",
"temp-format": "C", "temp-format": "C",
"brewfather-push": "http://log.brewfather.net/stream?id=Qwerty", "brewfather-push": "http://log.brewfather.net/stream?id=Qwerty",
"http-push": "http://192.168.1.50:9090/api/v1/Qwerty/telemetry", "http-push": "http://192.168.1.50:9090/api/v1/Qwerty/telemetry",
"http-push2": "http://192.168.1.50/ispindel", "http-push2": "http://192.168.1.50/ispindel",
"influxdb2-push": "http://192.168.1.50:8086", "influxdb2-push": "http://192.168.1.50:8086",
"influxdb2-org": "Qwerty", "influxdb2-org": "Qwerty",
"influxdb2-bucket": "Qwerty", "influxdb2-bucket": "Qwerty",
"influxdb2-auth": "Qwerty", "influxdb2-auth": "Qwerty",
"sleep-interval": 30, "sleep-interval": 30,
"voltage-factor": 1.59, "voltage-factor": 1.59,
"gravity-formula": "0.0*tilt^3+0.0*tilt^2+0.0017978*tilt+0.9436", "gravity-formula": "0.0*tilt^3+0.0*tilt^2+0.0017978*tilt+0.9436",
"gravity-format": "G", "gravity-format": "G",
"temp-adjustment-value": 0, "temp-adjustment-value": 0,
"gravity-temp-adjustment": false, "gravity-temp-adjustment": false,
"gyro-calibration-data": { "gyro-calibration-data": {
"ax": -330, "ax": -330,
"ay": -2249, "ay": -2249,
"az": 1170, "az": 1170,
"gx": 99, "gx": 99,
"gy": -6, "gy": -6,
"gz": 4 "gz": 4
}, },
"angle": 90.93, "angle": 90.93,
"gravity": 1.105, "gravity": 1.105,
"battery": 0.04 "battery": 0.04
} }
GET: /api/device GET: /api/device
**************** ****************
Retrive the current device settings via an HTTP GET command. Payload is in JSON format. Retrive the current device settings via an HTTP GET command. Payload is in JSON format.
.. code-block:: json .. code-block:: json
{ {
"app-name": "GravityMon ", "app-name": "GravityMon ",
"app-ver": "0.0.0", "app-ver": "0.0.0",
"id": "ee1bfc", "id": "ee1bfc",
"mdns": "gravmon" "mdns": "gravmon"
} }
GET: /api/status GET: /api/status
**************** ****************
Retrive the current device status via an HTTP GET command. Payload is in JSON format. Retrive the current device status via an HTTP GET command. Payload is in JSON format.
* ``temp-format`` can be either ``C`` or ``F`` * ``temp-format`` can be either ``C`` or ``F``
Other parameters are the same as in the configuration guide. Other parameters are the same as in the configuration guide.
.. code-block:: json .. code-block:: json
{ {
"id": "ee1bfc", "id": "ee1bfc",
"angle": 89.86, "angle": 89.86,
"gravity": 1.1052, "gravity": 1.1052,
"gravity-tempcorr": 1.1031, "gravity-tempcorr": 1.1031,
"temp-c": 0, "temp-c": 0,
"temp-f": 32, "temp-f": 32,
"battery": 0, "battery": 0,
"temp-format": "C", "temp-format": "C",
"sleep-mode": false, "sleep-mode": false,
"rssi": -56 "rssi": -56
} }
GET: /api/config/formula GET: /api/config/formula
************************ ************************
Retrive the data used for formula calculation data via an HTTP GET command. Payload is in JSON format. Retrive the data used for formula calculation data via an HTTP GET command. Payload is in JSON format.
* ``a1``-``a4`` are the angles/tilt readings (up to 5 are currently supported) * ``a1``-``a4`` are the angles/tilt readings (up to 5 are currently supported)
* ``g1``-``g4`` are the corresponding gravity reaadings (in SG) * ``g1``-``g4`` are the corresponding gravity reaadings (in SG)
.. code-block:: json .. code-block:: json
{ {
"id": "ee1bfc", "id": "ee1bfc",
"a1": 22.4, "a1": 22.4,
"a2": 54.4, "a2": 54.4,
"a3": 58, "a3": 58,
"a4": 0, "a4": 0,
"a5": 0, "a5": 0,
"g1": 1.000, "g1": 1.000,
"g2": 1.053, "g2": 1.053,
"g3": 1.062, "g3": 1.062,
"g4": 1, "g4": 1,
"g5": 1 "g5": 1
"gravity-formula": "0.0*tilt^3+0.0*tilt^2+0.0017978*tilt+0.9436", "gravity-formula": "0.0*tilt^3+0.0*tilt^2+0.0017978*tilt+0.9436",
} }
POST: /api/config/device POST: /api/config/device
************************ ************************
Used to update device settings via an HTTP POST command. Payload is in JSON format. Used to update device settings via an HTTP POST command. Payload is in JSON format.
* ``temp-format`` can be either ``C`` or ``F`` * ``temp-format`` can be either ``C`` or ``F``
.. code-block:: json .. code-block:: json
{ {
"id": "ee1bfc", "id": "ee1bfc",
"mdns": "gravmon", "mdns": "gravmon",
"temp-format": "C", "temp-format": "C",
"sleep-interval": 30 "sleep-interval": 30
} }
POST: /api/config/push POST: /api/config/push
********************** **********************
Used to update push settings via an HTTP POST command. Payload is in JSON format. Used to update push settings via an HTTP POST command. Payload is in JSON format.
.. code-block:: json .. code-block:: json
{ {
"id": "ee1bfc", "id": "ee1bfc",
"http-push": "http://192.168.1.50/ispindel", "http-push": "http://192.168.1.50/ispindel",
"http-push2": "", "http-push2": "",
"brewfather-push": "", "brewfather-push": "",
"influxdb2-push": "http://192.168.1.50:8086", "influxdb2-push": "http://192.168.1.50:8086",
"influxdb2-org": "Qwerty", "influxdb2-org": "Qwerty",
"influxdb2-bucket": "Qwerty", "influxdb2-bucket": "Qwerty",
"influxdb2-auth": "Qwerty" "influxdb2-auth": "Qwerty"
} }
POST: /api/config/gravity POST: /api/config/gravity
************************* *************************
Used to update gravity settings via an HTTP POST command. Payload is in JSON format. Used to update gravity settings via an HTTP POST command. Payload is in JSON format.
* ``gravity-formula`` keywords ``temp`` and ``tilt`` are supported. * ``gravity-formula`` keywords ``temp`` and ``tilt`` are supported.
.. code-block:: json .. code-block:: json
{ {
"id": "ee1bfc", "id": "ee1bfc",
"gravity-formula": "0.0*tilt^3+0.0*tilt^2+0.0017978*tilt+0.9436", "gravity-formula": "0.0*tilt^3+0.0*tilt^2+0.0017978*tilt+0.9436",
"gravity-temp-adjustment": "off" "gravity-temp-adjustment": "off"
} }
POST: /api/config/gravity POST: /api/config/gravity
************************* *************************
Used to update hardware settings via an HTTP POST command. Payload is in JSON format. Used to update hardware settings via an HTTP POST command. Payload is in JSON format.
.. code-block:: json .. code-block:: json
{ {
"id": "ee1bfc", "id": "ee1bfc",
"voltage-factor": 1.59, "voltage-factor": 1.59,
"temp-adjustment": 0, "temp-adjustment": 0,
"ota-url": "http://192.168.1.50/firmware/gravmon/" "ota-url": "http://192.168.1.50/firmware/gravmon/"
} }
POST: /api/config/formula POST: /api/config/formula
************************* *************************
Used to update formula calculation data via an HTTP POST command. Payload is in JSON format. Used to update formula calculation data via an HTTP POST command. Payload is in JSON format.
* ``a1``-``a4`` are the angles/tilt readings (up to 5 are currently supported) * ``a1``-``a4`` are the angles/tilt readings (up to 5 are currently supported)
* ``g1``-``g4`` are the corresponding gravity reaadings (in SG) * ``g1``-``g4`` are the corresponding gravity reaadings (in SG)
.. code-block:: json .. code-block:: json
{ {
"id": "ee1bfc", "id": "ee1bfc",
"a1": 22.4, "a1": 22.4,
"a2": 54.4, "a2": 54.4,
"a3": 58, "a3": 58,
"a4": 0, "a4": 0,
"a5": 0, "a5": 0,
"g1": 1.000, "g1": 1.000,
"g2": 1.053, "g2": 1.053,
"g3": 1.062, "g3": 1.062,
"g4": 1, "g4": 1,
"g5": 1 "g5": 1
} }
Data Formats Data Formats
============================= =============================
iSpindle format iSpindle format
*************** ***************
This is the format used for standard http posts. This is the format used for standard http posts.
* ``corr-gravity`` is an extended parameter containing a temperature corrected gravity reading. * ``corr-gravity`` is an extended parameter containing a temperature corrected gravity reading.
* ``run-time`` is an extended parameter containing the number of seconds the execution took. * ``run-time`` is an extended parameter containing the number of seconds the execution took.
.. code-block:: json .. code-block:: json
{ {
"name" : "gravmon", "name" : "gravmon",
"ID": "2E6753", "ID": "2E6753",
"token" : "gravmon", "token" : "gravmon",
"interval": 900, "interval": 900,
"temperature": 20.5, "temperature": 20.5,
"temp-units": "C", "temp-units": "C",
"gravity": 1.0050, "gravity": 1.0050,
"corr-gravity": 1.0050, "corr-gravity": 1.0050,
"angle": 45.34, "angle": 45.34,
"battery": 3.67, "battery": 3.67,
"rssi": -12, "rssi": -12,
"run-time": 6 "run-time": 6
} }
Brewfather format Brewfather format
****************** ******************
This is the format for Brewfather This is the format for Brewfather
.. code-block:: json .. code-block:: json
{ {
"name" : "gravmon", "name" : "gravmon",
"temp": 20.5, "temp": 20.5,
"temp-unit": "C", "temp-unit": "C",
"battery": 3.67, "battery": 3.67,
"gravity": 1.0050, "gravity": 1.0050,
"gravity_unit": "G", "gravity_unit": "G",
} }
Influx DB v2 Influx DB v2
************ ************
This is the format for InfluxDB v2 This is the format for InfluxDB v2
.. code-block:: .. code-block::
measurement,host=<mdns>,device=<id>,temp-format=<C|F>,gravity-format=SG,gravity=1.0004,corr-gravity=1.0004,angle=45.45,temp=20.1,battery=3.96,rssi=-18 measurement,host=<mdns>,device=<id>,temp-format=<C|F>,gravity-format=SG,gravity=1.0004,corr-gravity=1.0004,angle=45.45,temp=20.1,battery=3.96,rssi=-18
version.json version.json
************ ************
Contents version.json. The version is used by the device to check if the this version is newer. The html files will also be downloaded if the are present on the server. This way it's easy to Contents version.json. The version is used by the device to check if the this version is newer. The html files will also be downloaded if the are present on the server. This way it's easy to
upgrade to a version that serve the html files from the file system. If they dont exist nothing will happen, the OTA flashing will still work. If the html files are missing from the file system upgrade to a version that serve the html files from the file system. If they dont exist nothing will happen, the OTA flashing will still work. If the html files are missing from the file system
they can be uploaded manually afterwards. they can be uploaded manually afterwards.
.. code-block:: json .. code-block:: json
{ {
"project":"gravmon", "project":"gravmon",
"version":"0.4.10", "version":"0.4.10",
"html": [ "html": [
"index.min.htm", "index.min.htm",
"device.min.htm", "device.min.htm",
"config.min.htm", "config.min.htm",
"calibration.min.htm", "calibration.min.htm",
"about.min.htm" "about.min.htm"
] ]
} }

10
docs/_sources/contributing.rst.txt
View File

@ -1,5 +1,5 @@
Contributing Contributing
------------ ------------
This section is under construction. This section is under construction.

164
docs/_sources/functionallity.rst.txt
View File

@ -1,75 +1,89 @@
Functionallity Functionallity
============== ==============
The main differences The main differences
-------------------- --------------------
* **Operates in two modes `gravity monitoring` and `configuration mode`** * **Operates in two modes `gravity monitoring` and `configuration mode`**
In gravity monitoring mode it behaves just like the iSpindle, it wakes up at regular intervals, measure angle/tile, temperature, calculates gravity and pushes the data to defined endpoints. In gravity monitoring mode it behaves just like the iSpindle, it wakes up at regular intervals, measure angle/tile, temperature, calculates gravity and pushes the data to defined endpoints.
In configuration mode the device is always active and the webserver is active. Here you can view the angle/tilt values, change configuration options and more. When in this mode you can also interact with the device In configuration mode the device is always active and the webserver is active. Here you can view the angle/tilt values, change configuration options and more. When in this mode you can also interact with the device
via an REST API so data can be pushed to the device via scripts (see API section for more information)- via an REST API so data can be pushed to the device via scripts (see API section for more information)-
*See the configuration section for more information on how to trigger the configuration mode.* *See the configuration section for more information on how to trigger the configuration mode.*
* **Can send data to multiple endpoints at once** * **Can send data to multiple endpoints at once**
The orignial iSpindle can only have one destination, this sofware will push data to all defined endpoints so in theory you can use them all. However this will consume a lot of battery power so use only as many as needed. The orignial iSpindle can only have one destination, this sofware will push data to all defined endpoints so in theory you can use them all. However this will consume a lot of battery power so use only as many as needed.
Currently the device supports the following endpoints: http (2 differnt), influxdb2 and Brewfather Currently the device supports the following endpoints: http (2 differnt), influxdb2 and Brewfather
If you want additional targets please raise a feature request in the github repo. If you want additional targets please raise a feature request in the github repo.
* **Build in function to create gravity formulas, so no need for using other tools for this part** * **Build in function to create gravity formulas, so no need for using other tools for this part**
Another big difference is that this software can create the gravity formula in the device, just enter the angle/gravity data that you have collected. You will also see a graph simulating how the formula would work. Another big difference is that this software can create the gravity formula in the device, just enter the angle/gravity data that you have collected. You will also see a graph simulating how the formula would work.
* **Automatic temperature adjustment of gravity reading** * **Automatic temperature adjustment of gravity reading**
If you want to correct gravity based on beer temperature you can do this in the formula but here is a nice feature that can correct the gravity as a second step making this independant of the formula. If you want to correct gravity based on beer temperature you can do this in the formula but here is a nice feature that can correct the gravity as a second step making this independant of the formula.
.. note:: .. note::
This feature needs more testing to be validated. This feature needs more testing to be validated.
* **OTA support from local webserver** * **OTA support from local webserver**
When starting up in configuration mode the device will check for a software update from a local webserver. When starting up in configuration mode the device will check for a software update from a local webserver.
* **DS18B20 temperature adjustments** * **DS18B20 temperature adjustments**
You can adjust the temperature reading of the temperature sensor. You can adjust the temperature reading of the temperature sensor.
* **Gyro Movement** * **Gyro Movement**
The software will detect if the gyro is moving and if this is the case it will go back to sleep for 60seconds. This way we should avoid faulty measurements. The software will detect if the gyro is moving and if this is the case it will go back to sleep for 60seconds. This way we should avoid faulty measurements.
Other features Other features
-------------- --------------
* Support for Celcius and Farenheigt as temperature formats. * Support for Celcius and Farenheigt as temperature formats.
* Support SG (Plato is not yet supported) * Support SG (Plato is not yet supported)
* Gyro data is read 50 times to ensure good accuracy * Gyro data is read 50 times to ensure good accuracy
Experimental features Experimental features
--------------------- ---------------------
* Use the temperature sensor in the gyro instead of DS18B20 * Use the temperature sensor in the gyro instead of DS18B20
This works fine when the device has time to cool down between measurements and it saves a few milliseconds (reduced battery consumption). My testing shows that this is quite accurate. This works fine when the device has time to cool down between measurements and it saves a few milliseconds (reduced battery consumption). My testing shows that this is quite accurate.
There is lots of battery power to save, reading the temp sensor takes almost as long as the gyro. This could reduce the run time by 40-50% and probly extend battery life with the same. There is lots of battery power to save, reading the temp sensor takes almost as long as the gyro. This could reduce the run time by 40-50% and probly extend battery life with the same.
However more testing is required. Might add this as an option in the UI. However more testing is required. Might add this as an option in the UI.
.. note:: .. note::
This is not enabled by default. This is not enabled by default.
* Performance measurements * Performance measurements
I've also create a small library to measure execution code in some areas of the code that i know is time consuming. This way I can find a good balance between performace and quality. I've also create a small library to measure execution code in some areas of the code that i know is time consuming. This way I can find a good balance between performace and quality.
*See the compile section for more information.* *See the compile section for more information.*
Typical performance
-------------------
Since I have the possibility to measaure the performance of different function in the code this is what I have been able to gather.
The typical runtime in a measurement cycle is approx 2 seconds and in some cases it can take up to 6-8 seconds but this is mainly related to establishing the WIFI connection. So stable wifi is
essential for long batterylife. Out of the 2 seconds of run-time the major time is spent on gyro readings (1.3s) and temperature measurements of (0.6s) so using the gyro sensor for measureing
temperature would reduce the total runtime with 25%. Sending data over http takes less than 100ms (on my local network) so this is not drawing much power.
The image below shows how the run-time varies over time. The pink line is the wifi connection time and this is why the time varies.
.. image:: images/perf1.png
:width: 800
:alt: Performance view

242
docs/_sources/index.rst.txt
View File

@ -1,121 +1,121 @@
.. GravityMon documentation master file, created by .. GravityMon documentation master file, created by
sphinx-quickstart on Wed Jan 5 22:46:42 2022. sphinx-quickstart on Wed Jan 5 22:46:42 2022.
You can adapt this file completely to your liking, but it should at least You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive. contain the root `toctree` directive.
Welcome to GravityMon's documentation! Welcome to GravityMon's documentation!
###################################### ######################################
.. note:: .. note::
Preliminary documentation. This is work in progress. This documentation reflects **v0.5** Preliminary documentation. This is work in progress. This documentation reflects **v0.5**
GravityMon is a replacement firmare for the iSpindle hardware. It's used to measure gravity in beer and show the progress GravityMon is a replacement firmare for the iSpindle hardware. It's used to measure gravity in beer and show the progress
of fermentation. of fermentation.
For more information on this topic and function please visit https://www.ispindel.de. For more information on this topic and function please visit https://www.ispindel.de.
I started GravityMon because i like to create software and wanted to do some low level programming. I had done a few I started GravityMon because i like to create software and wanted to do some low level programming. I had done a few
projects based on esp8266 and also started to brew beer so this combination was quite natural. projects based on esp8266 and also started to brew beer so this combination was quite natural.
The hardware design comes from the fantastic iSpindle project so that is not covered in this documentation. The hardware design comes from the fantastic iSpindle project so that is not covered in this documentation.
My approach to this software is a little different from that the original ispindle firmware. The github repository can My approach to this software is a little different from that the original ispindle firmware. The github repository can
be found here; https://github.com/mp-se/gravitymon be found here; https://github.com/mp-se/gravitymon
.. note:: .. note::
This software is in the early stages even though its more than one year old so if you find issues, please This software is in the early stages even though its more than one year old so if you find issues, please
open a ticket on github. open a ticket on github.
I dont take responsibility for any errors that can cause problems with the use. I have tested v0.4 on 5+ brews I dont take responsibility for any errors that can cause problems with the use. I have tested v0.4 on 5+ brews
over the last 6 months without any issues. over the last 6 months without any issues.
The main differences: The main differences:
--------------------- ---------------------
* Operates in two modes `gravity monitoring` and `configuration mode` * Operates in two modes `gravity monitoring` and `configuration mode`
* Send data to multiple endpoints when pushing data. * Send data to multiple endpoints when pushing data.
* Automatic temperature adjustment of gravity reading * Automatic temperature adjustment of gravity reading
* OTA support from local webserver * OTA support from local webserver
* Build in function to create gravity formulas (*New in v0.5*) * Build in function to create gravity formulas (*New in v0.5*)
There are also a experimental features such as: There are also a experimental features such as:
* Using the temperature sensor in gyro instead of DS18B20 (faster) * Using the temperature sensor in gyro instead of DS18B20 (faster)
* Performance measurements (used to optimise code) * Performance measurements (used to optimise code)
**For a complete breakdown see the functionallity section.** **For a complete breakdown see the functionallity section.**
Credits to Credits to
---------- ----------
This software uses the following libraries and without these this would have been much more difficult to acheive: This software uses the following libraries and without these this would have been much more difficult to acheive:
* https://github.com/jrowberg/i2cdevlib.git * https://github.com/jrowberg/i2cdevlib.git
This library contains the basic code to interact with the gyro + many more chips. This library contains the basic code to interact with the gyro + many more chips.
* https://github.com/codeplea/tinyexpr * https://github.com/codeplea/tinyexpr
Proccess the gravity formula and calculate the gravity and various corrections. Proccess the gravity formula and calculate the gravity and various corrections.
* https://github.com/graphitemaster/incbin * https://github.com/graphitemaster/incbin
Include binary files into the code, used to service html files. Include binary files into the code, used to service html files.
* https://github.com/khoih-prog/ESP_DoubleResetDetector * https://github.com/khoih-prog/ESP_DoubleResetDetector
Can detect if the reset button is pressed twice, is used to enter WIFI config mode. Can detect if the reset button is pressed twice, is used to enter WIFI config mode.
* https://github.com/tzapu/WiFiManager * https://github.com/tzapu/WiFiManager
Configure wifi settings. Configure wifi settings.
* https://github.com/thijse/Arduino-Log * https://github.com/thijse/Arduino-Log
Logging library for handling different loglevels and configure what sent over the serial. Logging library for handling different loglevels and configure what sent over the serial.
* https://github.com/bblanchon/ArduinoJson * https://github.com/bblanchon/ArduinoJson
Json parser/creator used in configuration files and API's Json parser/creator used in configuration files and API's
* https://github.com/PaulStoffregen/OneWire * https://github.com/PaulStoffregen/OneWire
Communication library used for interacting with temperature sensor. Communication library used for interacting with temperature sensor.
* https://github.com/milesburton/Arduino-Temperature-Control-Library * https://github.com/milesburton/Arduino-Temperature-Control-Library
Interaction with the DS18B20 sensor Interaction with the DS18B20 sensor
* https://github.com/Rotario/arduinoCurveFitting * https://github.com/Rotario/arduinoCurveFitting
Create the gravity formula. Create the gravity formula.
* https://graphjs.com/ * https://graphjs.com/
Render the graphs in the UI. Render the graphs in the UI.
* https://getbootstrap.com/ * https://getbootstrap.com/
CSS templates for the web page. CSS templates for the web page.
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
:caption: Contents: :caption: Contents:
releases releases
functionallity functionallity
installation installation
configuration configuration
compiling compiling
contributing contributing
backlog backlog
Indices and tables Indices and tables
================== ==================
* :ref:`genindex` * :ref:`genindex`
* :ref:`modindex` * :ref:`modindex`
* :ref:`search` * :ref:`search`

90
docs/_sources/installation.rst.txt
View File

@ -1,45 +1,45 @@
Installation Installation
------------ ------------
Official esptool Official esptool
================ ================
The prefered option for flashing esp8266 device is via the official esptool. Documentation can be found The prefered option for flashing esp8266 device is via the official esptool. Documentation can be found
here; https://docs.espressif.com/projects/esptool/en/latest/esp32/ here; https://docs.espressif.com/projects/esptool/en/latest/esp32/
The basic command for flashing on Windows is; The basic command for flashing on Windows is;
``esptool.py --port COM4 write_flash 0x0 firmware.bin`` ``esptool.py --port COM4 write_flash 0x0 firmware.bin``
In the /bin directory you will find 3 different firmware builds; In the /bin directory you will find 3 different firmware builds;
* **firmware.bin** * **firmware.bin**
This is the standard release build (prefered version) This is the standard release build (prefered version)
* **firmware-perf.bin** * **firmware-perf.bin**
This version also submits performance data to an influx database with detailed execution times. This version also submits performance data to an influx database with detailed execution times.
* **firmware-debug.bin** * **firmware-debug.bin**
Development build. Not recommended for normal use. Development build. Not recommended for normal use.
In these versions all the html files are embedded in the binaries. The file system is currently only used for storing In these versions all the html files are embedded in the binaries. The file system is currently only used for storing
the configuration file. the configuration file.
If the software becomes so large the html files can be moved to the file system, but this is not enabled by If the software becomes so large the html files can be moved to the file system, but this is not enabled by
default (see compiling for details). This approach makes installation much easier and ensure that html files default (see compiling for details). This approach makes installation much easier and ensure that html files
and code is in sync. and code is in sync.
Configuring WIFI Configuring WIFI
================ ================
When the device is flashed it will need to have WIFI configuration in order to work. If you have used other software on When the device is flashed it will need to have WIFI configuration in order to work. If you have used other software on
the device its possible that wifi settings exist. the device its possible that wifi settings exist.
If this is not configured in the device it will create an wirless access point called `GravMon`. Connect to this AP and If this is not configured in the device it will create an wirless access point called `GravMon`. Connect to this AP and
enter the SSID and password you want to use. If the web page dont open automatically you can enter the following adress enter the SSID and password you want to use. If the web page dont open automatically you can enter the following adress
in the browser: **http://192.168.4.1** in the browser: **http://192.168.4.1**

44
docs/_sources/releases.rst.txt
View File

@ -1,22 +1,22 @@
Releases Releases
======== ========
v0.5.0 (beta) v0.5.0 (beta)
------------- -------------
Latest next target version is: **v0.5.0**. This is hosted in the **dev branch**. Latest next target version is: **v0.5.0**. This is hosted in the **dev branch**.
* Added feature to calcuate formula on device * Added feature to calcuate formula on device
* Total rewrite of documentation * Total rewrite of documentation
* WIFI settings are now stored in config file * WIFI settings are now stored in config file
* Defined version numbers for all dependant libraries to avoid updates breaking build. * Defined version numbers for all dependant libraries to avoid updates breaking build.
* Cleanup of code * Cleanup of code
* Refactor code from C to C++ * Refactor code from C to C++
v0.4.0 v0.4.0
------ ------
Latest stable development version is: **v0.4.0** Latest stable development version is: **v0.4.0**
https://github.com/mp-se/gravitymon/releases/tag/v0.4.0 https://github.com/mp-se/gravitymon/releases/tag/v0.4.0

116
docs/_sources/styling.rst.txt
View File

@ -1,58 +1,58 @@
Testing formatting Testing formatting
------------------ ------------------
Header 1 Header 1
######## ########
Header 2 Header 2
-------- --------
Header 3 Header 3
******** ********
**BOLD** **BOLD**
*ITALIC* *ITALIC*
``CODE SAMPLE`` ``CODE SAMPLE``
1. List 1. List
2. List 2. List
* List * List
* List * List
.. list-table:: Table .. list-table:: Table
:widths: 40 60 :widths: 40 60
:header-rows: 1 :header-rows: 1
* - table * - table
- table - table
* - content * - content
- content - content
.. image:: images/formula1.png .. image:: images/formula1.png
:width: 400 :width: 400
:alt: image :alt: image
.. code-block:: objdump .. code-block:: objdump
measurement,host=<mdns>,device=<id>,temp-format=<C|F>,gravity-format=SG,gravity=1.0004,corr-gravity=1.0004,angle=45.45,temp=20.1,battery=3.96,rssi=-18 measurement,host=<mdns>,device=<id>,temp-format=<C|F>,gravity-format=SG,gravity=1.0004,corr-gravity=1.0004,angle=45.45,temp=20.1,battery=3.96,rssi=-18
.. code-block:: json .. code-block:: json
{ {
"project":"gravmon", "project":"gravmon",
"version":"0.4.10", "version":"0.4.10",
"html": [ "html": [
"index.min.htm", "index.min.htm",
"device.min.htm", "device.min.htm",
"config.min.htm", "config.min.htm",
"calibration.min.htm", "calibration.min.htm",
"about.min.htm" "about.min.htm"
] ]
} }
.. note:: .. note::
Note... Note...

1671
docs/_static/basic.css vendored
View File

File diff suppressed because it is too large Load Diff

5342
docs/_static/css/fonts/fontawesome-webfont.svg vendored
View File

File diff suppressed because it is too large Load Diff
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 437 KiB

After

Width:  |  Height:  |  Size: 434 KiB

6
docs/_static/css/theme.css vendored
View File

File diff suppressed because one or more lines are too long

638
docs/_static/doctools.js vendored
View File

@ -1,323 +1,315 @@
/* /*
* doctools.js * doctools.js
* ~~~~~~~~~~~ * ~~~~~~~~~~~
* *
* Sphinx JavaScript utilities for all documentation. * Sphinx JavaScript utilities for all documentation.
* *
* :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. * :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details. * :license: BSD, see LICENSE for details.
* *
*/ */
/** /**
* select a different prefix for underscore * select a different prefix for underscore
*/ */
$u = _.noConflict(); $u = _.noConflict();
/** /**
* make the code below compatible with browsers without * make the code below compatible with browsers without
* an installed firebug like debugger * an installed firebug like debugger
if (!window.console || !console.firebug) { if (!window.console || !console.firebug) {
var names = ["log", "debug", "info", "warn", "error", "assert", "dir", var names = ["log", "debug", "info", "warn", "error", "assert", "dir",
"dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace", "dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace",
"profile", "profileEnd"]; "profile", "profileEnd"];
window.console = {}; window.console = {};
for (var i = 0; i < names.length; ++i) for (var i = 0; i < names.length; ++i)
window.console[names[i]] = function() {}; window.console[names[i]] = function() {};
} }
*/ */
/** /**
* small helper function to urldecode strings * small helper function to urldecode strings
* */
* See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL jQuery.urldecode = function(x) {
*/ return decodeURIComponent(x).replace(/\+/g, ' ');
jQuery.urldecode = function(x) { };
if (!x) {
return x /**
} * small helper function to urlencode strings
return decodeURIComponent(x.replace(/\+/g, ' ')); */
}; jQuery.urlencode = encodeURIComponent;
/** /**
* small helper function to urlencode strings * This function returns the parsed url parameters of the
*/ * current request. Multiple values per key are supported,
jQuery.urlencode = encodeURIComponent; * it will always return arrays of strings for the value parts.
*/
/** jQuery.getQueryParameters = function(s) {
* This function returns the parsed url parameters of the if (typeof s === 'undefined')
* current request. Multiple values per key are supported, s = document.location.search;
* it will always return arrays of strings for the value parts. var parts = s.substr(s.indexOf('?') + 1).split('&');
*/ var result = {};
jQuery.getQueryParameters = function(s) { for (var i = 0; i < parts.length; i++) {
if (typeof s === 'undefined') var tmp = parts[i].split('=', 2);
s = document.location.search; var key = jQuery.urldecode(tmp[0]);
var parts = s.substr(s.indexOf('?') + 1).split('&'); var value = jQuery.urldecode(tmp[1]);
var result = {}; if (key in result)
for (var i = 0; i < parts.length; i++) { result[key].push(value);
var tmp = parts[i].split('=', 2); else
var key = jQuery.urldecode(tmp[0]); result[key] = [value];
var value = jQuery.urldecode(tmp[1]); }
if (key in result) return result;
result[key].push(value); };
else
result[key] = [value]; /**
} * highlight a given string on a jquery object by wrapping it in
return result; * span elements with the given class name.
}; */
jQuery.fn.highlightText = function(text, className) {
/** function highlight(node, addItems) {
* highlight a given string on a jquery object by wrapping it in if (node.nodeType === 3) {
* span elements with the given class name. var val = node.nodeValue;
*/ var pos = val.toLowerCase().indexOf(text);
jQuery.fn.highlightText = function(text, className) { if (pos >= 0 &&
function highlight(node, addItems) { !jQuery(node.parentNode).hasClass(className) &&
if (node.nodeType === 3) { !jQuery(node.parentNode).hasClass("nohighlight")) {
var val = node.nodeValue; var span;
var pos = val.toLowerCase().indexOf(text); var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
if (pos >= 0 && if (isInSVG) {
!jQuery(node.parentNode).hasClass(className) && span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
!jQuery(node.parentNode).hasClass("nohighlight")) { } else {
var span; span = document.createElement("span");
var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); span.className = className;
if (isInSVG) { }
span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); span.appendChild(document.createTextNode(val.substr(pos, text.length)));
} else { node.parentNode.insertBefore(span, node.parentNode.insertBefore(
span = document.createElement("span"); document.createTextNode(val.substr(pos + text.length)),
span.className = className; node.nextSibling));
} node.nodeValue = val.substr(0, pos);
span.appendChild(document.createTextNode(val.substr(pos, text.length))); if (isInSVG) {
node.parentNode.insertBefore(span, node.parentNode.insertBefore( var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
document.createTextNode(val.substr(pos + text.length)), var bbox = node.parentElement.getBBox();
node.nextSibling)); rect.x.baseVal.value = bbox.x;
node.nodeValue = val.substr(0, pos); rect.y.baseVal.value = bbox.y;
if (isInSVG) { rect.width.baseVal.value = bbox.width;
var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); rect.height.baseVal.value = bbox.height;
var bbox = node.parentElement.getBBox(); rect.setAttribute('class', className);
rect.x.baseVal.value = bbox.x; addItems.push({
rect.y.baseVal.value = bbox.y; "parent": node.parentNode,
rect.width.baseVal.value = bbox.width; "target": rect});
rect.height.baseVal.value = bbox.height; }
rect.setAttribute('class', className); }
addItems.push({ }
"parent": node.parentNode, else if (!jQuery(node).is("button, select, textarea")) {
"target": rect}); jQuery.each(node.childNodes, function() {
} highlight(this, addItems);
} });
} }
else if (!jQuery(node).is("button, select, textarea")) { }
jQuery.each(node.childNodes, function() { var addItems = [];
highlight(this, addItems); var result = this.each(function() {
}); highlight(this, addItems);
} });
} for (var i = 0; i < addItems.length; ++i) {
var addItems = []; jQuery(addItems[i].parent).before(addItems[i].target);
var result = this.each(function() { }
highlight(this, addItems); return result;
}); };
for (var i = 0; i < addItems.length; ++i) {
jQuery(addItems[i].parent).before(addItems[i].target); /*
} * backward compatibility for jQuery.browser
return result; * This will be supported until firefox bug is fixed.
}; */
if (!jQuery.browser) {
/* jQuery.uaMatch = function(ua) {
* backward compatibility for jQuery.browser ua = ua.toLowerCase();
* This will be supported until firefox bug is fixed.
*/ var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
if (!jQuery.browser) { /(webkit)[ \/]([\w.]+)/.exec(ua) ||
jQuery.uaMatch = function(ua) { /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
ua = ua.toLowerCase(); /(msie) ([\w.]+)/.exec(ua) ||
ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || [];
/(webkit)[ \/]([\w.]+)/.exec(ua) ||
/(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || return {
/(msie) ([\w.]+)/.exec(ua) || browser: match[ 1 ] || "",
ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || version: match[ 2 ] || "0"
[]; };
};
return { jQuery.browser = {};
browser: match[ 1 ] || "", jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
version: match[ 2 ] || "0" }
};
}; /**
jQuery.browser = {}; * Small JavaScript module for the documentation.
jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; */
} var Documentation = {
/** init : function() {
* Small JavaScript module for the documentation. this.fixFirefoxAnchorBug();
*/ this.highlightSearchWords();
var Documentation = { this.initIndexTable();
if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) {
init : function() { this.initOnKeyListeners();
this.fixFirefoxAnchorBug(); }
this.highlightSearchWords(); },
this.initIndexTable();
if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) { /**
this.initOnKeyListeners(); * i18n support
} */
}, TRANSLATIONS : {},
PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; },
/** LOCALE : 'unknown',
* i18n support
*/ // gettext and ngettext don't access this so that the functions
TRANSLATIONS : {}, // can safely bound to a different name (_ = Documentation.gettext)
PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; }, gettext : function(string) {
LOCALE : 'unknown', var translated = Documentation.TRANSLATIONS[string];
if (typeof translated === 'undefined')
// gettext and ngettext don't access this so that the functions return string;
// can safely bound to a different name (_ = Documentation.gettext) return (typeof translated === 'string') ? translated : translated[0];
gettext : function(string) { },
var translated = Documentation.TRANSLATIONS[string];
if (typeof translated === 'undefined') ngettext : function(singular, plural, n) {
return string; var translated = Documentation.TRANSLATIONS[singular];
return (typeof translated === 'string') ? translated : translated[0]; if (typeof translated === 'undefined')
}, return (n == 1) ? singular : plural;
return translated[Documentation.PLURALEXPR(n)];
ngettext : function(singular, plural, n) { },
var translated = Documentation.TRANSLATIONS[singular];
if (typeof translated === 'undefined') addTranslations : function(catalog) {
return (n == 1) ? singular : plural; for (var key in catalog.messages)
return translated[Documentation.PLURALEXPR(n)]; this.TRANSLATIONS[key] = catalog.messages[key];
}, this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')');
this.LOCALE = catalog.locale;
addTranslations : function(catalog) { },
for (var key in catalog.messages)
this.TRANSLATIONS[key] = catalog.messages[key]; /**
this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')'); * add context elements like header anchor links
this.LOCALE = catalog.locale; */
}, addContextElements : function() {
$('div[id] > :header:first').each(function() {
/** $('<a class="headerlink">\u00B6</a>').
* add context elements like header anchor links attr('href', '#' + this.id).
*/ attr('title', _('Permalink to this headline')).
addContextElements : function() { appendTo(this);
$('div[id] > :header:first').each(function() { });
$('<a class="headerlink">\u00B6</a>'). $('dt[id]').each(function() {
attr('href', '#' + this.id). $('<a class="headerlink">\u00B6</a>').
attr('title', _('Permalink to this headline')). attr('href', '#' + this.id).
appendTo(this); attr('title', _('Permalink to this definition')).
}); appendTo(this);
$('dt[id]').each(function() { });
$('<a class="headerlink">\u00B6</a>'). },
attr('href', '#' + this.id).
attr('title', _('Permalink to this definition')). /**
appendTo(this); * workaround a firefox stupidity
}); * see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075
}, */
fixFirefoxAnchorBug : function() {
/** if (document.location.hash && $.browser.mozilla)
* workaround a firefox stupidity window.setTimeout(function() {
* see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075 document.location.href += '';
*/ }, 10);
fixFirefoxAnchorBug : function() { },
if (document.location.hash && $.browser.mozilla)
window.setTimeout(function() { /**
document.location.href += ''; * highlight the search words provided in the url in the text
}, 10); */
}, highlightSearchWords : function() {
var params = $.getQueryParameters();
/** var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : [];
* highlight the search words provided in the url in the text if (terms.length) {
*/ var body = $('div.body');
highlightSearchWords : function() { if (!body.length) {
var params = $.getQueryParameters(); body = $('body');
var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : []; }
if (terms.length) { window.setTimeout(function() {
var body = $('div.body'); $.each(terms, function() {
if (!body.length) { body.highlightText(this.toLowerCase(), 'highlighted');
body = $('body'); });
} }, 10);
window.setTimeout(function() { $('<p class="highlight-link"><a href="javascript:Documentation.' +
$.each(terms, function() { 'hideSearchWords()">' + _('Hide Search Matches') + '</a></p>')
body.highlightText(this.toLowerCase(), 'highlighted'); .appendTo($('#searchbox'));
}); }
}, 10); },
$('<p class="highlight-link"><a href="javascript:Documentation.' +
'hideSearchWords()">' + _('Hide Search Matches') + '</a></p>') /**
.appendTo($('#searchbox')); * init the domain index toggle buttons
} */
}, initIndexTable : function() {
var togglers = $('img.toggler').click(function() {
/** var src = $(this).attr('src');
* init the domain index toggle buttons var idnum = $(this).attr('id').substr(7);
*/ $('tr.cg-' + idnum).toggle();
initIndexTable : function() { if (src.substr(-9) === 'minus.png')
var togglers = $('img.toggler').click(function() { $(this).attr('src', src.substr(0, src.length-9) + 'plus.png');
var src = $(this).attr('src'); else
var idnum = $(this).attr('id').substr(7); $(this).attr('src', src.substr(0, src.length-8) + 'minus.png');
$('tr.cg-' + idnum).toggle(); }).css('display', '');
if (src.substr(-9) === 'minus.png') if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) {
$(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); togglers.click();
else }
$(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); },
}).css('display', '');
if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { /**
togglers.click(); * helper function to hide the search marks again
} */
}, hideSearchWords : function() {
$('#searchbox .highlight-link').fadeOut(300);
/** $('span.highlighted').removeClass('highlighted');
* helper function to hide the search marks again },
*/
hideSearchWords : function() { /**
$('#searchbox .highlight-link').fadeOut(300); * make the url absolute
$('span.highlighted').removeClass('highlighted'); */
}, makeURL : function(relativeURL) {
return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL;
/** },
* make the url absolute
*/ /**
makeURL : function(relativeURL) { * get the current relative url
return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; */
}, getCurrentURL : function() {
var path = document.location.pathname;
/** var parts = path.split(/\//);
* get the current relative url $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() {
*/ if (this === '..')
getCurrentURL : function() { parts.pop();
var path = document.location.pathname; });
var parts = path.split(/\//); var url = parts.join('/');
$.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { return path.substring(url.lastIndexOf('/') + 1, path.length - 1);
if (this === '..') },
parts.pop();
}); initOnKeyListeners: function() {
var url = parts.join('/'); $(document).keydown(function(event) {
return path.substring(url.lastIndexOf('/') + 1, path.length - 1); var activeElementType = document.activeElement.tagName;
}, // don't navigate when in search box or textarea
if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT'
initOnKeyListeners: function() { && !event.altKey && !event.ctrlKey && !event.metaKey && !event.shiftKey) {
$(document).keydown(function(event) { switch (event.keyCode) {
var activeElementType = document.activeElement.tagName; case 37: // left
// don't navigate when in search box, textarea, dropdown or button var prevHref = $('link[rel="prev"]').prop('href');
if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT' if (prevHref) {
&& activeElementType !== 'BUTTON' && !event.altKey && !event.ctrlKey && !event.metaKey window.location.href = prevHref;
&& !event.shiftKey) { return false;
switch (event.keyCode) { }
case 37: // left case 39: // right
var prevHref = $('link[rel="prev"]').prop('href'); var nextHref = $('link[rel="next"]').prop('href');
if (prevHref) { if (nextHref) {
window.location.href = prevHref; window.location.href = nextHref;
return false; return false;
} }
break; }
case 39: // right }
var nextHref = $('link[rel="next"]').prop('href'); });
if (nextHref) { }
window.location.href = nextHref; };
return false;
} // quick alias for translations
break; _ = Documentation.gettext;
}
} $(document).ready(function() {
}); Documentation.init();
} });
};
// quick alias for translations
_ = Documentation.gettext;
$(document).ready(function() {
Documentation.init();
});

21
docs/_static/documentation_options.js vendored
View File

@ -1,12 +1,11 @@
var DOCUMENTATION_OPTIONS = { var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
VERSION: '0.5.0', VERSION: '0.5.0',
LANGUAGE: 'None', LANGUAGE: 'None',
COLLAPSE_INDEX: false, COLLAPSE_INDEX: false,
BUILDER: 'html', BUILDER: 'html',
FILE_SUFFIX: '.html', FILE_SUFFIX: '.html',
LINK_SUFFIX: '.html', HAS_SOURCE: true,
HAS_SOURCE: true, SOURCELINK_SUFFIX: '.txt',
SOURCELINK_SUFFIX: '.txt', NAVIGATION_WITH_KEYS: false
NAVIGATION_WITH_KEYS: false
}; };

10598
docs/_static/jquery-3.4.1.js vendored Normal file
View File

File diff suppressed because it is too large Load Diff

21744
docs/_static/jquery-3.5.1.js vendored
View File

File diff suppressed because it is too large Load Diff

4
docs/_static/jquery.js vendored
View File

File diff suppressed because one or more lines are too long

6
docs/_static/js/html5shiv-printshiv.min.js vendored
View File

@ -1,4 +1,4 @@
/** /**
* @preserve HTML5 Shiv 3.7.3-pre | @afarkas @jdalton @jon_neal @rem | MIT/GPL2 Licensed * @preserve HTML5 Shiv 3.7.3-pre | @afarkas @jdalton @jon_neal @rem | MIT/GPL2 Licensed
*/ */
!function(a,b){function c(a,b){var c=a.createElement("p"),d=a.getElementsByTagName("head")[0]||a.documentElement;return c.innerHTML="x<style>"+b+"</style>",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=y.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=y.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),y.elements=c+" "+a,j(b)}function f(a){var b=x[a[v]];return b||(b={},w++,a[v]=w,x[w]=b),b}function g(a,c,d){if(c||(c=b),q)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():u.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||t.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),q)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return y.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(y,b.frag)}function j(a){a||(a=b);var d=f(a);return!y.shivCSS||p||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),q||i(a,d),a}function k(a){for(var b,c=a.getElementsByTagName("*"),e=c.length,f=RegExp("^(?:"+d().join("|")+")$","i"),g=[];e--;)b=c[e],f.test(b.nodeName)&&g.push(b.applyElement(l(b)));return g}function l(a){for(var b,c=a.attributes,d=c.length,e=a.ownerDocument.createElement(A+":"+a.nodeName);d--;)b=c[d],b.specified&&e.setAttribute(b.nodeName,b.nodeValue);return e.style.cssText=a.style.cssText,e}function m(a){for(var b,c=a.split("{"),e=c.length,f=RegExp("(^|[\\s,>+~])("+d().join("|")+")(?=[[\\s,>+~#.:]|$)","gi"),g="$1"+A+"\\:$2";e--;)b=c[e]=c[e].split("}"),b[b.length-1]=b[b.length-1].replace(f,g),c[e]=b.join("}");return c.join("{")}function n(a){for(var b=a.length;b--;)a[b].removeNode()}function o(a){function b(){clearTimeout(g._removeSheetTimer),d&&d.removeNode(!0),d=null}var d,e,g=f(a),h=a.namespaces,i=a.parentWindow;return!B||a.printShived?a:("undefined"==typeof h[A]&&h.add(A),i.attachEvent("onbeforeprint",function(){b();for(var f,g,h,i=a.styleSheets,j=[],l=i.length,n=Array(l);l--;)n[l]=i[l];for(;h=n.pop();)if(!h.disabled&&z.test(h.media)){try{f=h.imports,g=f.length}catch(o){g=0}for(l=0;g>l;l++)n.push(f[l]);try{j.push(h.cssText)}catch(o){}}j=m(j.reverse().join("")),e=k(a),d=c(a,j)}),i.attachEvent("onafterprint",function(){n(e),clearTimeout(g._removeSheetTimer),g._removeSheetTimer=setTimeout(b,500)}),a.printShived=!0,a)}var p,q,r="3.7.3",s=a.html5||{},t=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,u=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,v="_html5shiv",w=0,x={};!function(){try{var a=b.createElement("a");a.innerHTML="<xyz></xyz>",p="hidden"in a,q=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){p=!0,q=!0}}();var y={elements:s.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:r,shivCSS:s.shivCSS!==!1,supportsUnknownElements:q,shivMethods:s.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=y,j(b);var z=/^$|\b(?:all|print)\b/,A="html5shiv",B=!q&&function(){var c=b.documentElement;return!("undefined"==typeof b.namespaces||"undefined"==typeof b.parentWindow||"undefined"==typeof c.applyElement||"undefined"==typeof c.removeNode||"undefined"==typeof a.attachEvent)}();y.type+=" print",y.shivPrint=o,o(b),"object"==typeof module&&module.exports&&(module.exports=y)}("undefined"!=typeof window?window:this,document); !function(a,b){function c(a,b){var c=a.createElement("p"),d=a.getElementsByTagName("head")[0]||a.documentElement;return c.innerHTML="x<style>"+b+"</style>",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=y.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=y.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),y.elements=c+" "+a,j(b)}function f(a){var b=x[a[v]];return b||(b={},w++,a[v]=w,x[w]=b),b}function g(a,c,d){if(c||(c=b),q)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():u.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||t.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),q)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return y.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(y,b.frag)}function j(a){a||(a=b);var d=f(a);return!y.shivCSS||p||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),q||i(a,d),a}function k(a){for(var b,c=a.getElementsByTagName("*"),e=c.length,f=RegExp("^(?:"+d().join("|")+")$","i"),g=[];e--;)b=c[e],f.test(b.nodeName)&&g.push(b.applyElement(l(b)));return g}function l(a){for(var b,c=a.attributes,d=c.length,e=a.ownerDocument.createElement(A+":"+a.nodeName);d--;)b=c[d],b.specified&&e.setAttribute(b.nodeName,b.nodeValue);return e.style.cssText=a.style.cssText,e}function m(a){for(var b,c=a.split("{"),e=c.length,f=RegExp("(^|[\\s,>+~])("+d().join("|")+")(?=[[\\s,>+~#.:]|$)","gi"),g="$1"+A+"\\:$2";e--;)b=c[e]=c[e].split("}"),b[b.length-1]=b[b.length-1].replace(f,g),c[e]=b.join("}");return c.join("{")}function n(a){for(var b=a.length;b--;)a[b].removeNode()}function o(a){function b(){clearTimeout(g._removeSheetTimer),d&&d.removeNode(!0),d=null}var d,e,g=f(a),h=a.namespaces,i=a.parentWindow;return!B||a.printShived?a:("undefined"==typeof h[A]&&h.add(A),i.attachEvent("onbeforeprint",function(){b();for(var f,g,h,i=a.styleSheets,j=[],l=i.length,n=Array(l);l--;)n[l]=i[l];for(;h=n.pop();)if(!h.disabled&&z.test(h.media)){try{f=h.imports,g=f.length}catch(o){g=0}for(l=0;g>l;l++)n.push(f[l]);try{j.push(h.cssText)}catch(o){}}j=m(j.reverse().join("")),e=k(a),d=c(a,j)}),i.attachEvent("onafterprint",function(){n(e),clearTimeout(g._removeSheetTimer),g._removeSheetTimer=setTimeout(b,500)}),a.printShived=!0,a)}var p,q,r="3.7.3",s=a.html5||{},t=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,u=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,v="_html5shiv",w=0,x={};!function(){try{var a=b.createElement("a");a.innerHTML="<xyz></xyz>",p="hidden"in a,q=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){p=!0,q=!0}}();var y={elements:s.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:r,shivCSS:s.shivCSS!==!1,supportsUnknownElements:q,shivMethods:s.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=y,j(b);var z=/^$|\b(?:all|print)\b/,A="html5shiv",B=!q&&function(){var c=b.documentElement;return!("undefined"==typeof b.namespaces||"undefined"==typeof b.parentWindow||"undefined"==typeof c.applyElement||"undefined"==typeof c.removeNode||"undefined"==typeof a.attachEvent)}();y.type+=" print",y.shivPrint=o,o(b),"object"==typeof module&&module.exports&&(module.exports=y)}("undefined"!=typeof window?window:this,document);

6
docs/_static/js/html5shiv.min.js vendored
View File

@ -1,4 +1,4 @@
/** /**
* @preserve HTML5 Shiv 3.7.3 | @afarkas @jdalton @jon_neal @rem | MIT/GPL2 Licensed * @preserve HTML5 Shiv 3.7.3 | @afarkas @jdalton @jon_neal @rem | MIT/GPL2 Licensed
*/ */
!function(a,b){function c(a,b){var c=a.createElement("p"),d=a.getElementsByTagName("head")[0]||a.documentElement;return c.innerHTML="x<style>"+b+"</style>",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=t.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=t.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),t.elements=c+" "+a,j(b)}function f(a){var b=s[a[q]];return b||(b={},r++,a[q]=r,s[r]=b),b}function g(a,c,d){if(c||(c=b),l)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():p.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||o.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),l)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return t.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(t,b.frag)}function j(a){a||(a=b);var d=f(a);return!t.shivCSS||k||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),l||i(a,d),a}var k,l,m="3.7.3-pre",n=a.html5||{},o=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,p=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,q="_html5shiv",r=0,s={};!function(){try{var a=b.createElement("a");a.innerHTML="<xyz></xyz>",k="hidden"in a,l=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){k=!0,l=!0}}();var t={elements:n.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:m,shivCSS:n.shivCSS!==!1,supportsUnknownElements:l,shivMethods:n.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=t,j(b),"object"==typeof module&&module.exports&&(module.exports=t)}("undefined"!=typeof window?window:this,document); !function(a,b){function c(a,b){var c=a.createElement("p"),d=a.getElementsByTagName("head")[0]||a.documentElement;return c.innerHTML="x<style>"+b+"</style>",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=t.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=t.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),t.elements=c+" "+a,j(b)}function f(a){var b=s[a[q]];return b||(b={},r++,a[q]=r,s[r]=b),b}function g(a,c,d){if(c||(c=b),l)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():p.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||o.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),l)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return t.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(t,b.frag)}function j(a){a||(a=b);var d=f(a);return!t.shivCSS||k||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),l||i(a,d),a}var k,l,m="3.7.3-pre",n=a.html5||{},o=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,p=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,q="_html5shiv",r=0,s={};!function(){try{var a=b.createElement("a");a.innerHTML="<xyz></xyz>",k="hidden"in a,l=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){k=!0,l=!0}}();var t={elements:n.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:m,shivCSS:n.shivCSS!==!1,supportsUnknownElements:l,shivMethods:n.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=t,j(b),"object"==typeof module&&module.exports&&(module.exports=t)}("undefined"!=typeof window?window:this,document);

594
docs/_static/language_data.js vendored
View File

@ -1,297 +1,297 @@
/* /*
* language_data.js * language_data.js
* ~~~~~~~~~~~~~~~~ * ~~~~~~~~~~~~~~~~
* *
* This script contains the language-specific data used by searchtools.js, * This script contains the language-specific data used by searchtools.js,
* namely the list of stopwords, stemmer, scorer and splitter. * namely the list of stopwords, stemmer, scorer and splitter.
* *
* :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. * :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details. * :license: BSD, see LICENSE for details.
* *
*/ */
var stopwords = ["a","and","are","as","at","be","but","by","for","if","in","into","is","it","near","no","not","of","on","or","such","that","the","their","then","there","these","they","this","to","was","will","with"]; var stopwords = ["a","and","are","as","at","be","but","by","for","if","in","into","is","it","near","no","not","of","on","or","such","that","the","their","then","there","these","they","this","to","was","will","with"];
/* Non-minified version is copied as a separate JS file, is available */ /* Non-minified version JS is _stemmer.js if file is provided */
/**
/** * Porter Stemmer
* Porter Stemmer */
*/ var Stemmer = function() {
var Stemmer = function() {
var step2list = {
var step2list = { ational: 'ate',
ational: 'ate', tional: 'tion',
tional: 'tion', enci: 'ence',
enci: 'ence', anci: 'ance',
anci: 'ance', izer: 'ize',
izer: 'ize', bli: 'ble',
bli: 'ble', alli: 'al',
alli: 'al', entli: 'ent',
entli: 'ent', eli: 'e',
eli: 'e', ousli: 'ous',
ousli: 'ous', ization: 'ize',
ization: 'ize', ation: 'ate',
ation: 'ate', ator: 'ate',
ator: 'ate', alism: 'al',
alism: 'al', iveness: 'ive',
iveness: 'ive', fulness: 'ful',
fulness: 'ful', ousness: 'ous',
ousness: 'ous', aliti: 'al',
aliti: 'al', iviti: 'ive',
iviti: 'ive', biliti: 'ble',
biliti: 'ble', logi: 'log'
logi: 'log' };
};
var step3list = {
var step3list = { icate: 'ic',
icate: 'ic', ative: '',
ative: '', alize: 'al',
alize: 'al', iciti: 'ic',
iciti: 'ic', ical: 'ic',
ical: 'ic', ful: '',
ful: '', ness: ''
ness: '' };
};
var c = "[^aeiou]"; // consonant
var c = "[^aeiou]"; // consonant var v = "[aeiouy]"; // vowel
var v = "[aeiouy]"; // vowel var C = c + "[^aeiouy]*"; // consonant sequence
var C = c + "[^aeiouy]*"; // consonant sequence var V = v + "[aeiou]*"; // vowel sequence
var V = v + "[aeiou]*"; // vowel sequence
var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0
var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0 var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1
var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1 var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1
var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1 var s_v = "^(" + C + ")?" + v; // vowel in stem
var s_v = "^(" + C + ")?" + v; // vowel in stem
this.stemWord = function (w) {
this.stemWord = function (w) { var stem;
var stem; var suffix;
var suffix; var firstch;
var firstch; var origword = w;
var origword = w;
if (w.length < 3)
if (w.length < 3) return w;
return w;
var re;
var re; var re2;
var re2; var re3;
var re3; var re4;
var re4;
firstch = w.substr(0,1);
firstch = w.substr(0,1); if (firstch == "y")
if (firstch == "y") w = firstch.toUpperCase() + w.substr(1);
w = firstch.toUpperCase() + w.substr(1);
// Step 1a
// Step 1a re = /^(.+?)(ss|i)es$/;
re = /^(.+?)(ss|i)es$/; re2 = /^(.+?)([^s])s$/;
re2 = /^(.+?)([^s])s$/;
if (re.test(w))
if (re.test(w)) w = w.replace(re,"$1$2");
w = w.replace(re,"$1$2"); else if (re2.test(w))
else if (re2.test(w)) w = w.replace(re2,"$1$2");
w = w.replace(re2,"$1$2");
// Step 1b
// Step 1b re = /^(.+?)eed$/;
re = /^(.+?)eed$/; re2 = /^(.+?)(ed|ing)$/;
re2 = /^(.+?)(ed|ing)$/; if (re.test(w)) {
if (re.test(w)) { var fp = re.exec(w);
var fp = re.exec(w); re = new RegExp(mgr0);
re = new RegExp(mgr0); if (re.test(fp[1])) {
if (re.test(fp[1])) { re = /.$/;
re = /.$/; w = w.replace(re,"");
w = w.replace(re,""); }
} }
} else if (re2.test(w)) {
else if (re2.test(w)) { var fp = re2.exec(w);
var fp = re2.exec(w); stem = fp[1];
stem = fp[1]; re2 = new RegExp(s_v);
re2 = new RegExp(s_v); if (re2.test(stem)) {
if (re2.test(stem)) { w = stem;
w = stem; re2 = /(at|bl|iz)$/;
re2 = /(at|bl|iz)$/; re3 = new RegExp("([^aeiouylsz])\\1$");
re3 = new RegExp("([^aeiouylsz])\\1$"); re4 = new RegExp("^" + C + v + "[^aeiouwxy]$");
re4 = new RegExp("^" + C + v + "[^aeiouwxy]$"); if (re2.test(w))
if (re2.test(w)) w = w + "e";
w = w + "e"; else if (re3.test(w)) {
else if (re3.test(w)) { re = /.$/;
re = /.$/; w = w.replace(re,"");
w = w.replace(re,""); }
} else if (re4.test(w))
else if (re4.test(w)) w = w + "e";
w = w + "e"; }
} }
}
// Step 1c
// Step 1c re = /^(.+?)y$/;
re = /^(.+?)y$/; if (re.test(w)) {
if (re.test(w)) { var fp = re.exec(w);
var fp = re.exec(w); stem = fp[1];
stem = fp[1]; re = new RegExp(s_v);
re = new RegExp(s_v); if (re.test(stem))
if (re.test(stem)) w = stem + "i";
w = stem + "i"; }
}
// Step 2
// Step 2 re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/;
re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; if (re.test(w)) {
if (re.test(w)) { var fp = re.exec(w);
var fp = re.exec(w); stem = fp[1];
stem = fp[1]; suffix = fp[2];
suffix = fp[2]; re = new RegExp(mgr0);
re = new RegExp(mgr0); if (re.test(stem))
if (re.test(stem)) w = stem + step2list[suffix];
w = stem + step2list[suffix]; }
}
// Step 3
// Step 3 re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/;
re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; if (re.test(w)) {
if (re.test(w)) { var fp = re.exec(w);
var fp = re.exec(w); stem = fp[1];
stem = fp[1]; suffix = fp[2];
suffix = fp[2]; re = new RegExp(mgr0);
re = new RegExp(mgr0); if (re.test(stem))
if (re.test(stem)) w = stem + step3list[suffix];
w = stem + step3list[suffix]; }
}
// Step 4
// Step 4 re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/;
re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; re2 = /^(.+?)(s|t)(ion)$/;
re2 = /^(.+?)(s|t)(ion)$/; if (re.test(w)) {
if (re.test(w)) { var fp = re.exec(w);
var fp = re.exec(w); stem = fp[1];
stem = fp[1]; re = new RegExp(mgr1);
re = new RegExp(mgr1); if (re.test(stem))
if (re.test(stem)) w = stem;
w = stem; }
} else if (re2.test(w)) {
else if (re2.test(w)) { var fp = re2.exec(w);
var fp = re2.exec(w); stem = fp[1] + fp[2];
stem = fp[1] + fp[2]; re2 = new RegExp(mgr1);
re2 = new RegExp(mgr1); if (re2.test(stem))
if (re2.test(stem)) w = stem;
w = stem; }
}
// Step 5
// Step 5 re = /^(.+?)e$/;
re = /^(.+?)e$/; if (re.test(w)) {
if (re.test(w)) { var fp = re.exec(w);
var fp = re.exec(w); stem = fp[1];
stem = fp[1]; re = new RegExp(mgr1);
re = new RegExp(mgr1); re2 = new RegExp(meq1);
re2 = new RegExp(meq1); re3 = new RegExp("^" + C + v + "[^aeiouwxy]$");
re3 = new RegExp("^" + C + v + "[^aeiouwxy]$"); if (re.test(stem) || (re2.test(stem) && !(re3.test(stem))))
if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) w = stem;
w = stem; }
} re = /ll$/;
re = /ll$/; re2 = new RegExp(mgr1);
re2 = new RegExp(mgr1); if (re.test(w) && re2.test(w)) {
if (re.test(w) && re2.test(w)) { re = /.$/;
re = /.$/; w = w.replace(re,"");
w = w.replace(re,""); }
}
// and turn initial Y back to y
// and turn initial Y back to y if (firstch == "y")
if (firstch == "y") w = firstch.toLowerCase() + w.substr(1);
w = firstch.toLowerCase() + w.substr(1); return w;
return w; }
} }
}
var splitChars = (function() { var splitChars = (function() {
var result = {}; var result = {};
var singles = [96, 180, 187, 191, 215, 247, 749, 885, 903, 907, 909, 930, 1014, 1648, var singles = [96, 180, 187, 191, 215, 247, 749, 885, 903, 907, 909, 930, 1014, 1648,
1748, 1809, 2416, 2473, 2481, 2526, 2601, 2609, 2612, 2615, 2653, 2702, 1748, 1809, 2416, 2473, 2481, 2526, 2601, 2609, 2612, 2615, 2653, 2702,
2706, 2729, 2737, 2740, 2857, 2865, 2868, 2910, 2928, 2948, 2961, 2971, 2706, 2729, 2737, 2740, 2857, 2865, 2868, 2910, 2928, 2948, 2961, 2971,
2973, 3085, 3089, 3113, 3124, 3213, 3217, 3241, 3252, 3295, 3341, 3345, 2973, 3085, 3089, 3113, 3124, 3213, 3217, 3241, 3252, 3295, 3341, 3345,
3369, 3506, 3516, 3633, 3715, 3721, 3736, 3744, 3748, 3750, 3756, 3761, 3369, 3506, 3516, 3633, 3715, 3721, 3736, 3744, 3748, 3750, 3756, 3761,
3781, 3912, 4239, 4347, 4681, 4695, 4697, 4745, 4785, 4799, 4801, 4823, 3781, 3912, 4239, 4347, 4681, 4695, 4697, 4745, 4785, 4799, 4801, 4823,
4881, 5760, 5901, 5997, 6313, 7405, 8024, 8026, 8028, 8030, 8117, 8125, 4881, 5760, 5901, 5997, 6313, 7405, 8024, 8026, 8028, 8030, 8117, 8125,
8133, 8181, 8468, 8485, 8487, 8489, 8494, 8527, 11311, 11359, 11687, 11695, 8133, 8181, 8468, 8485, 8487, 8489, 8494, 8527, 11311, 11359, 11687, 11695,
11703, 11711, 11719, 11727, 11735, 12448, 12539, 43010, 43014, 43019, 43587, 11703, 11711, 11719, 11727, 11735, 12448, 12539, 43010, 43014, 43019, 43587,
43696, 43713, 64286, 64297, 64311, 64317, 64319, 64322, 64325, 65141]; 43696, 43713, 64286, 64297, 64311, 64317, 64319, 64322, 64325, 65141];
var i, j, start, end; var i, j, start, end;
for (i = 0; i < singles.length; i++) { for (i = 0; i < singles.length; i++) {
result[singles[i]] = true; result[singles[i]] = true;
} }
var ranges = [[0, 47], [58, 64], [91, 94], [123, 169], [171, 177], [182, 184], [706, 709], var ranges = [[0, 47], [58, 64], [91, 94], [123, 169], [171, 177], [182, 184], [706, 709],
[722, 735], [741, 747], [751, 879], [888, 889], [894, 901], [1154, 1161], [722, 735], [741, 747], [751, 879], [888, 889], [894, 901], [1154, 1161],
[1318, 1328], [1367, 1368], [1370, 1376], [1416, 1487], [1515, 1519], [1523, 1568], [1318, 1328], [1367, 1368], [1370, 1376], [1416, 1487], [1515, 1519], [1523, 1568],
[1611, 1631], [1642, 1645], [1750, 1764], [1767, 1773], [1789, 1790], [1792, 1807], [1611, 1631], [1642, 1645], [1750, 1764], [1767, 1773], [1789, 1790], [1792, 1807],
[1840, 1868], [1958, 1968], [1970, 1983], [2027, 2035], [2038, 2041], [2043, 2047], [1840, 1868], [1958, 1968], [1970, 1983], [2027, 2035], [2038, 2041], [2043, 2047],
[2070, 2073], [2075, 2083], [2085, 2087], [2089, 2307], [2362, 2364], [2366, 2383], [2070, 2073], [2075, 2083], [2085, 2087], [2089, 2307], [2362, 2364], [2366, 2383],
[2385, 2391], [2402, 2405], [2419, 2424], [2432, 2436], [2445, 2446], [2449, 2450], [2385, 2391], [2402, 2405], [2419, 2424], [2432, 2436], [2445, 2446], [2449, 2450],
[2483, 2485], [2490, 2492], [2494, 2509], [2511, 2523], [2530, 2533], [2546, 2547], [2483, 2485], [2490, 2492], [2494, 2509], [2511, 2523], [2530, 2533], [2546, 2547],
[2554, 2564], [2571, 2574], [2577, 2578], [2618, 2648], [2655, 2661], [2672, 2673], [2554, 2564], [2571, 2574], [2577, 2578], [2618, 2648], [2655, 2661], [2672, 2673],
[2677, 2692], [2746, 2748], [2750, 2767], [2769, 2783], [2786, 2789], [2800, 2820], [2677, 2692], [2746, 2748], [2750, 2767], [2769, 2783], [2786, 2789], [2800, 2820],
[2829, 2830], [2833, 2834], [2874, 2876], [2878, 2907], [2914, 2917], [2930, 2946], [2829, 2830], [2833, 2834], [2874, 2876], [2878, 2907], [2914, 2917], [2930, 2946],
[2955, 2957], [2966, 2968], [2976, 2978], [2981, 2983], [2987, 2989], [3002, 3023], [2955, 2957], [2966, 2968], [2976, 2978], [2981, 2983], [2987, 2989], [3002, 3023],
[3025, 3045], [3059, 3076], [3130, 3132], [3134, 3159], [3162, 3167], [3170, 3173], [3025, 3045], [3059, 3076], [3130, 3132], [3134, 3159], [3162, 3167], [3170, 3173],
[3184, 3191], [3199, 3204], [3258, 3260], [3262, 3293], [3298, 3301], [3312, 3332], [3184, 3191], [3199, 3204], [3258, 3260], [3262, 3293], [3298, 3301], [3312, 3332],
[3386, 3388], [3390, 3423], [3426, 3429], [3446, 3449], [3456, 3460], [3479, 3481], [3386, 3388], [3390, 3423], [3426, 3429], [3446, 3449], [3456, 3460], [3479, 3481],
[3518, 3519], [3527, 3584], [3636, 3647], [3655, 3663], [3674, 3712], [3717, 3718], [3518, 3519], [3527, 3584], [3636, 3647], [3655, 3663], [3674, 3712], [3717, 3718],
[3723, 3724], [3726, 3731], [3752, 3753], [3764, 3772], [3774, 3775], [3783, 3791], [3723, 3724], [3726, 3731], [3752, 3753], [3764, 3772], [3774, 3775], [3783, 3791],
[3802, 3803], [3806, 3839], [3841, 3871], [3892, 3903], [3949, 3975], [3980, 4095], [3802, 3803], [3806, 3839], [3841, 3871], [3892, 3903], [3949, 3975], [3980, 4095],
[4139, 4158], [4170, 4175], [4182, 4185], [4190, 4192], [4194, 4196], [4199, 4205], [4139, 4158], [4170, 4175], [4182, 4185], [4190, 4192], [4194, 4196], [4199, 4205],
[4209, 4212], [4226, 4237], [4250, 4255], [4294, 4303], [4349, 4351], [4686, 4687], [4209, 4212], [4226, 4237], [4250, 4255], [4294, 4303], [4349, 4351], [4686, 4687],
[4702, 4703], [4750, 4751], [4790, 4791], [4806, 4807], [4886, 4887], [4955, 4968], [4702, 4703], [4750, 4751], [4790, 4791], [4806, 4807], [4886, 4887], [4955, 4968],
[4989, 4991], [5008, 5023], [5109, 5120], [5741, 5742], [5787, 5791], [5867, 5869], [4989, 4991], [5008, 5023], [5109, 5120], [5741, 5742], [5787, 5791], [5867, 5869],
[5873, 5887], [5906, 5919], [5938, 5951], [5970, 5983], [6001, 6015], [6068, 6102], [5873, 5887], [5906, 5919], [5938, 5951], [5970, 5983], [6001, 6015], [6068, 6102],
[6104, 6107], [6109, 6111], [6122, 6127], [6138, 6159], [6170, 6175], [6264, 6271], [6104, 6107], [6109, 6111], [6122, 6127], [6138, 6159], [6170, 6175], [6264, 6271],
[6315, 6319], [6390, 6399], [6429, 6469], [6510, 6511], [6517, 6527], [6572, 6592], [6315, 6319], [6390, 6399], [6429, 6469], [6510, 6511], [6517, 6527], [6572, 6592],
[6600, 6607], [6619, 6655], [6679, 6687], [6741, 6783], [6794, 6799], [6810, 6822], [6600, 6607], [6619, 6655], [6679, 6687], [6741, 6783], [6794, 6799], [6810, 6822],
[6824, 6916], [6964, 6980], [6988, 6991], [7002, 7042], [7073, 7085], [7098, 7167], [6824, 6916], [6964, 6980], [6988, 6991], [7002, 7042], [7073, 7085], [7098, 7167],
[7204, 7231], [7242, 7244], [7294, 7400], [7410, 7423], [7616, 7679], [7958, 7959], [7204, 7231], [7242, 7244], [7294, 7400], [7410, 7423], [7616, 7679], [7958, 7959],
[7966, 7967], [8006, 8007], [8014, 8015], [8062, 8063], [8127, 8129], [8141, 8143], [7966, 7967], [8006, 8007], [8014, 8015], [8062, 8063], [8127, 8129], [8141, 8143],
[8148, 8149], [8156, 8159], [8173, 8177], [8189, 8303], [8306, 8307], [8314, 8318], [8148, 8149], [8156, 8159], [8173, 8177], [8189, 8303], [8306, 8307], [8314, 8318],
[8330, 8335], [8341, 8449], [8451, 8454], [8456, 8457], [8470, 8472], [8478, 8483], [8330, 8335], [8341, 8449], [8451, 8454], [8456, 8457], [8470, 8472], [8478, 8483],
[8506, 8507], [8512, 8516], [8522, 8525], [8586, 9311], [9372, 9449], [9472, 10101], [8506, 8507], [8512, 8516], [8522, 8525], [8586, 9311], [9372, 9449], [9472, 10101],
[10132, 11263], [11493, 11498], [11503, 11516], [11518, 11519], [11558, 11567], [10132, 11263], [11493, 11498], [11503, 11516], [11518, 11519], [11558, 11567],
[11622, 11630], [11632, 11647], [11671, 11679], [11743, 11822], [11824, 12292], [11622, 11630], [11632, 11647], [11671, 11679], [11743, 11822], [11824, 12292],
[12296, 12320], [12330, 12336], [12342, 12343], [12349, 12352], [12439, 12444], [12296, 12320], [12330, 12336], [12342, 12343], [12349, 12352], [12439, 12444],
[12544, 12548], [12590, 12592], [12687, 12689], [12694, 12703], [12728, 12783], [12544, 12548], [12590, 12592], [12687, 12689], [12694, 12703], [12728, 12783],
[12800, 12831], [12842, 12880], [12896, 12927], [12938, 12976], [12992, 13311], [12800, 12831], [12842, 12880], [12896, 12927], [12938, 12976], [12992, 13311],
[19894, 19967], [40908, 40959], [42125, 42191], [42238, 42239], [42509, 42511], [19894, 19967], [40908, 40959], [42125, 42191], [42238, 42239], [42509, 42511],
[42540, 42559], [42592, 42593], [42607, 42622], [42648, 42655], [42736, 42774], [42540, 42559], [42592, 42593], [42607, 42622], [42648, 42655], [42736, 42774],
[42784, 42785], [42889, 42890], [42893, 43002], [43043, 43055], [43062, 43071], [42784, 42785], [42889, 42890], [42893, 43002], [43043, 43055], [43062, 43071],
[43124, 43137], [43188, 43215], [43226, 43249], [43256, 43258], [43260, 43263], [43124, 43137], [43188, 43215], [43226, 43249], [43256, 43258], [43260, 43263],
[43302, 43311], [43335, 43359], [43389, 43395], [43443, 43470], [43482, 43519], [43302, 43311], [43335, 43359], [43389, 43395], [43443, 43470], [43482, 43519],
[43561, 43583], [43596, 43599], [43610, 43615], [43639, 43641], [43643, 43647], [43561, 43583], [43596, 43599], [43610, 43615], [43639, 43641], [43643, 43647],
[43698, 43700], [43703, 43704], [43710, 43711], [43715, 43738], [43742, 43967], [43698, 43700], [43703, 43704], [43710, 43711], [43715, 43738], [43742, 43967],
[44003, 44015], [44026, 44031], [55204, 55215], [55239, 55242], [55292, 55295], [44003, 44015], [44026, 44031], [55204, 55215], [55239, 55242], [55292, 55295],
[57344, 63743], [64046, 64047], [64110, 64111], [64218, 64255], [64263, 64274], [57344, 63743], [64046, 64047], [64110, 64111], [64218, 64255], [64263, 64274],
[64280, 64284], [64434, 64466], [64830, 64847], [64912, 64913], [64968, 65007], [64280, 64284], [64434, 64466], [64830, 64847], [64912, 64913], [64968, 65007],
[65020, 65135], [65277, 65295], [65306, 65312], [65339, 65344], [65371, 65381], [65020, 65135], [65277, 65295], [65306, 65312], [65339, 65344], [65371, 65381],
[65471, 65473], [65480, 65481], [65488, 65489], [65496, 65497]]; [65471, 65473], [65480, 65481], [65488, 65489], [65496, 65497]];
for (i = 0; i < ranges.length; i++) { for (i = 0; i < ranges.length; i++) {
start = ranges[i][0]; start = ranges[i][0];
end = ranges[i][1]; end = ranges[i][1];
for (j = start; j <= end; j++) { for (j = start; j <= end; j++) {
result[j] = true; result[j] = true;
} }
} }
return result; return result;
})(); })();
function splitQuery(query) { function splitQuery(query) {
var result = []; var result = [];
var start = -1; var start = -1;
for (var i = 0; i < query.length; i++) { for (var i = 0; i < query.length; i++) {
if (splitChars[query.charCodeAt(i)]) { if (splitChars[query.charCodeAt(i)]) {
if (start !== -1) { if (start !== -1) {
result.push(query.slice(start, i)); result.push(query.slice(start, i));
start = -1; start = -1;
} }
} else if (start === -1) { } else if (start === -1) {
start = i; start = i;
} }
} }
if (start !== -1) { if (start !== -1) {
result.push(query.slice(start)); result.push(query.slice(start));
} }
return result; return result;
} }

141
docs/_static/pygments.css vendored
View File

@ -1,74 +1,69 @@
pre { line-height: 125%; } .highlight .hll { background-color: #ffffcc }
td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } .highlight { background: #f8f8f8; }
span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } .highlight .c { color: #408080; font-style: italic } /* Comment */
td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } .highlight .err { border: 1px solid #FF0000 } /* Error */
span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } .highlight .k { color: #008000; font-weight: bold } /* Keyword */
.highlight .hll { background-color: #ffffcc } .highlight .o { color: #666666 } /* Operator */
.highlight { background: #f8f8f8; } .highlight .ch { color: #408080; font-style: italic } /* Comment.Hashbang */
.highlight .c { color: #3D7B7B; font-style: italic } /* Comment */ .highlight .cm { color: #408080; font-style: italic } /* Comment.Multiline */
.highlight .err { border: 1px solid #FF0000 } /* Error */ .highlight .cp { color: #BC7A00 } /* Comment.Preproc */
.highlight .k { color: #008000; font-weight: bold } /* Keyword */ .highlight .cpf { color: #408080; font-style: italic } /* Comment.PreprocFile */
.highlight .o { color: #666666 } /* Operator */ .highlight .c1 { color: #408080; font-style: italic } /* Comment.Single */
.highlight .ch { color: #3D7B7B; font-style: italic } /* Comment.Hashbang */ .highlight .cs { color: #408080; font-style: italic } /* Comment.Special */
.highlight .cm { color: #3D7B7B; font-style: italic } /* Comment.Multiline */ .highlight .gd { color: #A00000 } /* Generic.Deleted */
.highlight .cp { color: #9C6500 } /* Comment.Preproc */ .highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .cpf { color: #3D7B7B; font-style: italic } /* Comment.PreprocFile */ .highlight .gr { color: #FF0000 } /* Generic.Error */
.highlight .c1 { color: #3D7B7B; font-style: italic } /* Comment.Single */ .highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
.highlight .cs { color: #3D7B7B; font-style: italic } /* Comment.Special */ .highlight .gi { color: #00A000 } /* Generic.Inserted */
.highlight .gd { color: #A00000 } /* Generic.Deleted */ .highlight .go { color: #888888 } /* Generic.Output */
.highlight .ge { font-style: italic } /* Generic.Emph */ .highlight .gp { color: #000080; font-weight: bold } /* Generic.Prompt */
.highlight .gr { color: #E40000 } /* Generic.Error */ .highlight .gs { font-weight: bold } /* Generic.Strong */
.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ .highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
.highlight .gi { color: #008400 } /* Generic.Inserted */ .highlight .gt { color: #0044DD } /* Generic.Traceback */
.highlight .go { color: #717171 } /* Generic.Output */ .highlight .kc { color: #008000; font-weight: bold } /* Keyword.Constant */
.highlight .gp { color: #000080; font-weight: bold } /* Generic.Prompt */ .highlight .kd { color: #008000; font-weight: bold } /* Keyword.Declaration */
.highlight .gs { font-weight: bold } /* Generic.Strong */ .highlight .kn { color: #008000; font-weight: bold } /* Keyword.Namespace */
.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ .highlight .kp { color: #008000 } /* Keyword.Pseudo */
.highlight .gt { color: #0044DD } /* Generic.Traceback */ .highlight .kr { color: #008000; font-weight: bold } /* Keyword.Reserved */
.highlight .kc { color: #008000; font-weight: bold } /* Keyword.Constant */ .highlight .kt { color: #B00040 } /* Keyword.Type */
.highlight .kd { color: #008000; font-weight: bold } /* Keyword.Declaration */ .highlight .m { color: #666666 } /* Literal.Number */
.highlight .kn { color: #008000; font-weight: bold } /* Keyword.Namespace */ .highlight .s { color: #BA2121 } /* Literal.String */
.highlight .kp { color: #008000 } /* Keyword.Pseudo */ .highlight .na { color: #7D9029 } /* Name.Attribute */
.highlight .kr { color: #008000; font-weight: bold } /* Keyword.Reserved */ .highlight .nb { color: #008000 } /* Name.Builtin */
.highlight .kt { color: #B00040 } /* Keyword.Type */ .highlight .nc { color: #0000FF; font-weight: bold } /* Name.Class */
.highlight .m { color: #666666 } /* Literal.Number */ .highlight .no { color: #880000 } /* Name.Constant */
.highlight .s { color: #BA2121 } /* Literal.String */ .highlight .nd { color: #AA22FF } /* Name.Decorator */
.highlight .na { color: #687822 } /* Name.Attribute */ .highlight .ni { color: #999999; font-weight: bold } /* Name.Entity */
.highlight .nb { color: #008000 } /* Name.Builtin */ .highlight .ne { color: #D2413A; font-weight: bold } /* Name.Exception */
.highlight .nc { color: #0000FF; font-weight: bold } /* Name.Class */ .highlight .nf { color: #0000FF } /* Name.Function */
.highlight .no { color: #880000 } /* Name.Constant */ .highlight .nl { color: #A0A000 } /* Name.Label */
.highlight .nd { color: #AA22FF } /* Name.Decorator */ .highlight .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */
.highlight .ni { color: #717171; font-weight: bold } /* Name.Entity */ .highlight .nt { color: #008000; font-weight: bold } /* Name.Tag */
.highlight .ne { color: #CB3F38; font-weight: bold } /* Name.Exception */ .highlight .nv { color: #19177C } /* Name.Variable */
.highlight .nf { color: #0000FF } /* Name.Function */ .highlight .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */
.highlight .nl { color: #767600 } /* Name.Label */ .highlight .w { color: #bbbbbb } /* Text.Whitespace */
.highlight .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */ .highlight .mb { color: #666666 } /* Literal.Number.Bin */
.highlight .nt { color: #008000; font-weight: bold } /* Name.Tag */ .highlight .mf { color: #666666 } /* Literal.Number.Float */
.highlight .nv { color: #19177C } /* Name.Variable */ .highlight .mh { color: #666666 } /* Literal.Number.Hex */
.highlight .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */ .highlight .mi { color: #666666 } /* Literal.Number.Integer */
.highlight .w { color: #bbbbbb } /* Text.Whitespace */ .highlight .mo { color: #666666 } /* Literal.Number.Oct */
.highlight .mb { color: #666666 } /* Literal.Number.Bin */ .highlight .sa { color: #BA2121 } /* Literal.String.Affix */
.highlight .mf { color: #666666 } /* Literal.Number.Float */ .highlight .sb { color: #BA2121 } /* Literal.String.Backtick */
.highlight .mh { color: #666666 } /* Literal.Number.Hex */ .highlight .sc { color: #BA2121 } /* Literal.String.Char */
.highlight .mi { color: #666666 } /* Literal.Number.Integer */ .highlight .dl { color: #BA2121 } /* Literal.String.Delimiter */
.highlight .mo { color: #666666 } /* Literal.Number.Oct */ .highlight .sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */
.highlight .sa { color: #BA2121 } /* Literal.String.Affix */ .highlight .s2 { color: #BA2121 } /* Literal.String.Double */
.highlight .sb { color: #BA2121 } /* Literal.String.Backtick */ .highlight .se { color: #BB6622; font-weight: bold } /* Literal.String.Escape */
.highlight .sc { color: #BA2121 } /* Literal.String.Char */ .highlight .sh { color: #BA2121 } /* Literal.String.Heredoc */
.highlight .dl { color: #BA2121 } /* Literal.String.Delimiter */ .highlight .si { color: #BB6688; font-weight: bold } /* Literal.String.Interpol */
.highlight .sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */ .highlight .sx { color: #008000 } /* Literal.String.Other */
.highlight .s2 { color: #BA2121 } /* Literal.String.Double */ .highlight .sr { color: #BB6688 } /* Literal.String.Regex */
.highlight .se { color: #AA5D1F; font-weight: bold } /* Literal.String.Escape */ .highlight .s1 { color: #BA2121 } /* Literal.String.Single */
.highlight .sh { color: #BA2121 } /* Literal.String.Heredoc */ .highlight .ss { color: #19177C } /* Literal.String.Symbol */
.highlight .si { color: #A45A77; font-weight: bold } /* Literal.String.Interpol */ .highlight .bp { color: #008000 } /* Name.Builtin.Pseudo */
.highlight .sx { color: #008000 } /* Literal.String.Other */ .highlight .fm { color: #0000FF } /* Name.Function.Magic */
.highlight .sr { color: #A45A77 } /* Literal.String.Regex */ .highlight .vc { color: #19177C } /* Name.Variable.Class */
.highlight .s1 { color: #BA2121 } /* Literal.String.Single */ .highlight .vg { color: #19177C } /* Name.Variable.Global */
.highlight .ss { color: #19177C } /* Literal.String.Symbol */ .highlight .vi { color: #19177C } /* Name.Variable.Instance */
.highlight .bp { color: #008000 } /* Name.Builtin.Pseudo */ .highlight .vm { color: #19177C } /* Name.Variable.Magic */
.highlight .fm { color: #0000FF } /* Name.Function.Magic */
.highlight .vc { color: #19177C } /* Name.Variable.Class */
.highlight .vg { color: #19177C } /* Name.Variable.Global */
.highlight .vi { color: #19177C } /* Name.Variable.Instance */
.highlight .vm { color: #19177C } /* Name.Variable.Magic */
.highlight .il { color: #666666 } /* Literal.Number.Integer.Long */ .highlight .il { color: #666666 } /* Literal.Number.Integer.Long */

1041
docs/_static/searchtools.js vendored
View File

File diff suppressed because it is too large Load Diff

4084
docs/_static/underscore-1.13.1.js vendored
View File

File diff suppressed because it is too large Load Diff

999
docs/_static/underscore-1.3.1.js vendored Normal file
View File

@ -0,0 +1,999 @@
// Underscore.js 1.3.1
// (c) 2009-2012 Jeremy Ashkenas, DocumentCloud Inc.
// Underscore is freely distributable under the MIT license.
// Portions of Underscore are inspired or borrowed from Prototype,
// Oliver Steele's Functional, and John Resig's Micro-Templating.
// For all details and documentation:
// http://documentcloud.github.com/underscore
(function() {
// Baseline setup
// --------------
// Establish the root object, `window` in the browser, or `global` on the server.
var root = this;
// Save the previous value of the `_` variable.
var previousUnderscore = root._;
// Establish the object that gets returned to break out of a loop iteration.
var breaker = {};
// Save bytes in the minified (but not gzipped) version:
var ArrayProto = Array.prototype, ObjProto = Object.prototype, FuncProto = Function.prototype;
// Create quick reference variables for speed access to core prototypes.
var slice = ArrayProto.slice,
unshift = ArrayProto.unshift,
toString = ObjProto.toString,
hasOwnProperty = ObjProto.hasOwnProperty;
// All **ECMAScript 5** native function implementations that we hope to use
// are declared here.
var
nativeForEach = ArrayProto.forEach,
nativeMap = ArrayProto.map,
nativeReduce = ArrayProto.reduce,
nativeReduceRight = ArrayProto.reduceRight,
nativeFilter = ArrayProto.filter,
nativeEvery = ArrayProto.every,
nativeSome = ArrayProto.some,
nativeIndexOf = ArrayProto.indexOf,
nativeLastIndexOf = ArrayProto.lastIndexOf,
nativeIsArray = Array.isArray,
nativeKeys = Object.keys,
nativeBind = FuncProto.bind;
// Create a safe reference to the Underscore object for use below.
var _ = function(obj) { return new wrapper(obj); };
// Export the Underscore object for **Node.js**, with
// backwards-compatibility for the old `require()` API. If we're in
// the browser, add `_` as a global object via a string identifier,
// for Closure Compiler "advanced" mode.
if (typeof exports !== 'undefined') {
if (typeof module !== 'undefined' && module.exports) {
exports = module.exports = _;
}
exports._ = _;
} else {
root['_'] = _;
}
// Current version.
_.VERSION = '1.3.1';
// Collection Functions
// --------------------
// The cornerstone, an `each` implementation, aka `forEach`.
// Handles objects with the built-in `forEach`, arrays, and raw objects.
// Delegates to **ECMAScript 5**'s native `forEach` if available.
var each = _.each = _.forEach = function(obj, iterator, context) {
if (obj == null) return;
if (nativeForEach && obj.forEach === nativeForEach) {
obj.forEach(iterator, context);
} else if (obj.length === +obj.length) {
for (var i = 0, l = obj.length; i < l; i++) {
if (i in obj && iterator.call(context, obj[i], i, obj) === breaker) return;
}
} else {
for (var key in obj) {
if (_.has(obj, key)) {
if (iterator.call(context, obj[key], key, obj) === breaker) return;
}
}
}
};
// Return the results of applying the iterator to each element.
// Delegates to **ECMAScript 5**'s native `map` if available.
_.map = _.collect = function(obj, iterator, context) {
var results = [];
if (obj == null) return results;
if (nativeMap && obj.map === nativeMap) return obj.map(iterator, context);
each(obj, function(value, index, list) {
results[results.length] = iterator.call(context, value, index, list);
});
if (obj.length === +obj.length) results.length = obj.length;
return results;
};
// **Reduce** builds up a single result from a list of values, aka `inject`,
// or `foldl`. Delegates to **ECMAScript 5**'s native `reduce` if available.
_.reduce = _.foldl = _.inject = function(obj, iterator, memo, context) {
var initial = arguments.length > 2;
if (obj == null) obj = [];
if (nativeReduce && obj.reduce === nativeReduce) {
if (context) iterator = _.bind(iterator, context);
return initial ? obj.reduce(iterator, memo) : obj.reduce(iterator);
}
each(obj, function(value, index, list) {
if (!initial) {
memo = value;
initial = true;
} else {
memo = iterator.call(context, memo, value, index, list);
}
});
if (!initial) throw new TypeError('Reduce of empty array with no initial value');
return memo;
};
// The right-associative version of reduce, also known as `foldr`.
// Delegates to **ECMAScript 5**'s native `reduceRight` if available.
_.reduceRight = _.foldr = function(obj, iterator, memo, context) {
var initial = arguments.length > 2;
if (obj == null) obj = [];
if (nativeReduceRight && obj.reduceRight === nativeReduceRight) {
if (context) iterator = _.bind(iterator, context);
return initial ? obj.reduceRight(iterator, memo) : obj.reduceRight(iterator);
}
var reversed = _.toArray(obj).reverse();
if (context && !initial) iterator = _.bind(iterator, context);
return initial ? _.reduce(reversed, iterator, memo, context) : _.reduce(reversed, iterator);
};
// Return the first value which passes a truth test. Aliased as `detect`.
_.find = _.detect = function(obj, iterator, context) {
var result;
any(obj, function(value, index, list) {
if (iterator.call(context, value, index, list)) {
result = value;
return true;
}
});
return result;
};
// Return all the elements that pass a truth test.
// Delegates to **ECMAScript 5**'s native `filter` if available.
// Aliased as `select`.
_.filter = _.select = function(obj, iterator, context) {
var results = [];
if (obj == null) return results;
if (nativeFilter && obj.filter === nativeFilter) return obj.filter(iterator, context);
each(obj, function(value, index, list) {
if (iterator.call(context, value, index, list)) results[results.length] = value;
});
return results;
};
// Return all the elements for which a truth test fails.
_.reject = function(obj, iterator, context) {
var results = [];
if (obj == null) return results;
each(obj, function(value, index, list) {
if (!iterator.call(context, value, index, list)) results[results.length] = value;
});
return results;
};
// Determine whether all of the elements match a truth test.
// Delegates to **ECMAScript 5**'s native `every` if available.
// Aliased as `all`.
_.every = _.all = function(obj, iterator, context) {
var result = true;
if (obj == null) return result;
if (nativeEvery && obj.every === nativeEvery) return obj.every(iterator, context);
each(obj, function(value, index, list) {
if (!(result = result && iterator.call(context, value, index, list))) return breaker;
});
return result;
};
// Determine if at least one element in the object matches a truth test.
// Delegates to **ECMAScript 5**'s native `some` if available.
// Aliased as `any`.
var any = _.some = _.any = function(obj, iterator, context) {
iterator || (iterator = _.identity);
var result = false;
if (obj == null) return result;
if (nativeSome && obj.some === nativeSome) return obj.some(iterator, context);
each(obj, function(value, index, list) {
if (result || (result = iterator.call(context, value, index, list))) return breaker;
});
return !!result;
};
// Determine if a given value is included in the array or object using `===`.
// Aliased as `contains`.
_.include = _.contains = function(obj, target) {
var found = false;
if (obj == null) return found;
if (nativeIndexOf && obj.indexOf === nativeIndexOf) return obj.indexOf(target) != -1;
found = any(obj, function(value) {
return value === target;
});
return found;
};
// Invoke a method (with arguments) on every item in a collection.
_.invoke = function(obj, method) {
var args = slice.call(arguments, 2);
return _.map(obj, function(value) {
return (_.isFunction(method) ? method || value : value[method]).apply(value, args);
});
};
// Convenience version of a common use case of `map`: fetching a property.
_.pluck = function(obj, key) {
return _.map(obj, function(value){ return value[key]; });
};
// Return the maximum element or (element-based computation).
_.max = function(obj, iterator, context) {
if (!iterator && _.isArray(obj)) return Math.max.apply(Math, obj);
if (!iterator && _.isEmpty(obj)) return -Infinity;
var result = {computed : -Infinity};
each(obj, function(value, index, list) {
var computed = iterator ? iterator.call(context, value, index, list) : value;
computed >= result.computed && (result = {value : value, computed : computed});
});
return result.value;
};
// Return the minimum element (or element-based computation).
_.min = function(obj, iterator, context) {
if (!iterator && _.isArray(obj)) return Math.min.apply(Math, obj);
if (!iterator && _.isEmpty(obj)) return Infinity;
var result = {computed : Infinity};
each(obj, function(value, index, list) {
var computed = iterator ? iterator.call(context, value, index, list) : value;
computed < result.computed && (result = {value : value, computed : computed});
});
return result.value;
};
// Shuffle an array.
_.shuffle = function(obj) {
var shuffled = [], rand;
each(obj, function(value, index, list) {
if (index == 0) {
shuffled[0] = value;
} else {
rand = Math.floor(Math.random() * (index + 1));
shuffled[index] = shuffled[rand];
shuffled[rand] = value;
}
});
return shuffled;
};
// Sort the object's values by a criterion produced by an iterator.
_.sortBy = function(obj, iterator, context) {
return _.pluck(_.map(obj, function(value, index, list) {
return {
value : value,
criteria : iterator.call(context, value, index, list)
};
}).sort(function(left, right) {
var a = left.criteria, b = right.criteria;
return a < b ? -1 : a > b ? 1 : 0;
}), 'value');
};
// Groups the object's values by a criterion. Pass either a string attribute
// to group by, or a function that returns the criterion.
_.groupBy = function(obj, val) {
var result = {};
var iterator = _.isFunction(val) ? val : function(obj) { return obj[val]; };
each(obj, function(value, index) {
var key = iterator(value, index);
(result[key] || (result[key] = [])).push(value);
});
return result;
};
// Use a comparator function to figure out at what index an object should
// be inserted so as to maintain order. Uses binary search.
_.sortedIndex = function(array, obj, iterator) {
iterator || (iterator = _.identity);
var low = 0, high = array.length;
while (low < high) {
var mid = (low + high) >> 1;
iterator(array[mid]) < iterator(obj) ? low = mid + 1 : high = mid;
}
return low;
};
// Safely convert anything iterable into a real, live array.
_.toArray = function(iterable) {
if (!iterable) return [];
if (iterable.toArray) return iterable.toArray();
if (_.isArray(iterable)) return slice.call(iterable);
if (_.isArguments(iterable)) return slice.call(iterable);
return _.values(iterable);
};
// Return the number of elements in an object.
_.size = function(obj) {
return _.toArray(obj).length;
};
// Array Functions
// ---------------
// Get the first element of an array. Passing **n** will return the first N
// values in the array. Aliased as `head`. The **guard** check allows it to work
// with `_.map`.
_.first = _.head = function(array, n, guard) {
return (n != null) && !guard ? slice.call(array, 0, n) : array[0];
};
// Returns everything but the last entry of the array. Especcialy useful on
// the arguments object. Passing **n** will return all the values in
// the array, excluding the last N. The **guard** check allows it to work with
// `_.map`.
_.initial = function(array, n, guard) {
return slice.call(array, 0, array.length - ((n == null) || guard ? 1 : n));
};
// Get the last element of an array. Passing **n** will return the last N
// values in the array. The **guard** check allows it to work with `_.map`.
_.last = function(array, n, guard) {
if ((n != null) && !guard) {
return slice.call(array, Math.max(array.length - n, 0));
} else {
return array[array.length - 1];
}
};
// Returns everything but the first entry of the array. Aliased as `tail`.
// Especially useful on the arguments object. Passing an **index** will return
// the rest of the values in the array from that index onward. The **guard**
// check allows it to work with `_.map`.
_.rest = _.tail = function(array, index, guard) {
return slice.call(array, (index == null) || guard ? 1 : index);
};
// Trim out all falsy values from an array.
_.compact = function(array) {
return _.filter(array, function(value){ return !!value; });
};
// Return a completely flattened version of an array.
_.flatten = function(array, shallow) {
return _.reduce(array, function(memo, value) {
if (_.isArray(value)) return memo.concat(shallow ? value : _.flatten(value));
memo[memo.length] = value;
return memo;
}, []);
};
// Return a version of the array that does not contain the specified value(s).
_.without = function(array) {
return _.difference(array, slice.call(arguments, 1));
};
// Produce a duplicate-free version of the array. If the array has already
// been sorted, you have the option of using a faster algorithm.
// Aliased as `unique`.
_.uniq = _.unique = function(array, isSorted, iterator) {
var initial = iterator ? _.map(array, iterator) : array;
var result = [];
_.reduce(initial, function(memo, el, i) {
if (0 == i || (isSorted === true ? _.last(memo) != el : !_.include(memo, el))) {
memo[memo.length] = el;
result[result.length] = array[i];
}
return memo;
}, []);
return result;
};
// Produce an array that contains the union: each distinct element from all of
// the passed-in arrays.
_.union = function() {
return _.uniq(_.flatten(arguments, true));
};
// Produce an array that contains every item shared between all the
// passed-in arrays. (Aliased as "intersect" for back-compat.)
_.intersection = _.intersect = function(array) {
var rest = slice.call(arguments, 1);
return _.filter(_.uniq(array), function(item) {
return _.every(rest, function(other) {
return _.indexOf(other, item) >= 0;
});
});
};
// Take the difference between one array and a number of other arrays.
// Only the elements present in just the first array will remain.
_.difference = function(array) {
var rest = _.flatten(slice.call(arguments, 1));
return _.filter(array, function(value){ return !_.include(rest, value); });
};
// Zip together multiple lists into a single array -- elements that share
// an index go together.
_.zip = function() {
var args = slice.call(arguments);
var length = _.max(_.pluck(args, 'length'));
var results = new Array(length);
for (var i = 0; i < length; i++) results[i] = _.pluck(args, "" + i);
return results;
};
// If the browser doesn't supply us with indexOf (I'm looking at you, **MSIE**),
// we need this function. Return the position of the first occurrence of an
// item in an array, or -1 if the item is not included in the array.
// Delegates to **ECMAScript 5**'s native `indexOf` if available.
// If the array is large and already in sort order, pass `true`
// for **isSorted** to use binary search.
_.indexOf = function(array, item, isSorted) {
if (array == null) return -1;
var i, l;
if (isSorted) {
i = _.sortedIndex(array, item);
return array[i] === item ? i : -1;
}
if (nativeIndexOf && array.indexOf === nativeIndexOf) return array.indexOf(item);
for (i = 0, l = array.length; i < l; i++) if (i in array && array[i] === item) return i;
return -1;
};
// Delegates to **ECMAScript 5**'s native `lastIndexOf` if available.
_.lastIndexOf = function(array, item) {
if (array == null) return -1;
if (nativeLastIndexOf && array.lastIndexOf === nativeLastIndexOf) return array.lastIndexOf(item);
var i = array.length;
while (i--) if (i in array && array[i] === item) return i;
return -1;
};
// Generate an integer Array containing an arithmetic progression. A port of
// the native Python `range()` function. See
// [the Python documentation](http://docs.python.org/library/functions.html#range).
_.range = function(start, stop, step) {
if (arguments.length <= 1) {
stop = start || 0;
start = 0;
}
step = arguments[2] || 1;
var len = Math.max(Math.ceil((stop - start) / step), 0);
var idx = 0;
var range = new Array(len);
while(idx < len) {
range[idx++] = start;
start += step;
}
return range;
};
// Function (ahem) Functions
// ------------------
// Reusable constructor function for prototype setting.
var ctor = function(){};
// Create a function bound to a given object (assigning `this`, and arguments,
// optionally). Binding with arguments is also known as `curry`.
// Delegates to **ECMAScript 5**'s native `Function.bind` if available.
// We check for `func.bind` first, to fail fast when `func` is undefined.
_.bind = function bind(func, context) {
var bound, args;
if (func.bind === nativeBind && nativeBind) return nativeBind.apply(func, slice.call(arguments, 1));
if (!_.isFunction(func)) throw new TypeError;
args = slice.call(arguments, 2);
return bound = function() {
if (!(this instanceof bound)) return func.apply(context, args.concat(slice.call(arguments)));
ctor.prototype = func.prototype;
var self = new ctor;
var result = func.apply(self, args.concat(slice.call(arguments)));
if (Object(result) === result) return result;
return self;
};
};
// Bind all of an object's methods to that object. Useful for ensuring that
// all callbacks defined on an object belong to it.
_.bindAll = function(obj) {
var funcs = slice.call(arguments, 1);
if (funcs.length == 0) funcs = _.functions(obj);
each(funcs, function(f) { obj[f] = _.bind(obj[f], obj); });
return obj;
};
// Memoize an expensive function by storing its results.
_.memoize = function(func, hasher) {
var memo = {};
hasher || (hasher = _.identity);
return function() {
var key = hasher.apply(this, arguments);
return _.has(memo, key) ? memo[key] : (memo[key] = func.apply(this, arguments));
};
};
// Delays a function for the given number of milliseconds, and then calls
// it with the arguments supplied.
_.delay = function(func, wait) {
var args = slice.call(arguments, 2);
return setTimeout(function(){ return func.apply(func, args); }, wait);
};
// Defers a function, scheduling it to run after the current call stack has
// cleared.
_.defer = function(func) {
return _.delay.apply(_, [func, 1].concat(slice.call(arguments, 1)));
};
// Returns a function, that, when invoked, will only be triggered at most once
// during a given window of time.
_.throttle = function(func, wait) {
var context, args, timeout, throttling, more;
var whenDone = _.debounce(function(){ more = throttling = false; }, wait);
return function() {
context = this; args = arguments;
var later = function() {
timeout = null;
if (more) func.apply(context, args);
whenDone();
};
if (!timeout) timeout = setTimeout(later, wait);
if (throttling) {
more = true;
} else {
func.apply(context, args);
}
whenDone();
throttling = true;
};
};
// Returns a function, that, as long as it continues to be invoked, will not
// be triggered. The function will be called after it stops being called for
// N milliseconds.
_.debounce = function(func, wait) {
var timeout;
return function() {
var context = this, args = arguments;
var later = function() {
timeout = null;
func.apply(context, args);
};
clearTimeout(timeout);
timeout = setTimeout(later, wait);
};
};
// Returns a function that will be executed at most one time, no matter how
// often you call it. Useful for lazy initialization.
_.once = function(func) {
var ran = false, memo;
return function() {
if (ran) return memo;
ran = true;
return memo = func.apply(this, arguments);
};
};
// Returns the first function passed as an argument to the second,
// allowing you to adjust arguments, run code before and after, and
// conditionally execute the original function.
_.wrap = function(func, wrapper) {
return function() {
var args = [func].concat(slice.call(arguments, 0));
return wrapper.apply(this, args);
};
};
// Returns a function that is the composition of a list of functions, each
// consuming the return value of the function that follows.
_.compose = function() {
var funcs = arguments;
return function() {
var args = arguments;
for (var i = funcs.length - 1; i >= 0; i--) {
args = [funcs[i].apply(this, args)];
}
return args[0];
};
};
// Returns a function that will only be executed after being called N times.
_.after = function(times, func) {
if (times <= 0) return func();
return function() {
if (--times < 1) { return func.apply(this, arguments); }
};
};
// Object Functions
// ----------------
// Retrieve the names of an object's properties.
// Delegates to **ECMAScript 5**'s native `Object.keys`
_.keys = nativeKeys || function(obj) {
if (obj !== Object(obj)) throw new TypeError('Invalid object');
var keys = [];
for (var key in obj) if (_.has(obj, key)) keys[keys.length] = key;
return keys;
};
// Retrieve the values of an object's properties.
_.values = function(obj) {
return _.map(obj, _.identity);
};
// Return a sorted list of the function names available on the object.
// Aliased as `methods`
_.functions = _.methods = function(obj) {
var names = [];
for (var key in obj) {
if (_.isFunction(obj[key])) names.push(key);
}
return names.sort();
};
// Extend a given object with all the properties in passed-in object(s).
_.extend = function(obj) {
each(slice.call(arguments, 1), function(source) {
for (var prop in source) {
obj[prop] = source[prop];
}
});
return obj;
};
// Fill in a given object with default properties.
_.defaults = function(obj) {
each(slice.call(arguments, 1), function(source) {
for (var prop in source) {
if (obj[prop] == null) obj[prop] = source[prop];
}
});
return obj;
};
// Create a (shallow-cloned) duplicate of an object.
_.clone = function(obj) {
if (!_.isObject(obj)) return obj;
return _.isArray(obj) ? obj.slice() : _.extend({}, obj);
};
// Invokes interceptor with the obj, and then returns obj.
// The primary purpose of this method is to "tap into" a method chain, in
// order to perform operations on intermediate results within the chain.
_.tap = function(obj, interceptor) {
interceptor(obj);
return obj;
};
// Internal recursive comparison function.
function eq(a, b, stack) {
// Identical objects are equal. `0 === -0`, but they aren't identical.
// See the Harmony `egal` proposal: http://wiki.ecmascript.org/doku.php?id=harmony:egal.
if (a === b) return a !== 0 || 1 / a == 1 / b;
// A strict comparison is necessary because `null == undefined`.
if (a == null || b == null) return a === b;
// Unwrap any wrapped objects.
if (a._chain) a = a._wrapped;
if (b._chain) b = b._wrapped;
// Invoke a custom `isEqual` method if one is provided.
if (a.isEqual && _.isFunction(a.isEqual)) return a.isEqual(b);
if (b.isEqual && _.isFunction(b.isEqual)) return b.isEqual(a);
// Compare `[[Class]]` names.
var className = toString.call(a);
if (className != toString.call(b)) return false;
switch (className) {
// Strings, numbers, dates, and booleans are compared by value.
case '[object String]':
// Primitives and their corresponding object wrappers are equivalent; thus, `"5"` is
// equivalent to `new String("5")`.
return a == String(b);
case '[object Number]':
// `NaN`s are equivalent, but non-reflexive. An `egal` comparison is performed for
// other numeric values.
return a != +a ? b != +b : (a == 0 ? 1 / a == 1 / b : a == +b);
case '[object Date]':
case '[object Boolean]':
// Coerce dates and booleans to numeric primitive values. Dates are compared by their
// millisecond representations. Note that invalid dates with millisecond representations
// of `NaN` are not equivalent.
return +a == +b;
// RegExps are compared by their source patterns and flags.
case '[object RegExp]':
return a.source == b.source &&
a.global == b.global &&
a.multiline == b.multiline &&
a.ignoreCase == b.ignoreCase;
}
if (typeof a != 'object' || typeof b != 'object') return false;
// Assume equality for cyclic structures. The algorithm for detecting cyclic
// structures is adapted from ES 5.1 section 15.12.3, abstract operation `JO`.
var length = stack.length;
while (length--) {
// Linear search. Performance is inversely proportional to the number of
// unique nested structures.
if (stack[length] == a) return true;
}
// Add the first object to the stack of traversed objects.
stack.push(a);
var size = 0, result = true;
// Recursively compare objects and arrays.
if (className == '[object Array]') {
// Compare array lengths to determine if a deep comparison is necessary.
size = a.length;
result = size == b.length;
if (result) {
// Deep compare the contents, ignoring non-numeric properties.
while (size--) {
// Ensure commutative equality for sparse arrays.
if (!(result = size in a == size in b && eq(a[size], b[size], stack))) break;
}
}
} else {
// Objects with different constructors are not equivalent.
if ('constructor' in a != 'constructor' in b || a.constructor != b.constructor) return false;
// Deep compare objects.
for (var key in a) {
if (_.has(a, key)) {
// Count the expected number of properties.
size++;
// Deep compare each member.
if (!(result = _.has(b, key) && eq(a[key], b[key], stack))) break;
}
}
// Ensure that both objects contain the same number of properties.
if (result) {
for (key in b) {
if (_.has(b, key) && !(size--)) break;
}
result = !size;
}
}
// Remove the first object from the stack of traversed objects.
stack.pop();
return result;
}
// Perform a deep comparison to check if two objects are equal.
_.isEqual = function(a, b) {
return eq(a, b, []);
};
// Is a given array, string, or object empty?
// An "empty" object has no enumerable own-properties.
_.isEmpty = function(obj) {
if (_.isArray(obj) || _.isString(obj)) return obj.length === 0;
for (var key in obj) if (_.has(obj, key)) return false;
return true;
};
// Is a given value a DOM element?
_.isElement = function(obj) {
return !!(obj && obj.nodeType == 1);
};
// Is a given value an array?
// Delegates to ECMA5's native Array.isArray
_.isArray = nativeIsArray || function(obj) {
return toString.call(obj) == '[object Array]';
};
// Is a given variable an object?
_.isObject = function(obj) {
return obj === Object(obj);
};
// Is a given variable an arguments object?
_.isArguments = function(obj) {
return toString.call(obj) == '[object Arguments]';
};
if (!_.isArguments(arguments)) {
_.isArguments = function(obj) {
return !!(obj && _.has(obj, 'callee'));
};
}
// Is a given value a function?
_.isFunction = function(obj) {
return toString.call(obj) == '[object Function]';
};
// Is a given value a string?
_.isString = function(obj) {
return toString.call(obj) == '[object String]';
};
// Is a given value a number?
_.isNumber = function(obj) {
return toString.call(obj) == '[object Number]';
};
// Is the given value `NaN`?
_.isNaN = function(obj) {
// `NaN` is the only value for which `===` is not reflexive.
return obj !== obj;
};
// Is a given value a boolean?
_.isBoolean = function(obj) {
return obj === true || obj === false || toString.call(obj) == '[object Boolean]';
};
// Is a given value a date?
_.isDate = function(obj) {
return toString.call(obj) == '[object Date]';
};
// Is the given value a regular expression?
_.isRegExp = function(obj) {
return toString.call(obj) == '[object RegExp]';
};
// Is a given value equal to null?
_.isNull = function(obj) {
return obj === null;
};
// Is a given variable undefined?
_.isUndefined = function(obj) {
return obj === void 0;
};
// Has own property?
_.has = function(obj, key) {
return hasOwnProperty.call(obj, key);
};
// Utility Functions
// -----------------
// Run Underscore.js in *noConflict* mode, returning the `_` variable to its
// previous owner. Returns a reference to the Underscore object.
_.noConflict = function() {
root._ = previousUnderscore;
return this;
};
// Keep the identity function around for default iterators.
_.identity = function(value) {
return value;
};
// Run a function **n** times.
_.times = function (n, iterator, context) {
for (var i = 0; i < n; i++) iterator.call(context, i);
};
// Escape a string for HTML interpolation.
_.escape = function(string) {
return (''+string).replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;').replace(/"/g, '&quot;').replace(/'/g, '&#x27;').replace(/\//g,'&#x2F;');
};
// Add your own custom functions to the Underscore object, ensuring that
// they're correctly added to the OOP wrapper as well.
_.mixin = function(obj) {
each(_.functions(obj), function(name){
addToWrapper(name, _[name] = obj[name]);
});
};
// Generate a unique integer id (unique within the entire client session).
// Useful for temporary DOM ids.
var idCounter = 0;
_.uniqueId = function(prefix) {
var id = idCounter++;
return prefix ? prefix + id : id;
};
// By default, Underscore uses ERB-style template delimiters, change the
// following template settings to use alternative delimiters.
_.templateSettings = {
evaluate : /<%([\s\S]+?)%>/g,
interpolate : /<%=([\s\S]+?)%>/g,
escape : /<%-([\s\S]+?)%>/g
};
// When customizing `templateSettings`, if you don't want to define an
// interpolation, evaluation or escaping regex, we need one that is
// guaranteed not to match.
var noMatch = /.^/;
// Within an interpolation, evaluation, or escaping, remove HTML escaping
// that had been previously added.
var unescape = function(code) {
return code.replace(/\\\\/g, '\\').replace(/\\'/g, "'");
};
// JavaScript micro-templating, similar to John Resig's implementation.
// Underscore templating handles arbitrary delimiters, preserves whitespace,
// and correctly escapes quotes within interpolated code.
_.template = function(str, data) {
var c = _.templateSettings;
var tmpl = 'var __p=[],print=function(){__p.push.apply(__p,arguments);};' +
'with(obj||{}){__p.push(\'' +
str.replace(/\\/g, '\\\\')
.replace(/'/g, "\\'")
.replace(c.escape || noMatch, function(match, code) {
return "',_.escape(" + unescape(code) + "),'";
})
.replace(c.interpolate || noMatch, function(match, code) {
return "'," + unescape(code) + ",'";
})
.replace(c.evaluate || noMatch, function(match, code) {
return "');" + unescape(code).replace(/[\r\n\t]/g, ' ') + ";__p.push('";
})
.replace(/\r/g, '\\r')
.replace(/\n/g, '\\n')
.replace(/\t/g, '\\t')
+ "');}return __p.join('');";
var func = new Function('obj', '_', tmpl);
if (data) return func(data, _);
return function(data) {
return func.call(this, data, _);
};
};
// Add a "chain" function, which will delegate to the wrapper.
_.chain = function(obj) {
return _(obj).chain();
};
// The OOP Wrapper
// ---------------
// If Underscore is called as a function, it returns a wrapped object that
// can be used OO-style. This wrapper holds altered versions of all the
// underscore functions. Wrapped objects may be chained.
var wrapper = function(obj) { this._wrapped = obj; };
// Expose `wrapper.prototype` as `_.prototype`
_.prototype = wrapper.prototype;
// Helper function to continue chaining intermediate results.
var result = function(obj, chain) {
return chain ? _(obj).chain() : obj;
};
// A method to easily add functions to the OOP wrapper.
var addToWrapper = function(name, func) {
wrapper.prototype[name] = function() {
var args = slice.call(arguments);
unshift.call(args, this._wrapped);
return result(func.apply(_, args), this._chain);
};
};
// Add all of the Underscore functions to the wrapper object.
_.mixin(_);
// Add all mutator Array functions to the wrapper.
each(['pop', 'push', 'reverse', 'shift', 'sort', 'splice', 'unshift'], function(name) {
var method = ArrayProto[name];
wrapper.prototype[name] = function() {
var wrapped = this._wrapped;
method.apply(wrapped, arguments);
var length = wrapped.length;
if ((name == 'shift' || name == 'splice') && length === 0) delete wrapped[0];
return result(wrapped, this._chain);
};
});
// Add all accessor Array functions to the wrapper.
each(['concat', 'join', 'slice'], function(name) {
var method = ArrayProto[name];
wrapper.prototype[name] = function() {
return result(method.apply(this._wrapped, arguments), this._chain);
};
});
// Start chaining a wrapped Underscore object.
wrapper.prototype.chain = function() {
this._chain = true;
return this;
};
// Extracts the result from a wrapped and chained object.
wrapper.prototype.value = function() {
return this._wrapped;
};
}).call(this);

37
docs/_static/underscore.js vendored
View File

File diff suppressed because one or more lines are too long

250
docs/backlog.html
View File

@ -1,127 +1,125 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" >
<head> <head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> <meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>Backlog of changes &mdash; GravityMon 0.5.0 documentation</title><link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<title>Backlog of changes &mdash; GravityMon 0.5.0 documentation</title> <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <!--[if lt IE 9]>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> <script src="_static/js/html5shiv.min.js"></script>
<!--[if lt IE 9]> <![endif]-->
<script src="_static/js/html5shiv.min.js"></script> <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<![endif]--> <script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> <script src="_static/doctools.js"></script>
<script src="_static/jquery.js"></script> <script src="_static/language_data.js"></script>
<script src="_static/underscore.js"></script> <script src="_static/js/theme.js"></script>
<script src="_static/doctools.js"></script> <link rel="index" title="Index" href="genindex.html" />
<script src="_static/js/theme.js"></script> <link rel="search" title="Search" href="search.html" />
<link rel="index" title="Index" href="genindex.html" /> <link rel="prev" title="Contributing" href="contributing.html" />
<link rel="search" title="Search" href="search.html" /> </head>
<link rel="prev" title="Contributing" href="contributing.html" />
</head> <body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<body class="wy-body-for-nav"> <nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-grid-for-nav"> <div class="wy-side-scroll">
<nav data-toggle="wy-nav-shift" class="wy-nav-side"> <div class="wy-side-nav-search" >
<div class="wy-side-scroll"> <a href="index.html" class="icon icon-home"> GravityMon
<div class="wy-side-nav-search" > </a>
<a href="index.html" class="icon icon-home"> GravityMon <div role="search">
</a> <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<div role="search"> <input type="text" name="q" placeholder="Search docs" />
<form id="rtd-search-form" class="wy-form" action="search.html" method="get"> <input type="hidden" name="check_keywords" value="yes" />
<input type="text" name="q" placeholder="Search docs" /> <input type="hidden" name="area" value="default" />
<input type="hidden" name="check_keywords" value="yes" /> </form>
<input type="hidden" name="area" value="default" /> </div>
</form> </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
</div> <p class="caption"><span class="caption-text">Contents:</span></p>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> <ul class="current">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p> <li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
<ul class="current"> <li class="toctree-l1"><a class="reference internal" href="functionallity.html">Functionallity</a></li>
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li> <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="functionallity.html">Functionallity</a></li> <li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li> <li class="toctree-l1"><a class="reference internal" href="compiling.html">Compiling the software</a></li>
<li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a></li> <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
<li class="toctree-l1"><a class="reference internal" href="compiling.html">Compiling the software</a></li> <li class="toctree-l1 current"><a class="current reference internal" href="#">Backlog of changes</a><ul>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li> <li class="toctree-l2"><a class="reference internal" href="#documentation">Documentation</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Backlog of changes</a><ul> <li class="toctree-l2"><a class="reference internal" href="#code">Code</a></li>
<li class="toctree-l2"><a class="reference internal" href="#documentation">Documentation</a></li> </ul>
<li class="toctree-l2"><a class="reference internal" href="#code">Code</a></li> </li>
</ul> </ul>
</li>
</ul> </div>
</div>
</div> </nav>
</div>
</nav> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > <a href="index.html">GravityMon</a>
<i data-toggle="wy-nav-top" class="fa fa-bars"></i> </nav>
<a href="index.html">GravityMon</a>
</nav> <div class="wy-nav-content">
<div class="rst-content">
<div class="wy-nav-content"> <div role="navigation" aria-label="Page navigation">
<div class="rst-content"> <ul class="wy-breadcrumbs">
<div role="navigation" aria-label="Page navigation"> <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<ul class="wy-breadcrumbs"> <li>Backlog of changes</li>
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li> <li class="wy-breadcrumbs-aside">
<li>Backlog of changes</li> <a href="_sources/backlog.rst.txt" rel="nofollow"> View page source</a>
<li class="wy-breadcrumbs-aside"> </li>
<a href="_sources/backlog.rst.txt" rel="nofollow"> View page source</a> </ul>
</li> <hr/>
</ul> </div>
<hr/> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
</div> <div itemprop="articleBody">
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody"> <div class="section" id="backlog-of-changes">
<h1>Backlog of changes<a class="headerlink" href="#backlog-of-changes" title="Permalink to this headline"></a></h1>
<section id="backlog-of-changes"> <div class="section" id="documentation">
<h1>Backlog of changes<a class="headerlink" href="#backlog-of-changes" title="Permalink to this headline"></a></h1> <h2>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline"></a></h2>
<section id="documentation"> <ul class="simple">
<h2>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline"></a></h2> <li><p>Write contribution instructions</p></li>
<ul class="simple"> </ul>
<li><p>Write contribution instructions</p></li> </div>
</ul> <div class="section" id="code">
</section> <h2>Code<a class="headerlink" href="#code" title="Permalink to this headline"></a></h2>
<section id="code"> <ul class="simple">
<h2>Code<a class="headerlink" href="#code" title="Permalink to this headline"></a></h2> <li><p>Support for MQTT</p></li>
<ul class="simple"> <li><p>Support for plato</p></li>
<li><p>Support for MQTT</p></li> <li><p>Use pre-commit for validating check-in</p></li>
<li><p>Support for plato</p></li> <li><p>Automatic builds via github actions</p></li>
<li><p>Use pre-commit for validating check-in</p></li> </ul>
<li><p>Automatic builds via github actions</p></li> </div>
</ul> </div>
</section>
</section>
</div>
</div>
</div> <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
</div> <a href="contributing.html" class="btn btn-neutral float-left" title="Contributing" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> </div>
<a href="contributing.html" class="btn btn-neutral float-left" title="Contributing" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div> <hr/>
<hr/> <div role="contentinfo">
<p>&#169; Copyright 2021-2022, Magnus Persson.</p>
<div role="contentinfo"> </div>
<p>&#169; Copyright 2021-2022, Magnus Persson.</p>
</div> Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a provided by <a href="https://readthedocs.org">Read the Docs</a>.
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</footer> </div>
</div> </section>
</div> </div>
</section> <script>
</div> jQuery(function () {
<script> SphinxRtdTheme.Navigation.enable(true);
jQuery(function () { });
SphinxRtdTheme.Navigation.enable(true); </script>
});
</script> </body>
</body>
</html> </html>

512
docs/compiling.html
View File

@ -1,258 +1,256 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" >
<head> <head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> <meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>Compiling the software &mdash; GravityMon 0.5.0 documentation</title><link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<title>Compiling the software &mdash; GravityMon 0.5.0 documentation</title> <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <!--[if lt IE 9]>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> <script src="_static/js/html5shiv.min.js"></script>
<!--[if lt IE 9]> <![endif]-->
<script src="_static/js/html5shiv.min.js"></script> <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<![endif]--> <script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> <script src="_static/doctools.js"></script>
<script src="_static/jquery.js"></script> <script src="_static/language_data.js"></script>
<script src="_static/underscore.js"></script> <script src="_static/js/theme.js"></script>
<script src="_static/doctools.js"></script> <link rel="index" title="Index" href="genindex.html" />
<script src="_static/js/theme.js"></script> <link rel="search" title="Search" href="search.html" />
<link rel="index" title="Index" href="genindex.html" /> <link rel="next" title="Contributing" href="contributing.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="prev" title="Configuration" href="configuration.html" />
<link rel="next" title="Contributing" href="contributing.html" /> </head>
<link rel="prev" title="Configuration" href="configuration.html" />
</head> <body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<body class="wy-body-for-nav"> <nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-grid-for-nav"> <div class="wy-side-scroll">
<nav data-toggle="wy-nav-shift" class="wy-nav-side"> <div class="wy-side-nav-search" >
<div class="wy-side-scroll"> <a href="index.html" class="icon icon-home"> GravityMon
<div class="wy-side-nav-search" > </a>
<a href="index.html" class="icon icon-home"> GravityMon <div role="search">
</a> <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<div role="search"> <input type="text" name="q" placeholder="Search docs" />
<form id="rtd-search-form" class="wy-form" action="search.html" method="get"> <input type="hidden" name="check_keywords" value="yes" />
<input type="text" name="q" placeholder="Search docs" /> <input type="hidden" name="area" value="default" />
<input type="hidden" name="check_keywords" value="yes" /> </form>
<input type="hidden" name="area" value="default" /> </div>
</form> </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
</div> <p class="caption"><span class="caption-text">Contents:</span></p>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> <ul class="current">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p> <li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
<ul class="current"> <li class="toctree-l1"><a class="reference internal" href="functionallity.html">Functionallity</a></li>
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li> <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="functionallity.html">Functionallity</a></li> <li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li> <li class="toctree-l1 current"><a class="current reference internal" href="#">Compiling the software</a><ul>
<li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a></li> <li class="toctree-l2"><a class="reference internal" href="#tools">Tools</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Compiling the software</a><ul> <li class="toctree-l2"><a class="reference internal" href="#code-formatting">Code Formatting</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tools">Tools</a></li> <li class="toctree-l2"><a class="reference internal" href="#targets">Targets</a></li>
<li class="toctree-l2"><a class="reference internal" href="#code-formatting">Code Formatting</a></li> <li class="toctree-l2"><a class="reference internal" href="#source-structure">Source structure</a></li>
<li class="toctree-l2"><a class="reference internal" href="#targets">Targets</a></li> <li class="toctree-l2"><a class="reference internal" href="#options">Options</a></li>
<li class="toctree-l2"><a class="reference internal" href="#source-structure">Source structure</a></li> </ul>
<li class="toctree-l2"><a class="reference internal" href="#options">Options</a></li> </li>
</ul> <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
</li> <li class="toctree-l1"><a class="reference internal" href="backlog.html">Backlog of changes</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li> </ul>
<li class="toctree-l1"><a class="reference internal" href="backlog.html">Backlog of changes</a></li>
</ul> </div>
</div>
</div> </nav>
</div>
</nav> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > <a href="index.html">GravityMon</a>
<i data-toggle="wy-nav-top" class="fa fa-bars"></i> </nav>
<a href="index.html">GravityMon</a>
</nav> <div class="wy-nav-content">
<div class="rst-content">
<div class="wy-nav-content"> <div role="navigation" aria-label="Page navigation">
<div class="rst-content"> <ul class="wy-breadcrumbs">
<div role="navigation" aria-label="Page navigation"> <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<ul class="wy-breadcrumbs"> <li>Compiling the software</li>
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li> <li class="wy-breadcrumbs-aside">
<li>Compiling the software</li> <a href="_sources/compiling.rst.txt" rel="nofollow"> View page source</a>
<li class="wy-breadcrumbs-aside"> </li>
<a href="_sources/compiling.rst.txt" rel="nofollow"> View page source</a> </ul>
</li> <hr/>
</ul> </div>
<hr/> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
</div> <div itemprop="articleBody">
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody"> <div class="section" id="compiling-the-software">
<h1>Compiling the software<a class="headerlink" href="#compiling-the-software" title="Permalink to this headline"></a></h1>
<section id="compiling-the-software"> <div class="section" id="tools">
<h1>Compiling the software<a class="headerlink" href="#compiling-the-software" title="Permalink to this headline"></a></h1> <h2>Tools<a class="headerlink" href="#tools" title="Permalink to this headline"></a></h2>
<section id="tools"> <p>I use the following tools in order to build and manage the software:</p>
<h2>Tools<a class="headerlink" href="#tools" title="Permalink to this headline"></a></h2> <ul class="simple">
<p>I use the following tools in order to build and manage the software:</p> <li><p>Visual Studio Code</p></li>
<ul class="simple"> <li><p>PlatformIO</p></li>
<li><p>Visual Studio Code</p></li> <li><p>Git for Windows</p></li>
<li><p>PlatformIO</p></li> <li><p>VSCode plugin: Minify (used to minimise the html files)</p></li>
<li><p>Git for Windows</p></li> </ul>
<li><p>VSCode plugin: Minify (used to minimise the html files)</p></li> </div>
</ul> <div class="section" id="code-formatting">
</section> <h2>Code Formatting<a class="headerlink" href="#code-formatting" title="Permalink to this headline"></a></h2>
<section id="code-formatting"> <p>I use pre-commit and their cpp style checks to validate the code. Plugin defintions are found in <strong>.pre-commit-config.yaml</strong></p>
<h2>Code Formatting<a class="headerlink" href="#code-formatting" title="Permalink to this headline"></a></h2> <p><a class="reference external" href="https://www.pre-commit.com">https://www.pre-commit.com</a></p>
<p>I use pre-commit and their cpp style checks to validate the code. Plugin defintions are found in <strong>.pre-commit-config.yaml</strong></p> <div class="admonition note">
<p><a class="reference external" href="https://www.pre-commit.com">https://www.pre-commit.com</a></p> <p class="admonition-title">Note</p>
<div class="admonition note"> <p>There is not yet any automatic checks since this does not work on Windows. It works if running under WSL2 with Ubuntu.</p>
<p class="admonition-title">Note</p> </div>
<p>There is not yet any automatic checks since this does not work on Windows. It works if running under WSL2 with Ubuntu.</p> </div>
</div> <div class="section" id="targets">
</section> <h2>Targets<a class="headerlink" href="#targets" title="Permalink to this headline"></a></h2>
<section id="targets"> <p>In the repository there are 3 targets defined</p>
<h2>Targets<a class="headerlink" href="#targets" title="Permalink to this headline"></a></h2> <ul class="simple">
<p>In the repository there are 3 targets defined</p> <li><p>gravity-debug; Maximum logging for trouble shooting, deep sleep is disabled.</p></li>
<ul class="simple"> <li><p>gravity-release; Standard release</p></li>
<li><p>gravity-debug; Maximum logging for trouble shooting, deep sleep is disabled.</p></li> <li><p>gravity-perf; Standard release but contains code for measuring performance</p></li>
<li><p>gravity-release; Standard release</p></li> </ul>
<li><p>gravity-perf; Standard release but contains code for measuring performance</p></li> </div>
</ul> <div class="section" id="source-structure">
</section> <h2>Source structure<a class="headerlink" href="#source-structure" title="Permalink to this headline"></a></h2>
<section id="source-structure"> <table class="colwidths-given docutils align-default" id="id1">
<h2>Source structure<a class="headerlink" href="#source-structure" title="Permalink to this headline"></a></h2> <caption><span class="caption-text">Directory structure</span><a class="headerlink" href="#id1" title="Permalink to this table"></a></caption>
<table class="colwidths-given docutils align-default" id="id1"> <colgroup>
<caption><span class="caption-text">Directory structure</span><a class="headerlink" href="#id1" title="Permalink to this table"></a></caption> <col style="width: 40%" />
<colgroup> <col style="width: 60%" />
<col style="width: 40%" /> </colgroup>
<col style="width: 60%" /> <thead>
</colgroup> <tr class="row-odd"><th class="head"><p>path</p></th>
<thead> <th class="head"><p>content</p></th>
<tr class="row-odd"><th class="head"><p>path</p></th> </tr>
<th class="head"><p>content</p></th> </thead>
</tr> <tbody>
</thead> <tr class="row-even"><td><p>/bin</p></td>
<tbody> <td><p>Contains compiled binaries</p></td>
<tr class="row-even"><td><p>/bin</p></td> </tr>
<td><p>Contains compiled binaries</p></td> <tr class="row-odd"><td><p>/data</p></td>
</tr> <td><p>Directory for flashing device filesystem</p></td>
<tr class="row-odd"><td><p>/data</p></td> </tr>
<td><p>Directory for flashing device filesystem</p></td> <tr class="row-even"><td><p>/doc</p></td>
</tr> <td><p>Various external documents used as input</p></td>
<tr class="row-even"><td><p>/doc</p></td> </tr>
<td><p>Various external documents used as input</p></td> <tr class="row-odd"><td><p>/docs</p></td>
</tr> <td><p>Folder published to github pages</p></td>
<tr class="row-odd"><td><p>/docs</p></td> </tr>
<td><p>Folder published to github pages</p></td> <tr class="row-even"><td><p>/html</p></td>
</tr> <td><p>Source for html files</p></td>
<tr class="row-even"><td><p>/html</p></td> </tr>
<td><p>Source for html files</p></td> <tr class="row-odd"><td><p>/img</p></td>
</tr> <td><p>Images uses in README.md</p></td>
<tr class="row-odd"><td><p>/img</p></td> </tr>
<td><p>Images uses in README.md</p></td> <tr class="row-even"><td><p>/lib</p></td>
</tr> <td><p>External libraries used when compiling</p></td>
<tr class="row-even"><td><p>/lib</p></td> </tr>
<td><p>External libraries used when compiling</p></td> <tr class="row-odd"><td><p>/script</p></td>
</tr> <td><p>Scripts used in build process</p></td>
<tr class="row-odd"><td><p>/script</p></td> </tr>
<td><p>Scripts used in build process</p></td> <tr class="row-even"><td><p>/src</p></td>
</tr> <td><p>Source code for software</p></td>
<tr class="row-even"><td><p>/src</p></td> </tr>
<td><p>Source code for software</p></td> <tr class="row-odd"><td><p>/src_docs</p></td>
</tr> <td><p>Source code for documentation</p></td>
<tr class="row-odd"><td><p>/src_docs</p></td> </tr>
<td><p>Source code for documentation</p></td> <tr class="row-even"><td><p>/stl</p></td>
</tr> <td><p>3d models</p></td>
<tr class="row-even"><td><p>/stl</p></td> </tr>
<td><p>3d models</p></td> <tr class="row-odd"><td><p>/test</p></td>
</tr> <td><p>Test data for developing html files</p></td>
<tr class="row-odd"><td><p>/test</p></td> </tr>
<td><p>Test data for developing html files</p></td> </tbody>
</tr> </table>
</tbody> </div>
</table> <div class="section" id="options">
</section> <h2>Options<a class="headerlink" href="#options" title="Permalink to this headline"></a></h2>
<section id="options"> <p>This is a list of C++ defines that is used to enable/disable functions in the code.</p>
<h2>Options<a class="headerlink" href="#options" title="Permalink to this headline"></a></h2> <table class="colwidths-given docutils align-default" id="id2">
<p>This is a list of C++ defines that is used to enable/disable functions in the code.</p> <caption><span class="caption-text">Defines</span><a class="headerlink" href="#id2" title="Permalink to this table"></a></caption>
<table class="colwidths-given docutils align-default" id="id2"> <colgroup>
<caption><span class="caption-text">Defines</span><a class="headerlink" href="#id2" title="Permalink to this table"></a></caption> <col style="width: 40%" />
<colgroup> <col style="width: 60%" />
<col style="width: 40%" /> </colgroup>
<col style="width: 60%" /> <thead>
</colgroup> <tr class="row-odd"><th class="head"><p>define</p></th>
<thead> <th class="head"><p>description</p></th>
<tr class="row-odd"><th class="head"><p>define</p></th> </tr>
<th class="head"><p>description</p></th> </thead>
</tr> <tbody>
</thead> <tr class="row-even"><td><p>ACTIVATE_OTA</p></td>
<tbody> <td><p>Enables the OTA functionallity in the code</p></td>
<tr class="row-even"><td><p>ACTIVATE_OTA</p></td> </tr>
<td><p>Enables the OTA functionallity in the code</p></td> <tr class="row-odd"><td><p>USE_GYRO_TEMP</p></td>
</tr> <td><p>Uses temperature from gyro instead of DS18B20 (experimental)</p></td>
<tr class="row-odd"><td><p>USE_GYRO_TEMP</p></td> </tr>
<td><p>Uses temperature from gyro instead of DS18B20 (experimental)</p></td> <tr class="row-even"><td><p>SKIP_SLEEPMODE</p></td>
</tr> <td><p>THe device never goes into sleep mode, useful when developing.</p></td>
<tr class="row-even"><td><p>SKIP_SLEEPMODE</p></td> </tr>
<td><p>THe device never goes into sleep mode, useful when developing.</p></td> <tr class="row-odd"><td><p>CFG_DISABLE_LOGGING</p></td>
</tr> <td><p>Done include verbose logging in Config class. Excessive logging may crash device.</p></td>
<tr class="row-odd"><td><p>CFG_DISABLE_LOGGING</p></td> </tr>
<td><p>Done include verbose logging in Config class. Excessive logging may crash device.</p></td> <tr class="row-even"><td><p>GYRO_DISABLE_LOGGING</p></td>
</tr> <td><p>Done include verbose logging in Gyro class. Excessive logging may crash device.</p></td>
<tr class="row-even"><td><p>GYRO_DISABLE_LOGGING</p></td> </tr>
<td><p>Done include verbose logging in Gyro class. Excessive logging may crash device.</p></td> <tr class="row-odd"><td><p>PUSH_DISABLE_LOGGING</p></td>
</tr> <td><p>Done include verbose logging in PushTarget class. Excessive logging may crash device.</p></td>
<tr class="row-odd"><td><p>PUSH_DISABLE_LOGGING</p></td> </tr>
<td><p>Done include verbose logging in PushTarget class. Excessive logging may crash device.</p></td> <tr class="row-even"><td><p>TSEN_DISABLE_LOGGING</p></td>
</tr> <td><p>Done include verbose logging in TempSensor class. Excessive logging may crash device.</p></td>
<tr class="row-even"><td><p>TSEN_DISABLE_LOGGING</p></td> </tr>
<td><p>Done include verbose logging in TempSensor class. Excessive logging may crash device.</p></td> <tr class="row-odd"><td><p>WEB_DISABLE_LOGGING</p></td>
</tr> <td><p>Done include verbose logging in WebServer class. Excessive logging may crash device.</p></td>
<tr class="row-odd"><td><p>WEB_DISABLE_LOGGING</p></td> </tr>
<td><p>Done include verbose logging in WebServer class. Excessive logging may crash device.</p></td> <tr class="row-even"><td><p>MAIN_DISABLE_LOGGING</p></td>
</tr> <td><p>Done include verbose logging in Main class. Excessive logging may crash device.</p></td>
<tr class="row-even"><td><p>MAIN_DISABLE_LOGGING</p></td> </tr>
<td><p>Done include verbose logging in Main class. Excessive logging may crash device.</p></td> <tr class="row-odd"><td><p>USE_LITTLEFS</p></td>
</tr> <td><p>Use the new filesystem in Ardurino</p></td>
<tr class="row-odd"><td><p>USE_LITTLEFS</p></td> </tr>
<td><p>Use the new filesystem in Ardurino</p></td> <tr class="row-even"><td><p>EMBED_HTML</p></td>
</tr> <td><p>Html files are included in code, if not defined they are served from the file system.</p></td>
<tr class="row-even"><td><p>EMBED_HTML</p></td> </tr>
<td><p>Html files are included in code, if not defined they are served from the file system.</p></td> <tr class="row-odd"><td><p>USER_SSID</p></td>
</tr> <td><p>If defined the device will always use this SSID</p></td>
<tr class="row-odd"><td><p>USER_SSID</p></td> </tr>
<td><p>If defined the device will always use this SSID</p></td> <tr class="row-even"><td><p>USER_SSID_PWD</p></td>
</tr> <td><p>Password to the SSID</p></td>
<tr class="row-even"><td><p>USER_SSID_PWD</p></td> </tr>
<td><p>Password to the SSID</p></td> <tr class="row-odd"><td><p>CFG_APPVER</p></td>
</tr> <td><p>Defines the version of the compiled software</p></td>
<tr class="row-odd"><td><p>CFG_APPVER</p></td> </tr>
<td><p>Defines the version of the compiled software</p></td> </tbody>
</tr> </table>
</tbody> </div>
</table> </div>
</section>
</section>
</div>
</div>
</div> <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
</div> <a href="configuration.html" class="btn btn-neutral float-left" title="Configuration" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> <a href="contributing.html" class="btn btn-neutral float-right" title="Contributing" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="configuration.html" class="btn btn-neutral float-left" title="Configuration" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> </div>
<a href="contributing.html" class="btn btn-neutral float-right" title="Contributing" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div> <hr/>
<hr/> <div role="contentinfo">
<p>&#169; Copyright 2021-2022, Magnus Persson.</p>
<div role="contentinfo"> </div>
<p>&#169; Copyright 2021-2022, Magnus Persson.</p>
</div> Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a provided by <a href="https://readthedocs.org">Read the Docs</a>.
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</footer> </div>
</div> </section>
</div> </div>
</section> <script>
</div> jQuery(function () {
<script> SphinxRtdTheme.Navigation.enable(true);
jQuery(function () { });
SphinxRtdTheme.Navigation.enable(true); </script>
});
</script> </body>
</body>
</html> </html>

1132
docs/configuration.html
View File

File diff suppressed because it is too large Load Diff

218
docs/contributing.html
View File

@ -1,111 +1,109 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" >
<head> <head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> <meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>Contributing &mdash; GravityMon 0.5.0 documentation</title><link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<title>Contributing &mdash; GravityMon 0.5.0 documentation</title> <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <!--[if lt IE 9]>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> <script src="_static/js/html5shiv.min.js"></script>
<!--[if lt IE 9]> <![endif]-->
<script src="_static/js/html5shiv.min.js"></script> <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<![endif]--> <script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> <script src="_static/doctools.js"></script>
<script src="_static/jquery.js"></script> <script src="_static/language_data.js"></script>
<script src="_static/underscore.js"></script> <script src="_static/js/theme.js"></script>
<script src="_static/doctools.js"></script> <link rel="index" title="Index" href="genindex.html" />
<script src="_static/js/theme.js"></script> <link rel="search" title="Search" href="search.html" />
<link rel="index" title="Index" href="genindex.html" /> <link rel="next" title="Backlog of changes" href="backlog.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="prev" title="Compiling the software" href="compiling.html" />
<link rel="next" title="Backlog of changes" href="backlog.html" /> </head>
<link rel="prev" title="Compiling the software" href="compiling.html" />
</head> <body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<body class="wy-body-for-nav"> <nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-grid-for-nav"> <div class="wy-side-scroll">
<nav data-toggle="wy-nav-shift" class="wy-nav-side"> <div class="wy-side-nav-search" >
<div class="wy-side-scroll"> <a href="index.html" class="icon icon-home"> GravityMon
<div class="wy-side-nav-search" > </a>
<a href="index.html" class="icon icon-home"> GravityMon <div role="search">
</a> <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<div role="search"> <input type="text" name="q" placeholder="Search docs" />
<form id="rtd-search-form" class="wy-form" action="search.html" method="get"> <input type="hidden" name="check_keywords" value="yes" />
<input type="text" name="q" placeholder="Search docs" /> <input type="hidden" name="area" value="default" />
<input type="hidden" name="check_keywords" value="yes" /> </form>
<input type="hidden" name="area" value="default" /> </div>
</form> </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
</div> <p class="caption"><span class="caption-text">Contents:</span></p>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> <ul class="current">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p> <li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
<ul class="current"> <li class="toctree-l1"><a class="reference internal" href="functionallity.html">Functionallity</a></li>
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li> <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="functionallity.html">Functionallity</a></li> <li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li> <li class="toctree-l1"><a class="reference internal" href="compiling.html">Compiling the software</a></li>
<li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a></li> <li class="toctree-l1 current"><a class="current reference internal" href="#">Contributing</a></li>
<li class="toctree-l1"><a class="reference internal" href="compiling.html">Compiling the software</a></li> <li class="toctree-l1"><a class="reference internal" href="backlog.html">Backlog of changes</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Contributing</a></li> </ul>
<li class="toctree-l1"><a class="reference internal" href="backlog.html">Backlog of changes</a></li>
</ul> </div>
</div>
</div> </nav>
</div>
</nav> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > <a href="index.html">GravityMon</a>
<i data-toggle="wy-nav-top" class="fa fa-bars"></i> </nav>
<a href="index.html">GravityMon</a>
</nav> <div class="wy-nav-content">
<div class="rst-content">
<div class="wy-nav-content"> <div role="navigation" aria-label="Page navigation">
<div class="rst-content"> <ul class="wy-breadcrumbs">
<div role="navigation" aria-label="Page navigation"> <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<ul class="wy-breadcrumbs"> <li>Contributing</li>
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li> <li class="wy-breadcrumbs-aside">
<li>Contributing</li> <a href="_sources/contributing.rst.txt" rel="nofollow"> View page source</a>
<li class="wy-breadcrumbs-aside"> </li>
<a href="_sources/contributing.rst.txt" rel="nofollow"> View page source</a> </ul>
</li> <hr/>
</ul> </div>
<hr/> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
</div> <div itemprop="articleBody">
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody"> <div class="section" id="contributing">
<h1>Contributing<a class="headerlink" href="#contributing" title="Permalink to this headline"></a></h1>
<section id="contributing"> <p>This section is under construction.</p>
<h1>Contributing<a class="headerlink" href="#contributing" title="Permalink to this headline"></a></h1> </div>
<p>This section is under construction.</p>
</section>
</div>
</div>
</div> <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
</div> <a href="compiling.html" class="btn btn-neutral float-left" title="Compiling the software" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> <a href="backlog.html" class="btn btn-neutral float-right" title="Backlog of changes" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="compiling.html" class="btn btn-neutral float-left" title="Compiling the software" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> </div>
<a href="backlog.html" class="btn btn-neutral float-right" title="Backlog of changes" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div> <hr/>
<hr/> <div role="contentinfo">
<p>&#169; Copyright 2021-2022, Magnus Persson.</p>
<div role="contentinfo"> </div>
<p>&#169; Copyright 2021-2022, Magnus Persson.</p>
</div> Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a provided by <a href="https://readthedocs.org">Read the Docs</a>.
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</footer> </div>
</div> </section>
</div> </div>
</section> <script>
</div> jQuery(function () {
<script> SphinxRtdTheme.Navigation.enable(true);
jQuery(function () { });
SphinxRtdTheme.Navigation.enable(true); </script>
});
</script> </body>
</body>
</html> </html>

366
docs/functionallity.html
View File

@ -1,180 +1,188 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" >
<head> <head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> <meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>Functionallity &mdash; GravityMon 0.5.0 documentation</title><link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<title>Functionallity &mdash; GravityMon 0.5.0 documentation</title> <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <!--[if lt IE 9]>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> <script src="_static/js/html5shiv.min.js"></script>
<!--[if lt IE 9]> <![endif]-->
<script src="_static/js/html5shiv.min.js"></script> <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<![endif]--> <script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> <script src="_static/doctools.js"></script>
<script src="_static/jquery.js"></script> <script src="_static/language_data.js"></script>
<script src="_static/underscore.js"></script> <script src="_static/js/theme.js"></script>
<script src="_static/doctools.js"></script> <link rel="index" title="Index" href="genindex.html" />
<script src="_static/js/theme.js"></script> <link rel="search" title="Search" href="search.html" />
<link rel="index" title="Index" href="genindex.html" /> <link rel="next" title="Installation" href="installation.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="prev" title="Releases" href="releases.html" />
<link rel="next" title="Installation" href="installation.html" /> </head>
<link rel="prev" title="Releases" href="releases.html" />
</head> <body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<body class="wy-body-for-nav"> <nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-grid-for-nav"> <div class="wy-side-scroll">
<nav data-toggle="wy-nav-shift" class="wy-nav-side"> <div class="wy-side-nav-search" >
<div class="wy-side-scroll"> <a href="index.html" class="icon icon-home"> GravityMon
<div class="wy-side-nav-search" > </a>
<a href="index.html" class="icon icon-home"> GravityMon <div role="search">
</a> <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<div role="search"> <input type="text" name="q" placeholder="Search docs" />
<form id="rtd-search-form" class="wy-form" action="search.html" method="get"> <input type="hidden" name="check_keywords" value="yes" />
<input type="text" name="q" placeholder="Search docs" /> <input type="hidden" name="area" value="default" />
<input type="hidden" name="check_keywords" value="yes" /> </form>
<input type="hidden" name="area" value="default" /> </div>
</form> </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
</div> <p class="caption"><span class="caption-text">Contents:</span></p>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> <ul class="current">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p> <li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
<ul class="current"> <li class="toctree-l1 current"><a class="current reference internal" href="#">Functionallity</a><ul>
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li> <li class="toctree-l2"><a class="reference internal" href="#the-main-differences">The main differences</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Functionallity</a><ul> <li class="toctree-l2"><a class="reference internal" href="#other-features">Other features</a></li>
<li class="toctree-l2"><a class="reference internal" href="#the-main-differences">The main differences</a></li> <li class="toctree-l2"><a class="reference internal" href="#experimental-features">Experimental features</a></li>
<li class="toctree-l2"><a class="reference internal" href="#other-features">Other features</a></li> <li class="toctree-l2"><a class="reference internal" href="#typical-performance">Typical performance</a></li>
<li class="toctree-l2"><a class="reference internal" href="#experimental-features">Experimental features</a></li> </ul>
</ul> </li>
</li> <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li> <li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a></li> <li class="toctree-l1"><a class="reference internal" href="compiling.html">Compiling the software</a></li>
<li class="toctree-l1"><a class="reference internal" href="compiling.html">Compiling the software</a></li> <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li> <li class="toctree-l1"><a class="reference internal" href="backlog.html">Backlog of changes</a></li>
<li class="toctree-l1"><a class="reference internal" href="backlog.html">Backlog of changes</a></li> </ul>
</ul>
</div>
</div> </div>
</div> </nav>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<i data-toggle="wy-nav-top" class="fa fa-bars"></i> <a href="index.html">GravityMon</a>
<a href="index.html">GravityMon</a> </nav>
</nav>
<div class="wy-nav-content">
<div class="wy-nav-content"> <div class="rst-content">
<div class="rst-content"> <div role="navigation" aria-label="Page navigation">
<div role="navigation" aria-label="Page navigation"> <ul class="wy-breadcrumbs">
<ul class="wy-breadcrumbs"> <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li> <li>Functionallity</li>
<li>Functionallity</li> <li class="wy-breadcrumbs-aside">
<li class="wy-breadcrumbs-aside"> <a href="_sources/functionallity.rst.txt" rel="nofollow"> View page source</a>
<a href="_sources/functionallity.rst.txt" rel="nofollow"> View page source</a> </li>
</li> </ul>
</ul> <hr/>
<hr/> </div>
</div> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div itemprop="articleBody">
<div itemprop="articleBody">
<div class="section" id="functionallity">
<section id="functionallity"> <h1>Functionallity<a class="headerlink" href="#functionallity" title="Permalink to this headline"></a></h1>
<h1>Functionallity<a class="headerlink" href="#functionallity" title="Permalink to this headline"></a></h1> <div class="section" id="the-main-differences">
<section id="the-main-differences"> <h2>The main differences<a class="headerlink" href="#the-main-differences" title="Permalink to this headline"></a></h2>
<h2>The main differences<a class="headerlink" href="#the-main-differences" title="Permalink to this headline"></a></h2> <ul>
<ul> <li><p><strong>Operates in two modes `gravity monitoring` and `configuration mode`</strong></p>
<li><p><strong>Operates in two modes `gravity monitoring` and `configuration mode`</strong></p> <p>In gravity monitoring mode it behaves just like the iSpindle, it wakes up at regular intervals, measure angle/tile, temperature, calculates gravity and pushes the data to defined endpoints.</p>
<p>In gravity monitoring mode it behaves just like the iSpindle, it wakes up at regular intervals, measure angle/tile, temperature, calculates gravity and pushes the data to defined endpoints.</p> <p>In configuration mode the device is always active and the webserver is active. Here you can view the angle/tilt values, change configuration options and more. When in this mode you can also interact with the device
<p>In configuration mode the device is always active and the webserver is active. Here you can view the angle/tilt values, change configuration options and more. When in this mode you can also interact with the device via an REST API so data can be pushed to the device via scripts (see API section for more information)-</p>
via an REST API so data can be pushed to the device via scripts (see API section for more information)-</p> <p><em>See the configuration section for more information on how to trigger the configuration mode.</em></p>
<p><em>See the configuration section for more information on how to trigger the configuration mode.</em></p> </li>
</li> <li><p><strong>Can send data to multiple endpoints at once</strong></p>
<li><p><strong>Can send data to multiple endpoints at once</strong></p> <p>The orignial iSpindle can only have one destination, this sofware will push data to all defined endpoints so in theory you can use them all. However this will consume a lot of battery power so use only as many as needed.</p>
<p>The orignial iSpindle can only have one destination, this sofware will push data to all defined endpoints so in theory you can use them all. However this will consume a lot of battery power so use only as many as needed.</p> <p>Currently the device supports the following endpoints: http (2 differnt), influxdb2 and Brewfather</p>
<p>Currently the device supports the following endpoints: http (2 differnt), influxdb2 and Brewfather</p> <p>If you want additional targets please raise a feature request in the github repo.</p>
<p>If you want additional targets please raise a feature request in the github repo.</p> </li>
</li> <li><p><strong>Build in function to create gravity formulas, so no need for using other tools for this part</strong></p>
<li><p><strong>Build in function to create gravity formulas, so no need for using other tools for this part</strong></p> <p>Another big difference is that this software can create the gravity formula in the device, just enter the angle/gravity data that you have collected. You will also see a graph simulating how the formula would work.</p>
<p>Another big difference is that this software can create the gravity formula in the device, just enter the angle/gravity data that you have collected. You will also see a graph simulating how the formula would work.</p> </li>
</li> <li><p><strong>Automatic temperature adjustment of gravity reading</strong></p>
<li><p><strong>Automatic temperature adjustment of gravity reading</strong></p> <p>If you want to correct gravity based on beer temperature you can do this in the formula but here is a nice feature that can correct the gravity as a second step making this independant of the formula.</p>
<p>If you want to correct gravity based on beer temperature you can do this in the formula but here is a nice feature that can correct the gravity as a second step making this independant of the formula.</p> </li>
</li> </ul>
</ul> <div class="admonition note">
<div class="admonition note"> <p class="admonition-title">Note</p>
<p class="admonition-title">Note</p> <p>This feature needs more testing to be validated.</p>
<p>This feature needs more testing to be validated.</p> </div>
</div> <ul>
<ul> <li><p><strong>OTA support from local webserver</strong></p>
<li><p><strong>OTA support from local webserver</strong></p> <p>When starting up in configuration mode the device will check for a software update from a local webserver.</p>
<p>When starting up in configuration mode the device will check for a software update from a local webserver.</p> </li>
</li> <li><p><strong>DS18B20 temperature adjustments</strong></p>
<li><p><strong>DS18B20 temperature adjustments</strong></p> <p>You can adjust the temperature reading of the temperature sensor.</p>
<p>You can adjust the temperature reading of the temperature sensor.</p> </li>
</li> <li><p><strong>Gyro Movement</strong></p>
<li><p><strong>Gyro Movement</strong></p> <p>The software will detect if the gyro is moving and if this is the case it will go back to sleep for 60seconds. This way we should avoid faulty measurements.</p>
<p>The software will detect if the gyro is moving and if this is the case it will go back to sleep for 60seconds. This way we should avoid faulty measurements.</p> </li>
</li> </ul>
</ul> </div>
</section> <div class="section" id="other-features">
<section id="other-features"> <h2>Other features<a class="headerlink" href="#other-features" title="Permalink to this headline"></a></h2>
<h2>Other features<a class="headerlink" href="#other-features" title="Permalink to this headline"></a></h2> <ul class="simple">
<ul class="simple"> <li><p>Support for Celcius and Farenheigt as temperature formats.</p></li>
<li><p>Support for Celcius and Farenheigt as temperature formats.</p></li> <li><p>Support SG (Plato is not yet supported)</p></li>
<li><p>Support SG (Plato is not yet supported)</p></li> <li><p>Gyro data is read 50 times to ensure good accuracy</p></li>
<li><p>Gyro data is read 50 times to ensure good accuracy</p></li> </ul>
</ul> </div>
</section> <div class="section" id="experimental-features">
<section id="experimental-features"> <h2>Experimental features<a class="headerlink" href="#experimental-features" title="Permalink to this headline"></a></h2>
<h2>Experimental features<a class="headerlink" href="#experimental-features" title="Permalink to this headline"></a></h2> <ul>
<ul> <li><p>Use the temperature sensor in the gyro instead of DS18B20</p>
<li><p>Use the temperature sensor in the gyro instead of DS18B20</p> <p>This works fine when the device has time to cool down between measurements and it saves a few milliseconds (reduced battery consumption). My testing shows that this is quite accurate.
<p>This works fine when the device has time to cool down between measurements and it saves a few milliseconds (reduced battery consumption). My testing shows that this is quite accurate. There is lots of battery power to save, reading the temp sensor takes almost as long as the gyro. This could reduce the run time by 40-50% and probly extend battery life with the same.
There is lots of battery power to save, reading the temp sensor takes almost as long as the gyro. This could reduce the run time by 40-50% and probly extend battery life with the same. However more testing is required. Might add this as an option in the UI.</p>
However more testing is required. Might add this as an option in the UI.</p> </li>
</li> </ul>
</ul> <div class="admonition note">
<div class="admonition note"> <p class="admonition-title">Note</p>
<p class="admonition-title">Note</p> <p>This is not enabled by default.</p>
<p>This is not enabled by default.</p> </div>
</div> <ul>
<ul> <li><p>Performance measurements</p>
<li><p>Performance measurements</p> <p>I’ve also create a small library to measure execution code in some areas of the code that i know is time consuming. This way I can find a good balance between performace and quality.</p>
<p>I’ve also create a small library to measure execution code in some areas of the code that i know is time consuming. This way I can find a good balance between performace and quality.</p> <p><em>See the compile section for more information.</em></p>
<p><em>See the compile section for more information.</em></p> </li>
</li> </ul>
</ul> </div>
</section> <div class="section" id="typical-performance">
</section> <h2>Typical performance<a class="headerlink" href="#typical-performance" title="Permalink to this headline"></a></h2>
<p>Since I have the possibility to measaure the performance of different function in the code this is what I have been able to gather.</p>
<p>The typical runtime in a measurement cycle is approx 2 seconds and in some cases it can take up to 6-8 seconds but this is mainly related to establishing the WIFI connection. So stable wifi is
</div> essential for long batterylife. Out of the 2 seconds of run-time the major time is spent on gyro readings (1.3s) and temperature measurements of (0.6s) so using the gyro sensor for measureing
</div> temperature would reduce the total runtime with 25%. Sending data over http takes less than 100ms (on my local network) so this is not drawing much power.</p>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> <p>The image below shows how the run-time varies over time. The pink line is the wifi connection time and this is why the time varies.</p>
<a href="releases.html" class="btn btn-neutral float-left" title="Releases" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> <a class="reference internal image-reference" href="_images/perf1.png"><img alt="Performance view" src="_images/perf1.png" style="width: 800px;" /></a>
<a href="installation.html" class="btn btn-neutral float-right" title="Installation" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> </div>
</div> </div>
<hr/>
</div>
<div role="contentinfo"> </div>
<p>&#169; Copyright 2021-2022, Magnus Persson.</p> <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
</div> <a href="releases.html" class="btn btn-neutral float-left" title="Releases" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="installation.html" class="btn btn-neutral float-right" title="Installation" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a </div>
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>. <hr/>
<div role="contentinfo">
</footer> <p>&#169; Copyright 2021-2022, Magnus Persson.</p>
</div> </div>
</div>
</section> Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
</div> <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
<script> provided by <a href="https://readthedocs.org">Read the Docs</a>.
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
}); </footer>
</script> </div>
</div>
</body> </section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html> </html>

210
docs/genindex.html
View File

@ -1,106 +1,106 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" > <!DOCTYPE html>
<head> <html class="writer-html5" lang="en" >
<meta charset="utf-8" /> <head>
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta charset="utf-8" />
<title>Index &mdash; GravityMon 0.5.0 documentation</title> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <title>Index &mdash; GravityMon 0.5.0 documentation</title><link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]> <!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script> <script src="_static/js/html5shiv.min.js"></script>
<![endif]--> <![endif]-->
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> <script src="_static/jquery.js"></script>
<script src="_static/jquery.js"></script> <script src="_static/underscore.js"></script>
<script src="_static/underscore.js"></script> <script src="_static/doctools.js"></script>
<script src="_static/doctools.js"></script> <script src="_static/language_data.js"></script>
<script src="_static/js/theme.js"></script> <script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="#" /> <link rel="index" title="Index" href="#" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
</head> </head>
<body class="wy-body-for-nav"> <body class="wy-body-for-nav">
<div class="wy-grid-for-nav"> <div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side"> <nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll"> <div class="wy-side-scroll">
<div class="wy-side-nav-search" > <div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> GravityMon <a href="index.html" class="icon icon-home"> GravityMon
</a> </a>
<div role="search"> <div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get"> <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" /> <input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" /> <input type="hidden" name="area" value="default" />
</form> </form>
</div> </div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p> <p class="caption"><span class="caption-text">Contents:</span></p>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li> <li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
<li class="toctree-l1"><a class="reference internal" href="functionallity.html">Functionallity</a></li> <li class="toctree-l1"><a class="reference internal" href="functionallity.html">Functionallity</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li> <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a></li> <li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="compiling.html">Compiling the software</a></li> <li class="toctree-l1"><a class="reference internal" href="compiling.html">Compiling the software</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li> <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
<li class="toctree-l1"><a class="reference internal" href="backlog.html">Backlog of changes</a></li> <li class="toctree-l1"><a class="reference internal" href="backlog.html">Backlog of changes</a></li>
</ul> </ul>
</div> </div>
</div> </div>
</nav> </nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i> <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">GravityMon</a> <a href="index.html">GravityMon</a>
</nav> </nav>
<div class="wy-nav-content"> <div class="wy-nav-content">
<div class="rst-content"> <div class="rst-content">
<div role="navigation" aria-label="Page navigation"> <div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs"> <ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li> <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li>Index</li> <li>Index</li>
<li class="wy-breadcrumbs-aside"> <li class="wy-breadcrumbs-aside">
</li> </li>
</ul> </ul>
<hr/> <hr/>
</div> </div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody"> <div itemprop="articleBody">
<h1 id="index">Index</h1> <h1 id="index">Index</h1>
<div class="genindex-jumpbox"> <div class="genindex-jumpbox">
</div> </div>
</div> </div>
</div> </div>
<footer> <footer>
<hr/> <hr/>
<div role="contentinfo"> <div role="contentinfo">
<p>&#169; Copyright 2021-2022, Magnus Persson.</p> <p>&#169; Copyright 2021-2022, Magnus Persson.</p>
</div> </div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>. provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer> </footer>
</div> </div>
</div> </div>
</section> </section>
</div> </div>
<script> <script>
jQuery(function () { jQuery(function () {
SphinxRtdTheme.Navigation.enable(true); SphinxRtdTheme.Navigation.enable(true);
}); });
</script> </script>
</body> </body>
</html> </html>

471
docs/index.html
View File

@ -1,237 +1,236 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" >
<head> <head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> <meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>Welcome to GravityMon’s documentation! &mdash; GravityMon 0.5.0 documentation</title><link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<title>Welcome to GravityMon’s documentation! &mdash; GravityMon 0.5.0 documentation</title> <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <!--[if lt IE 9]>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> <script src="_static/js/html5shiv.min.js"></script>
<!--[if lt IE 9]> <![endif]-->
<script src="_static/js/html5shiv.min.js"></script> <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<![endif]--> <script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> <script src="_static/doctools.js"></script>
<script src="_static/jquery.js"></script> <script src="_static/language_data.js"></script>
<script src="_static/underscore.js"></script> <script src="_static/js/theme.js"></script>
<script src="_static/doctools.js"></script> <link rel="index" title="Index" href="genindex.html" />
<script src="_static/js/theme.js"></script> <link rel="search" title="Search" href="search.html" />
<link rel="index" title="Index" href="genindex.html" /> <link rel="next" title="Releases" href="releases.html" />
<link rel="search" title="Search" href="search.html" /> </head>
<link rel="next" title="Releases" href="releases.html" />
</head> <body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<body class="wy-body-for-nav"> <nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-grid-for-nav"> <div class="wy-side-scroll">
<nav data-toggle="wy-nav-shift" class="wy-nav-side"> <div class="wy-side-nav-search" >
<div class="wy-side-scroll"> <a href="#" class="icon icon-home"> GravityMon
<div class="wy-side-nav-search" > </a>
<a href="#" class="icon icon-home"> GravityMon <div role="search">
</a> <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<div role="search"> <input type="text" name="q" placeholder="Search docs" />
<form id="rtd-search-form" class="wy-form" action="search.html" method="get"> <input type="hidden" name="check_keywords" value="yes" />
<input type="text" name="q" placeholder="Search docs" /> <input type="hidden" name="area" value="default" />
<input type="hidden" name="check_keywords" value="yes" /> </form>
<input type="hidden" name="area" value="default" /> </div>
</form> </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
</div> <p class="caption"><span class="caption-text">Contents:</span></p>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> <ul>
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p> <li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
<ul> <li class="toctree-l1"><a class="reference internal" href="functionallity.html">Functionallity</a></li>
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li> <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="functionallity.html">Functionallity</a></li> <li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li> <li class="toctree-l1"><a class="reference internal" href="compiling.html">Compiling the software</a></li>
<li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a></li> <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
<li class="toctree-l1"><a class="reference internal" href="compiling.html">Compiling the software</a></li> <li class="toctree-l1"><a class="reference internal" href="backlog.html">Backlog of changes</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li> </ul>
<li class="toctree-l1"><a class="reference internal" href="backlog.html">Backlog of changes</a></li>
</ul> </div>
</div>
</div> </nav>
</div>
</nav> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > <a href="#">GravityMon</a>
<i data-toggle="wy-nav-top" class="fa fa-bars"></i> </nav>
<a href="#">GravityMon</a>
</nav> <div class="wy-nav-content">
<div class="rst-content">
<div class="wy-nav-content"> <div role="navigation" aria-label="Page navigation">
<div class="rst-content"> <ul class="wy-breadcrumbs">
<div role="navigation" aria-label="Page navigation"> <li><a href="#" class="icon icon-home"></a> &raquo;</li>
<ul class="wy-breadcrumbs"> <li>Welcome to GravityMon’s documentation!</li>
<li><a href="#" class="icon icon-home"></a> &raquo;</li> <li class="wy-breadcrumbs-aside">
<li>Welcome to GravityMon’s documentation!</li> <a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>
<li class="wy-breadcrumbs-aside"> </li>
<a href="_sources/index.rst.txt" rel="nofollow"> View page source</a> </ul>
</li> <hr/>
</ul> </div>
<hr/> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
</div> <div itemprop="articleBody">
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody"> <div class="section" id="welcome-to-gravitymon-s-documentation">
<h1>Welcome to GravityMon’s documentation!<a class="headerlink" href="#welcome-to-gravitymon-s-documentation" title="Permalink to this headline"></a></h1>
<section id="welcome-to-gravitymon-s-documentation"> <div class="admonition note">
<h1>Welcome to GravityMon’s documentation!<a class="headerlink" href="#welcome-to-gravitymon-s-documentation" title="Permalink to this headline"></a></h1> <p class="admonition-title">Note</p>
<div class="admonition note"> <p>Preliminary documentation. This is work in progress. This documentation reflects <strong>v0.5</strong></p>
<p class="admonition-title">Note</p> </div>
<p>Preliminary documentation. This is work in progress. This documentation reflects <strong>v0.5</strong></p> <p>GravityMon is a replacement firmare for the iSpindle hardware. It’s used to measure gravity in beer and show the progress
</div> of fermentation.</p>
<p>GravityMon is a replacement firmare for the iSpindle hardware. It’s used to measure gravity in beer and show the progress <p>For more information on this topic and function please visit <a class="reference external" href="https://www.ispindel.de">https://www.ispindel.de</a>.</p>
of fermentation.</p> <p>I started GravityMon because i like to create software and wanted to do some low level programming. I had done a few
<p>For more information on this topic and function please visit <a class="reference external" href="https://www.ispindel.de">https://www.ispindel.de</a>.</p> projects based on esp8266 and also started to brew beer so this combination was quite natural.</p>
<p>I started GravityMon because i like to create software and wanted to do some low level programming. I had done a few <p>The hardware design comes from the fantastic iSpindle project so that is not covered in this documentation.</p>
projects based on esp8266 and also started to brew beer so this combination was quite natural.</p> <p>My approach to this software is a little different from that the original ispindle firmware. The github repository can
<p>The hardware design comes from the fantastic iSpindle project so that is not covered in this documentation.</p> be found here; <a class="reference external" href="https://github.com/mp-se/gravitymon">https://github.com/mp-se/gravitymon</a></p>
<p>My approach to this software is a little different from that the original ispindle firmware. The github repository can <div class="admonition note">
be found here; <a class="reference external" href="https://github.com/mp-se/gravitymon">https://github.com/mp-se/gravitymon</a></p> <p class="admonition-title">Note</p>
<div class="admonition note"> <p>This software is in the early stages even though its more than one year old so if you find issues, please
<p class="admonition-title">Note</p> open a ticket on github.</p>
<p>This software is in the early stages even though its more than one year old so if you find issues, please <p>I dont take responsibility for any errors that can cause problems with the use. I have tested v0.4 on 5+ brews
open a ticket on github.</p> over the last 6 months without any issues.</p>
<p>I dont take responsibility for any errors that can cause problems with the use. I have tested v0.4 on 5+ brews </div>
over the last 6 months without any issues.</p> <div class="section" id="the-main-differences">
</div> <h2>The main differences:<a class="headerlink" href="#the-main-differences" title="Permalink to this headline"></a></h2>
<section id="the-main-differences"> <ul class="simple">
<h2>The main differences:<a class="headerlink" href="#the-main-differences" title="Permalink to this headline"></a></h2> <li><p>Operates in two modes <cite>gravity monitoring</cite> and <cite>configuration mode</cite></p></li>
<ul class="simple"> <li><p>Send data to multiple endpoints when pushing data.</p></li>
<li><p>Operates in two modes <cite>gravity monitoring</cite> and <cite>configuration mode</cite></p></li> <li><p>Automatic temperature adjustment of gravity reading</p></li>
<li><p>Send data to multiple endpoints when pushing data.</p></li> <li><p>OTA support from local webserver</p></li>
<li><p>Automatic temperature adjustment of gravity reading</p></li> <li><p>Build in function to create gravity formulas (<em>New in v0.5</em>)</p></li>
<li><p>OTA support from local webserver</p></li> </ul>
<li><p>Build in function to create gravity formulas (<em>New in v0.5</em>)</p></li> <p>There are also a experimental features such as:</p>
</ul> <ul class="simple">
<p>There are also a experimental features such as:</p> <li><p>Using the temperature sensor in gyro instead of DS18B20 (faster)</p></li>
<ul class="simple"> <li><p>Performance measurements (used to optimise code)</p></li>
<li><p>Using the temperature sensor in gyro instead of DS18B20 (faster)</p></li> </ul>
<li><p>Performance measurements (used to optimise code)</p></li> <p><strong>For a complete breakdown see the functionallity section.</strong></p>
</ul> </div>
<p><strong>For a complete breakdown see the functionallity section.</strong></p> <div class="section" id="credits-to">
</section> <h2>Credits to<a class="headerlink" href="#credits-to" title="Permalink to this headline"></a></h2>
<section id="credits-to"> <p>This software uses the following libraries and without these this would have been much more difficult to acheive:</p>
<h2>Credits to<a class="headerlink" href="#credits-to" title="Permalink to this headline"></a></h2> <ul>
<p>This software uses the following libraries and without these this would have been much more difficult to acheive:</p> <li><p><a class="reference external" href="https://github.com/jrowberg/i2cdevlib.git">https://github.com/jrowberg/i2cdevlib.git</a></p>
<ul> <p>This library contains the basic code to interact with the gyro + many more chips.</p>
<li><p><a class="reference external" href="https://github.com/jrowberg/i2cdevlib.git">https://github.com/jrowberg/i2cdevlib.git</a></p> </li>
<p>This library contains the basic code to interact with the gyro + many more chips.</p> <li><p><a class="reference external" href="https://github.com/codeplea/tinyexpr">https://github.com/codeplea/tinyexpr</a></p>
</li> <p>Proccess the gravity formula and calculate the gravity and various corrections.</p>
<li><p><a class="reference external" href="https://github.com/codeplea/tinyexpr">https://github.com/codeplea/tinyexpr</a></p> </li>
<p>Proccess the gravity formula and calculate the gravity and various corrections.</p> <li><p><a class="reference external" href="https://github.com/graphitemaster/incbin">https://github.com/graphitemaster/incbin</a></p>
</li> <p>Include binary files into the code, used to service html files.</p>
<li><p><a class="reference external" href="https://github.com/graphitemaster/incbin">https://github.com/graphitemaster/incbin</a></p> </li>
<p>Include binary files into the code, used to service html files.</p> <li><p><a class="reference external" href="https://github.com/khoih-prog/ESP_DoubleResetDetector">https://github.com/khoih-prog/ESP_DoubleResetDetector</a></p>
</li> <p>Can detect if the reset button is pressed twice, is used to enter WIFI config mode.</p>
<li><p><a class="reference external" href="https://github.com/khoih-prog/ESP_DoubleResetDetector">https://github.com/khoih-prog/ESP_DoubleResetDetector</a></p> </li>
<p>Can detect if the reset button is pressed twice, is used to enter WIFI config mode.</p> <li><p><a class="reference external" href="https://github.com/tzapu/WiFiManager">https://github.com/tzapu/WiFiManager</a></p>
</li> <p>Configure wifi settings.</p>
<li><p><a class="reference external" href="https://github.com/tzapu/WiFiManager">https://github.com/tzapu/WiFiManager</a></p> </li>
<p>Configure wifi settings.</p> <li><p><a class="reference external" href="https://github.com/thijse/Arduino-Log">https://github.com/thijse/Arduino-Log</a></p>
</li> <p>Logging library for handling different loglevels and configure what sent over the serial.</p>
<li><p><a class="reference external" href="https://github.com/thijse/Arduino-Log">https://github.com/thijse/Arduino-Log</a></p> </li>
<p>Logging library for handling different loglevels and configure what sent over the serial.</p> <li><p><a class="reference external" href="https://github.com/bblanchon/ArduinoJson">https://github.com/bblanchon/ArduinoJson</a></p>
</li> <p>Json parser/creator used in configuration files and API’s</p>
<li><p><a class="reference external" href="https://github.com/bblanchon/ArduinoJson">https://github.com/bblanchon/ArduinoJson</a></p> </li>
<p>Json parser/creator used in configuration files and API’s</p> <li><p><a class="reference external" href="https://github.com/PaulStoffregen/OneWire">https://github.com/PaulStoffregen/OneWire</a></p>
</li> <p>Communication library used for interacting with temperature sensor.</p>
<li><p><a class="reference external" href="https://github.com/PaulStoffregen/OneWire">https://github.com/PaulStoffregen/OneWire</a></p> </li>
<p>Communication library used for interacting with temperature sensor.</p> <li><p><a class="reference external" href="https://github.com/milesburton/Arduino-Temperature-Control-Library">https://github.com/milesburton/Arduino-Temperature-Control-Library</a></p>
</li> <p>Interaction with the DS18B20 sensor</p>
<li><p><a class="reference external" href="https://github.com/milesburton/Arduino-Temperature-Control-Library">https://github.com/milesburton/Arduino-Temperature-Control-Library</a></p> </li>
<p>Interaction with the DS18B20 sensor</p> <li><p><a class="reference external" href="https://github.com/Rotario/arduinoCurveFitting">https://github.com/Rotario/arduinoCurveFitting</a></p>
</li> <p>Create the gravity formula.</p>
<li><p><a class="reference external" href="https://github.com/Rotario/arduinoCurveFitting">https://github.com/Rotario/arduinoCurveFitting</a></p> </li>
<p>Create the gravity formula.</p> <li><p><a class="reference external" href="https://graphjs.com/">https://graphjs.com/</a></p>
</li> <p>Render the graphs in the UI.</p>
<li><p><a class="reference external" href="https://graphjs.com/">https://graphjs.com/</a></p> </li>
<p>Render the graphs in the UI.</p> <li><p><a class="reference external" href="https://getbootstrap.com/">https://getbootstrap.com/</a></p>
</li> <p>CSS templates for the web page.</p>
<li><p><a class="reference external" href="https://getbootstrap.com/">https://getbootstrap.com/</a></p> </li>
<p>CSS templates for the web page.</p> </ul>
</li> <div class="toctree-wrapper compound">
</ul> <p class="caption"><span class="caption-text">Contents:</span></p>
<div class="toctree-wrapper compound"> <ul>
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p> <li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a><ul>
<ul> <li class="toctree-l2"><a class="reference internal" href="releases.html#v0-5-0-beta">v0.5.0 (beta)</a></li>
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a><ul> <li class="toctree-l2"><a class="reference internal" href="releases.html#v0-4-0">v0.4.0</a></li>
<li class="toctree-l2"><a class="reference internal" href="releases.html#v0-5-0-beta">v0.5.0 (beta)</a></li> </ul>
<li class="toctree-l2"><a class="reference internal" href="releases.html#v0-4-0">v0.4.0</a></li> </li>
</ul> <li class="toctree-l1"><a class="reference internal" href="functionallity.html">Functionallity</a><ul>
</li> <li class="toctree-l2"><a class="reference internal" href="functionallity.html#the-main-differences">The main differences</a></li>
<li class="toctree-l1"><a class="reference internal" href="functionallity.html">Functionallity</a><ul> <li class="toctree-l2"><a class="reference internal" href="functionallity.html#other-features">Other features</a></li>
<li class="toctree-l2"><a class="reference internal" href="functionallity.html#the-main-differences">The main differences</a></li> <li class="toctree-l2"><a class="reference internal" href="functionallity.html#experimental-features">Experimental features</a></li>
<li class="toctree-l2"><a class="reference internal" href="functionallity.html#other-features">Other features</a></li> <li class="toctree-l2"><a class="reference internal" href="functionallity.html#typical-performance">Typical performance</a></li>
<li class="toctree-l2"><a class="reference internal" href="functionallity.html#experimental-features">Experimental features</a></li> </ul>
</ul> </li>
</li> <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a><ul>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a><ul> <li class="toctree-l2"><a class="reference internal" href="installation.html#official-esptool">Official esptool</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#official-esptool">Official esptool</a></li> <li class="toctree-l2"><a class="reference internal" href="installation.html#configuring-wifi">Configuring WIFI</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#configuring-wifi">Configuring WIFI</a></li> </ul>
</ul> </li>
</li> <li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a><ul>
<li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a><ul> <li class="toctree-l2"><a class="reference internal" href="configuration.html#status">Status</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration.html#status">Status</a></li> <li class="toctree-l2"><a class="reference internal" href="configuration.html#device">Device</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration.html#device">Device</a></li> <li class="toctree-l2"><a class="reference internal" href="configuration.html#id1">Configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration.html#id1">Configuration</a></li> <li class="toctree-l2"><a class="reference internal" href="configuration.html#create-formula">Create formula</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration.html#create-formula">Create formula</a></li> <li class="toctree-l2"><a class="reference internal" href="configuration.html#rest-api">REST API</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration.html#rest-api">REST API</a></li> <li class="toctree-l2"><a class="reference internal" href="configuration.html#data-formats">Data Formats</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration.html#data-formats">Data Formats</a></li> </ul>
</ul> </li>
</li> <li class="toctree-l1"><a class="reference internal" href="compiling.html">Compiling the software</a><ul>
<li class="toctree-l1"><a class="reference internal" href="compiling.html">Compiling the software</a><ul> <li class="toctree-l2"><a class="reference internal" href="compiling.html#tools">Tools</a></li>
<li class="toctree-l2"><a class="reference internal" href="compiling.html#tools">Tools</a></li> <li class="toctree-l2"><a class="reference internal" href="compiling.html#code-formatting">Code Formatting</a></li>
<li class="toctree-l2"><a class="reference internal" href="compiling.html#code-formatting">Code Formatting</a></li> <li class="toctree-l2"><a class="reference internal" href="compiling.html#targets">Targets</a></li>
<li class="toctree-l2"><a class="reference internal" href="compiling.html#targets">Targets</a></li> <li class="toctree-l2"><a class="reference internal" href="compiling.html#source-structure">Source structure</a></li>
<li class="toctree-l2"><a class="reference internal" href="compiling.html#source-structure">Source structure</a></li> <li class="toctree-l2"><a class="reference internal" href="compiling.html#options">Options</a></li>
<li class="toctree-l2"><a class="reference internal" href="compiling.html#options">Options</a></li> </ul>
</ul> </li>
</li> <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li> <li class="toctree-l1"><a class="reference internal" href="backlog.html">Backlog of changes</a><ul>
<li class="toctree-l1"><a class="reference internal" href="backlog.html">Backlog of changes</a><ul> <li class="toctree-l2"><a class="reference internal" href="backlog.html#documentation">Documentation</a></li>
<li class="toctree-l2"><a class="reference internal" href="backlog.html#documentation">Documentation</a></li> <li class="toctree-l2"><a class="reference internal" href="backlog.html#code">Code</a></li>
<li class="toctree-l2"><a class="reference internal" href="backlog.html#code">Code</a></li> </ul>
</ul> </li>
</li> </ul>
</ul> </div>
</div> <div class="section" id="indices-and-tables">
<section id="indices-and-tables"> <h3>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline"></a></h3>
<h3>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline"></a></h3> <ul class="simple">
<ul class="simple"> <li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li> <li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li> <li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li> </ul>
</ul> </div>
</section> </div>
</section> </div>
</section>
</div>
</div> </div>
</div> <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> <a href="releases.html" class="btn btn-neutral float-right" title="Releases" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="releases.html" class="btn btn-neutral float-right" title="Releases" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> </div>
</div>
<hr/>
<hr/>
<div role="contentinfo">
<div role="contentinfo"> <p>&#169; Copyright 2021-2022, Magnus Persson.</p>
<p>&#169; Copyright 2021-2022, Magnus Persson.</p> </div>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</footer> </div>
</div> </div>
</div> </section>
</section> </div>
</div> <script>
<script> jQuery(function () {
jQuery(function () { SphinxRtdTheme.Navigation.enable(true);
SphinxRtdTheme.Navigation.enable(true); });
}); </script>
</script>
</body>
</body>
</html> </html>

288
docs/installation.html
View File

@ -1,146 +1,144 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" >
<head> <head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> <meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>Installation &mdash; GravityMon 0.5.0 documentation</title><link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<title>Installation &mdash; GravityMon 0.5.0 documentation</title> <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <!--[if lt IE 9]>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> <script src="_static/js/html5shiv.min.js"></script>
<!--[if lt IE 9]> <![endif]-->
<script src="_static/js/html5shiv.min.js"></script> <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<![endif]--> <script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> <script src="_static/doctools.js"></script>
<script src="_static/jquery.js"></script> <script src="_static/language_data.js"></script>
<script src="_static/underscore.js"></script> <script src="_static/js/theme.js"></script>
<script src="_static/doctools.js"></script> <link rel="index" title="Index" href="genindex.html" />
<script src="_static/js/theme.js"></script> <link rel="search" title="Search" href="search.html" />
<link rel="index" title="Index" href="genindex.html" /> <link rel="next" title="Configuration" href="configuration.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="prev" title="Functionallity" href="functionallity.html" />
<link rel="next" title="Configuration" href="configuration.html" /> </head>
<link rel="prev" title="Functionallity" href="functionallity.html" />
</head> <body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<body class="wy-body-for-nav"> <nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-grid-for-nav"> <div class="wy-side-scroll">
<nav data-toggle="wy-nav-shift" class="wy-nav-side"> <div class="wy-side-nav-search" >
<div class="wy-side-scroll"> <a href="index.html" class="icon icon-home"> GravityMon
<div class="wy-side-nav-search" > </a>
<a href="index.html" class="icon icon-home"> GravityMon <div role="search">
</a> <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<div role="search"> <input type="text" name="q" placeholder="Search docs" />
<form id="rtd-search-form" class="wy-form" action="search.html" method="get"> <input type="hidden" name="check_keywords" value="yes" />
<input type="text" name="q" placeholder="Search docs" /> <input type="hidden" name="area" value="default" />
<input type="hidden" name="check_keywords" value="yes" /> </form>
<input type="hidden" name="area" value="default" /> </div>
</form> </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
</div> <p class="caption"><span class="caption-text">Contents:</span></p>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> <ul class="current">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p> <li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
<ul class="current"> <li class="toctree-l1"><a class="reference internal" href="functionallity.html">Functionallity</a></li>
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li> <li class="toctree-l1 current"><a class="current reference internal" href="#">Installation</a><ul>
<li class="toctree-l1"><a class="reference internal" href="functionallity.html">Functionallity</a></li> <li class="toctree-l2"><a class="reference internal" href="#official-esptool">Official esptool</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Installation</a><ul> <li class="toctree-l2"><a class="reference internal" href="#configuring-wifi">Configuring WIFI</a></li>
<li class="toctree-l2"><a class="reference internal" href="#official-esptool">Official esptool</a></li> </ul>
<li class="toctree-l2"><a class="reference internal" href="#configuring-wifi">Configuring WIFI</a></li> </li>
</ul> <li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a></li>
</li> <li class="toctree-l1"><a class="reference internal" href="compiling.html">Compiling the software</a></li>
<li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a></li> <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
<li class="toctree-l1"><a class="reference internal" href="compiling.html">Compiling the software</a></li> <li class="toctree-l1"><a class="reference internal" href="backlog.html">Backlog of changes</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li> </ul>
<li class="toctree-l1"><a class="reference internal" href="backlog.html">Backlog of changes</a></li>
</ul> </div>
</div>
</div> </nav>
</div>
</nav> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > <a href="index.html">GravityMon</a>
<i data-toggle="wy-nav-top" class="fa fa-bars"></i> </nav>
<a href="index.html">GravityMon</a>
</nav> <div class="wy-nav-content">
<div class="rst-content">
<div class="wy-nav-content"> <div role="navigation" aria-label="Page navigation">
<div class="rst-content"> <ul class="wy-breadcrumbs">
<div role="navigation" aria-label="Page navigation"> <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<ul class="wy-breadcrumbs"> <li>Installation</li>
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li> <li class="wy-breadcrumbs-aside">
<li>Installation</li> <a href="_sources/installation.rst.txt" rel="nofollow"> View page source</a>
<li class="wy-breadcrumbs-aside"> </li>
<a href="_sources/installation.rst.txt" rel="nofollow"> View page source</a> </ul>
</li> <hr/>
</ul> </div>
<hr/> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
</div> <div itemprop="articleBody">
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody"> <div class="section" id="installation">
<h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline"></a></h1>
<section id="installation"> <div class="section" id="official-esptool">
<h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline"></a></h1> <h2>Official esptool<a class="headerlink" href="#official-esptool" title="Permalink to this headline"></a></h2>
<section id="official-esptool"> <p>The prefered option for flashing esp8266 device is via the official esptool. Documentation can be found
<h2>Official esptool<a class="headerlink" href="#official-esptool" title="Permalink to this headline"></a></h2> here; <a class="reference external" href="https://docs.espressif.com/projects/esptool/en/latest/esp32/">https://docs.espressif.com/projects/esptool/en/latest/esp32/</a></p>
<p>The prefered option for flashing esp8266 device is via the official esptool. Documentation can be found <p>The basic command for flashing on Windows is;</p>
here; <a class="reference external" href="https://docs.espressif.com/projects/esptool/en/latest/esp32/">https://docs.espressif.com/projects/esptool/en/latest/esp32/</a></p> <p><code class="docutils literal notranslate"><span class="pre">esptool.py</span> <span class="pre">--port</span> <span class="pre">COM4</span> <span class="pre">write_flash</span> <span class="pre">0x0</span> <span class="pre">firmware.bin</span></code></p>
<p>The basic command for flashing on Windows is;</p> <p>In the /bin directory you will find 3 different firmware builds;</p>
<p><code class="docutils literal notranslate"><span class="pre">esptool.py</span> <span class="pre">--port</span> <span class="pre">COM4</span> <span class="pre">write_flash</span> <span class="pre">0x0</span> <span class="pre">firmware.bin</span></code></p> <ul>
<p>In the /bin directory you will find 3 different firmware builds;</p> <li><p><strong>firmware.bin</strong></p>
<ul> <p>This is the standard release build (prefered version)</p>
<li><p><strong>firmware.bin</strong></p> </li>
<p>This is the standard release build (prefered version)</p> <li><p><strong>firmware-perf.bin</strong></p>
</li> <p>This version also submits performance data to an influx database with detailed execution times.</p>
<li><p><strong>firmware-perf.bin</strong></p> </li>
<p>This version also submits performance data to an influx database with detailed execution times.</p> <li><p><strong>firmware-debug.bin</strong></p>
</li> <p>Development build. Not recommended for normal use.</p>
<li><p><strong>firmware-debug.bin</strong></p> </li>
<p>Development build. Not recommended for normal use.</p> </ul>
</li> <p>In these versions all the html files are embedded in the binaries. The file system is currently only used for storing
</ul> the configuration file.</p>
<p>In these versions all the html files are embedded in the binaries. The file system is currently only used for storing <p>If the software becomes so large the html files can be moved to the file system, but this is not enabled by
the configuration file.</p> default (see compiling for details). This approach makes installation much easier and ensure that html files
<p>If the software becomes so large the html files can be moved to the file system, but this is not enabled by and code is in sync.</p>
default (see compiling for details). This approach makes installation much easier and ensure that html files </div>
and code is in sync.</p> <div class="section" id="configuring-wifi">
</section> <h2>Configuring WIFI<a class="headerlink" href="#configuring-wifi" title="Permalink to this headline"></a></h2>
<section id="configuring-wifi"> <p>When the device is flashed it will need to have WIFI configuration in order to work. If you have used other software on
<h2>Configuring WIFI<a class="headerlink" href="#configuring-wifi" title="Permalink to this headline"></a></h2> the device its possible that wifi settings exist.</p>
<p>When the device is flashed it will need to have WIFI configuration in order to work. If you have used other software on <p>If this is not configured in the device it will create an wirless access point called <cite>GravMon</cite>. Connect to this AP and
the device its possible that wifi settings exist.</p> enter the SSID and password you want to use. If the web page dont open automatically you can enter the following adress
<p>If this is not configured in the device it will create an wirless access point called <cite>GravMon</cite>. Connect to this AP and in the browser: <strong>http://192.168.4.1</strong></p>
enter the SSID and password you want to use. If the web page dont open automatically you can enter the following adress </div>
in the browser: <strong>http://192.168.4.1</strong></p> </div>
</section>
</section>
</div>
</div>
</div> <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
</div> <a href="functionallity.html" class="btn btn-neutral float-left" title="Functionallity" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> <a href="configuration.html" class="btn btn-neutral float-right" title="Configuration" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="functionallity.html" class="btn btn-neutral float-left" title="Functionallity" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> </div>
<a href="configuration.html" class="btn btn-neutral float-right" title="Configuration" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div> <hr/>
<hr/> <div role="contentinfo">
<p>&#169; Copyright 2021-2022, Magnus Persson.</p>
<div role="contentinfo"> </div>
<p>&#169; Copyright 2021-2022, Magnus Persson.</p>
</div> Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a provided by <a href="https://readthedocs.org">Read the Docs</a>.
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</footer> </div>
</div> </section>
</div> </div>
</section> <script>
</div> jQuery(function () {
<script> SphinxRtdTheme.Navigation.enable(true);
jQuery(function () { });
SphinxRtdTheme.Navigation.enable(true); </script>
});
</script> </body>
</body>
</html> </html>

BIN
docs/objects.inv
View File

Binary file not shown.

258
docs/releases.html
View File

@ -1,131 +1,129 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" >
<head> <head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> <meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>Releases &mdash; GravityMon 0.5.0 documentation</title><link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<title>Releases &mdash; GravityMon 0.5.0 documentation</title> <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <!--[if lt IE 9]>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> <script src="_static/js/html5shiv.min.js"></script>
<!--[if lt IE 9]> <![endif]-->
<script src="_static/js/html5shiv.min.js"></script> <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<![endif]--> <script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> <script src="_static/doctools.js"></script>
<script src="_static/jquery.js"></script> <script src="_static/language_data.js"></script>
<script src="_static/underscore.js"></script> <script src="_static/js/theme.js"></script>
<script src="_static/doctools.js"></script> <link rel="index" title="Index" href="genindex.html" />
<script src="_static/js/theme.js"></script> <link rel="search" title="Search" href="search.html" />
<link rel="index" title="Index" href="genindex.html" /> <link rel="next" title="Functionallity" href="functionallity.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="prev" title="Welcome to GravityMon’s documentation!" href="index.html" />
<link rel="next" title="Functionallity" href="functionallity.html" /> </head>
<link rel="prev" title="Welcome to GravityMon’s documentation!" href="index.html" />
</head> <body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<body class="wy-body-for-nav"> <nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-grid-for-nav"> <div class="wy-side-scroll">
<nav data-toggle="wy-nav-shift" class="wy-nav-side"> <div class="wy-side-nav-search" >
<div class="wy-side-scroll"> <a href="index.html" class="icon icon-home"> GravityMon
<div class="wy-side-nav-search" > </a>
<a href="index.html" class="icon icon-home"> GravityMon <div role="search">
</a> <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<div role="search"> <input type="text" name="q" placeholder="Search docs" />
<form id="rtd-search-form" class="wy-form" action="search.html" method="get"> <input type="hidden" name="check_keywords" value="yes" />
<input type="text" name="q" placeholder="Search docs" /> <input type="hidden" name="area" value="default" />
<input type="hidden" name="check_keywords" value="yes" /> </form>
<input type="hidden" name="area" value="default" /> </div>
</form> </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
</div> <p class="caption"><span class="caption-text">Contents:</span></p>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> <ul class="current">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p> <li class="toctree-l1 current"><a class="current reference internal" href="#">Releases</a><ul>
<ul class="current"> <li class="toctree-l2"><a class="reference internal" href="#v0-5-0-beta">v0.5.0 (beta)</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Releases</a><ul> <li class="toctree-l2"><a class="reference internal" href="#v0-4-0">v0.4.0</a></li>
<li class="toctree-l2"><a class="reference internal" href="#v0-5-0-beta">v0.5.0 (beta)</a></li> </ul>
<li class="toctree-l2"><a class="reference internal" href="#v0-4-0">v0.4.0</a></li> </li>
</ul> <li class="toctree-l1"><a class="reference internal" href="functionallity.html">Functionallity</a></li>
</li> <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="functionallity.html">Functionallity</a></li> <li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li> <li class="toctree-l1"><a class="reference internal" href="compiling.html">Compiling the software</a></li>
<li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a></li> <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
<li class="toctree-l1"><a class="reference internal" href="compiling.html">Compiling the software</a></li> <li class="toctree-l1"><a class="reference internal" href="backlog.html">Backlog of changes</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li> </ul>
<li class="toctree-l1"><a class="reference internal" href="backlog.html">Backlog of changes</a></li>
</ul> </div>
</div>
</div> </nav>
</div>
</nav> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > <a href="index.html">GravityMon</a>
<i data-toggle="wy-nav-top" class="fa fa-bars"></i> </nav>
<a href="index.html">GravityMon</a>
</nav> <div class="wy-nav-content">
<div class="rst-content">
<div class="wy-nav-content"> <div role="navigation" aria-label="Page navigation">
<div class="rst-content"> <ul class="wy-breadcrumbs">
<div role="navigation" aria-label="Page navigation"> <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<ul class="wy-breadcrumbs"> <li>Releases</li>
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li> <li class="wy-breadcrumbs-aside">
<li>Releases</li> <a href="_sources/releases.rst.txt" rel="nofollow"> View page source</a>
<li class="wy-breadcrumbs-aside"> </li>
<a href="_sources/releases.rst.txt" rel="nofollow"> View page source</a> </ul>
</li> <hr/>
</ul> </div>
<hr/> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
</div> <div itemprop="articleBody">
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody"> <div class="section" id="releases">
<h1>Releases<a class="headerlink" href="#releases" title="Permalink to this headline"></a></h1>
<section id="releases"> <div class="section" id="v0-5-0-beta">
<h1>Releases<a class="headerlink" href="#releases" title="Permalink to this headline"></a></h1> <h2>v0.5.0 (beta)<a class="headerlink" href="#v0-5-0-beta" title="Permalink to this headline"></a></h2>
<section id="v0-5-0-beta"> <p>Latest next target version is: <strong>v0.5.0</strong>. This is hosted in the <strong>dev branch</strong>.</p>
<h2>v0.5.0 (beta)<a class="headerlink" href="#v0-5-0-beta" title="Permalink to this headline"></a></h2> <ul class="simple">
<p>Latest next target version is: <strong>v0.5.0</strong>. This is hosted in the <strong>dev branch</strong>.</p> <li><p>Added feature to calcuate formula on device</p></li>
<ul class="simple"> <li><p>Total rewrite of documentation</p></li>
<li><p>Added feature to calcuate formula on device</p></li> <li><p>WIFI settings are now stored in config file</p></li>
<li><p>Total rewrite of documentation</p></li> <li><p>Defined version numbers for all dependant libraries to avoid updates breaking build.</p></li>
<li><p>WIFI settings are now stored in config file</p></li> <li><p>Cleanup of code</p></li>
<li><p>Defined version numbers for all dependant libraries to avoid updates breaking build.</p></li> <li><p>Refactor code from C to C++</p></li>
<li><p>Cleanup of code</p></li> </ul>
<li><p>Refactor code from C to C++</p></li> </div>
</ul> <div class="section" id="v0-4-0">
</section> <h2>v0.4.0<a class="headerlink" href="#v0-4-0" title="Permalink to this headline"></a></h2>
<section id="v0-4-0"> <p>Latest stable development version is: <strong>v0.4.0</strong></p>
<h2>v0.4.0<a class="headerlink" href="#v0-4-0" title="Permalink to this headline"></a></h2> <p><a class="reference external" href="https://github.com/mp-se/gravitymon/releases/tag/v0.4.0">https://github.com/mp-se/gravitymon/releases/tag/v0.4.0</a></p>
<p>Latest stable development version is: <strong>v0.4.0</strong></p> </div>
<p><a class="reference external" href="https://github.com/mp-se/gravitymon/releases/tag/v0.4.0">https://github.com/mp-se/gravitymon/releases/tag/v0.4.0</a></p> </div>
</section>
</section>
</div>
</div>
</div> <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
</div> <a href="index.html" class="btn btn-neutral float-left" title="Welcome to GravityMon’s documentation!" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> <a href="functionallity.html" class="btn btn-neutral float-right" title="Functionallity" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="index.html" class="btn btn-neutral float-left" title="Welcome to GravityMon’s documentation!" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> </div>
<a href="functionallity.html" class="btn btn-neutral float-right" title="Functionallity" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div> <hr/>
<hr/> <div role="contentinfo">
<p>&#169; Copyright 2021-2022, Magnus Persson.</p>
<div role="contentinfo"> </div>
<p>&#169; Copyright 2021-2022, Magnus Persson.</p>
</div> Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a provided by <a href="https://readthedocs.org">Read the Docs</a>.
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</footer> </div>
</div> </section>
</div> </div>
</section> <script>
</div> jQuery(function () {
<script> SphinxRtdTheme.Navigation.enable(true);
jQuery(function () { });
SphinxRtdTheme.Navigation.enable(true); </script>
});
</script> </body>
</body>
</html> </html>

239
docs/search.html
View File

@ -1,121 +1,120 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" >
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Search &mdash; GravityMon 0.5.0 documentation</title> <title>Search &mdash; GravityMon 0.5.0 documentation</title><link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<!--[if lt IE 9]> <script src="_static/js/html5shiv.min.js"></script>
<script src="_static/js/html5shiv.min.js"></script> <![endif]-->
<![endif]--> <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> <script src="_static/underscore.js"></script>
<script src="_static/jquery.js"></script> <script src="_static/doctools.js"></script>
<script src="_static/underscore.js"></script> <script src="_static/language_data.js"></script>
<script src="_static/doctools.js"></script> <script src="_static/js/theme.js"></script>
<script src="_static/js/theme.js"></script> <script src="_static/searchtools.js"></script>
<script src="_static/searchtools.js"></script> <script src="_static/language_data.js"></script>
<script src="_static/language_data.js"></script> <link rel="index" title="Index" href="genindex.html" />
<link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="#" />
<link rel="search" title="Search" href="#" /> </head>
</head>
<body class="wy-body-for-nav">
<body class="wy-body-for-nav"> <div class="wy-grid-for-nav">
<div class="wy-grid-for-nav"> <nav data-toggle="wy-nav-shift" class="wy-nav-side">
<nav data-toggle="wy-nav-shift" class="wy-nav-side"> <div class="wy-side-scroll">
<div class="wy-side-scroll"> <div class="wy-side-nav-search" >
<div class="wy-side-nav-search" > <a href="index.html" class="icon icon-home"> GravityMon
<a href="index.html" class="icon icon-home"> GravityMon </a>
</a> <div role="search">
<div role="search"> <form id="rtd-search-form" class="wy-form" action="#" method="get">
<form id="rtd-search-form" class="wy-form" action="#" method="get"> <input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" /> <input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" />
<input type="hidden" name="area" value="default" /> </form>
</form> </div>
</div> </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> <p class="caption"><span class="caption-text">Contents:</span></p>
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p> <ul>
<ul> <li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li> <li class="toctree-l1"><a class="reference internal" href="functionallity.html">Functionallity</a></li>
<li class="toctree-l1"><a class="reference internal" href="functionallity.html">Functionallity</a></li> <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li> <li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a></li> <li class="toctree-l1"><a class="reference internal" href="compiling.html">Compiling the software</a></li>
<li class="toctree-l1"><a class="reference internal" href="compiling.html">Compiling the software</a></li> <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li> <li class="toctree-l1"><a class="reference internal" href="backlog.html">Backlog of changes</a></li>
<li class="toctree-l1"><a class="reference internal" href="backlog.html">Backlog of changes</a></li> </ul>
</ul>
</div>
</div> </div>
</div> </nav>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<i data-toggle="wy-nav-top" class="fa fa-bars"></i> <a href="index.html">GravityMon</a>
<a href="index.html">GravityMon</a> </nav>
</nav>
<div class="wy-nav-content">
<div class="wy-nav-content"> <div class="rst-content">
<div class="rst-content"> <div role="navigation" aria-label="Page navigation">
<div role="navigation" aria-label="Page navigation"> <ul class="wy-breadcrumbs">
<ul class="wy-breadcrumbs"> <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li> <li>Search</li>
<li>Search</li> <li class="wy-breadcrumbs-aside">
<li class="wy-breadcrumbs-aside"> </li>
</li> </ul>
</ul> <hr/>
<hr/> </div>
</div> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div itemprop="articleBody">
<div itemprop="articleBody">
<noscript>
<noscript> <div id="fallback" class="admonition warning">
<div id="fallback" class="admonition warning"> <p class="last">
<p class="last"> Please activate JavaScript to enable the search functionality.
Please activate JavaScript to enable the search functionality. </p>
</p> </div>
</div> </noscript>
</noscript>
<div id="search-results">
<div id="search-results">
</div>
</div>
</div>
</div> </div>
</div> <footer>
<footer>
<hr/>
<hr/>
<div role="contentinfo">
<div role="contentinfo"> <p>&#169; Copyright 2021-2022, Magnus Persson.</p>
<p>&#169; Copyright 2021-2022, Magnus Persson.</p> </div>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</footer> </div>
</div> </div>
</div> </section>
</section> </div>
</div> <script>
<script> jQuery(function () {
jQuery(function () { SphinxRtdTheme.Navigation.enable(true);
SphinxRtdTheme.Navigation.enable(true); });
}); </script>
</script> <script>
<script> jQuery(function() { Search.loadIndex("searchindex.js"); });
jQuery(function() { Search.loadIndex("searchindex.js"); }); </script>
</script>
<script id="searchindexloader"></script>
<script id="searchindexloader"></script>
</body>
</body>
</html> </html>

2
docs/searchindex.js
View File

File diff suppressed because one or more lines are too long

316
docs/styling.html
View File

@ -1,160 +1,158 @@
<!DOCTYPE html> <!DOCTYPE html>
<html class="writer-html5" lang="en" > <html class="writer-html5" lang="en" >
<head> <head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> <meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>Testing formatting &mdash; GravityMon 0.5.0 documentation</title><link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<title>Testing formatting &mdash; GravityMon 0.5.0 documentation</title> <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <!--[if lt IE 9]>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> <script src="_static/js/html5shiv.min.js"></script>
<!--[if lt IE 9]> <![endif]-->
<script src="_static/js/html5shiv.min.js"></script> <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<![endif]--> <script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> <script src="_static/doctools.js"></script>
<script src="_static/jquery.js"></script> <script src="_static/language_data.js"></script>
<script src="_static/underscore.js"></script> <script src="_static/js/theme.js"></script>
<script src="_static/doctools.js"></script> <link rel="index" title="Index" href="genindex.html" />
<script src="_static/js/theme.js"></script> <link rel="search" title="Search" href="search.html" />
<link rel="index" title="Index" href="genindex.html" /> </head>
<link rel="search" title="Search" href="search.html" />
</head> <body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<body class="wy-body-for-nav"> <nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-grid-for-nav"> <div class="wy-side-scroll">
<nav data-toggle="wy-nav-shift" class="wy-nav-side"> <div class="wy-side-nav-search" >
<div class="wy-side-scroll"> <a href="index.html" class="icon icon-home"> GravityMon
<div class="wy-side-nav-search" > </a>
<a href="index.html" class="icon icon-home"> GravityMon <div role="search">
</a> <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<div role="search"> <input type="text" name="q" placeholder="Search docs" />
<form id="rtd-search-form" class="wy-form" action="search.html" method="get"> <input type="hidden" name="check_keywords" value="yes" />
<input type="text" name="q" placeholder="Search docs" /> <input type="hidden" name="area" value="default" />
<input type="hidden" name="check_keywords" value="yes" /> </form>
<input type="hidden" name="area" value="default" /> </div>
</form> </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
</div> <p class="caption"><span class="caption-text">Contents:</span></p>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> <ul>
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p> <li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
<ul> <li class="toctree-l1"><a class="reference internal" href="functionallity.html">Functionallity</a></li>
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li> <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="functionallity.html">Functionallity</a></li> <li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li> <li class="toctree-l1"><a class="reference internal" href="compiling.html">Compiling the software</a></li>
<li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a></li> <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
<li class="toctree-l1"><a class="reference internal" href="compiling.html">Compiling the software</a></li> <li class="toctree-l1"><a class="reference internal" href="backlog.html">Backlog of changes</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li> </ul>
<li class="toctree-l1"><a class="reference internal" href="backlog.html">Backlog of changes</a></li>
</ul> </div>
</div>
</div> </nav>
</div>
</nav> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > <a href="index.html">GravityMon</a>
<i data-toggle="wy-nav-top" class="fa fa-bars"></i> </nav>
<a href="index.html">GravityMon</a>
</nav> <div class="wy-nav-content">
<div class="rst-content">
<div class="wy-nav-content"> <div role="navigation" aria-label="Page navigation">
<div class="rst-content"> <ul class="wy-breadcrumbs">
<div role="navigation" aria-label="Page navigation"> <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<ul class="wy-breadcrumbs"> <li>Testing formatting</li>
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li> <li class="wy-breadcrumbs-aside">
<li>Testing formatting</li> <a href="_sources/styling.rst.txt" rel="nofollow"> View page source</a>
<li class="wy-breadcrumbs-aside"> </li>
<a href="_sources/styling.rst.txt" rel="nofollow"> View page source</a> </ul>
</li> <hr/>
</ul> </div>
<hr/> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
</div> <div itemprop="articleBody">
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody"> <div class="section" id="testing-formatting">
<h1>Testing formatting<a class="headerlink" href="#testing-formatting" title="Permalink to this headline"></a></h1>
<section id="testing-formatting"> <div class="section" id="header-1">
<h1>Testing formatting<a class="headerlink" href="#testing-formatting" title="Permalink to this headline"></a></h1> <h2>Header 1<a class="headerlink" href="#header-1" title="Permalink to this headline"></a></h2>
<section id="header-1"> </div>
<h2>Header 1<a class="headerlink" href="#header-1" title="Permalink to this headline"></a></h2> </div>
</section> <div class="section" id="header-2">
</section> <h1>Header 2<a class="headerlink" href="#header-2" title="Permalink to this headline"></a></h1>
<section id="header-2"> <p><strong>BOLD</strong></p>
<h1>Header 2<a class="headerlink" href="#header-2" title="Permalink to this headline"></a></h1> <p><em>ITALIC</em></p>
<p><strong>BOLD</strong></p> <p><code class="docutils literal notranslate"><span class="pre">CODE</span> <span class="pre">SAMPLE</span></code></p>
<p><em>ITALIC</em></p> <ol class="arabic simple">
<p><code class="docutils literal notranslate"><span class="pre">CODE</span> <span class="pre">SAMPLE</span></code></p> <li><p>List</p></li>
<ol class="arabic simple"> <li><p>List</p></li>
<li><p>List</p></li> </ol>
<li><p>List</p></li> <ul class="simple">
</ol> <li><p>List</p></li>
<ul class="simple"> <li><p>List</p></li>
<li><p>List</p></li> </ul>
<li><p>List</p></li> <table class="colwidths-given docutils align-default" id="id1">
</ul> <caption><span class="caption-text">Table</span><a class="headerlink" href="#id1" title="Permalink to this table"></a></caption>
<table class="colwidths-given docutils align-default" id="id1"> <colgroup>
<caption><span class="caption-text">Table</span><a class="headerlink" href="#id1" title="Permalink to this table"></a></caption> <col style="width: 40%" />
<colgroup> <col style="width: 60%" />
<col style="width: 40%" /> </colgroup>
<col style="width: 60%" /> <thead>
</colgroup> <tr class="row-odd"><th class="head"><p>table</p></th>
<thead> <th class="head"><p>table</p></th>
<tr class="row-odd"><th class="head"><p>table</p></th> </tr>
<th class="head"><p>table</p></th> </thead>
</tr> <tbody>
</thead> <tr class="row-even"><td><p>content</p></td>
<tbody> <td><p>content</p></td>
<tr class="row-even"><td><p>content</p></td> </tr>
<td><p>content</p></td> </tbody>
</tr> </table>
</tbody> <a class="reference internal image-reference" href="_images/formula1.png"><img alt="image" src="_images/formula1.png" style="width: 400px;" /></a>
</table> <div class="highlight-objdump notranslate"><div class="highlight"><pre><span></span><span class="x">measurement,host=&lt;mdns&gt;,device=&lt;id&gt;,temp-format=&lt;C|F&gt;,gravity-format=SG,gravity=1.0004,corr-gravity=1.0004,angle=45.45,temp=20.1,battery=3.96,rssi=-18</span>
<a class="reference internal image-reference" href="_images/formula1.png"><img alt="image" src="_images/formula1.png" style="width: 400px;" /></a> </pre></div>
<div class="highlight-objdump notranslate"><div class="highlight"><pre><span></span><span class="x">measurement,host=&lt;mdns&gt;,device=&lt;id&gt;,temp-format=&lt;C|F&gt;,gravity-format=SG,gravity=1.0004,corr-gravity=1.0004,angle=45.45,temp=20.1,battery=3.96,rssi=-18</span> </div>
</pre></div> <div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
</div> <span class="nt">&quot;project&quot;</span><span class="p">:</span><span class="s2">&quot;gravmon&quot;</span><span class="p">,</span>
<div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span><span class="w"></span> <span class="nt">&quot;version&quot;</span><span class="p">:</span><span class="s2">&quot;0.4.10&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;project&quot;</span><span class="p">:</span><span class="s2">&quot;gravmon&quot;</span><span class="p">,</span><span class="w"></span> <span class="nt">&quot;html&quot;</span><span class="p">:</span> <span class="p">[</span>
<span class="w"> </span><span class="nt">&quot;version&quot;</span><span class="p">:</span><span class="s2">&quot;0.4.10&quot;</span><span class="p">,</span><span class="w"></span> <span class="s2">&quot;index.min.htm&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;html&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w"></span> <span class="s2">&quot;device.min.htm&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s2">&quot;index.min.htm&quot;</span><span class="p">,</span><span class="w"></span> <span class="s2">&quot;config.min.htm&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s2">&quot;device.min.htm&quot;</span><span class="p">,</span><span class="w"></span> <span class="s2">&quot;calibration.min.htm&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s2">&quot;config.min.htm&quot;</span><span class="p">,</span><span class="w"></span> <span class="s2">&quot;about.min.htm&quot;</span>
<span class="w"> </span><span class="s2">&quot;calibration.min.htm&quot;</span><span class="p">,</span><span class="w"></span> <span class="p">]</span>
<span class="w"> </span><span class="s2">&quot;about.min.htm&quot;</span><span class="w"></span> <span class="p">}</span>
<span class="w"> </span><span class="p">]</span><span class="w"></span> </pre></div>
<span class="p">}</span><span class="w"></span> </div>
</pre></div> <div class="admonition note">
</div> <p class="admonition-title">Note</p>
<div class="admonition note"> <p>Note…</p>
<p class="admonition-title">Note</p> </div>
<p>Note…</p> </div>
</div>
</section>
</div>
</div>
</div> <footer>
</div>
<footer> <hr/>
<hr/> <div role="contentinfo">
<p>&#169; Copyright 2021-2022, Magnus Persson.</p>
<div role="contentinfo"> </div>
<p>&#169; Copyright 2021-2022, Magnus Persson.</p>
</div> Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a provided by <a href="https://readthedocs.org">Read the Docs</a>.
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</footer> </div>
</div> </section>
</div> </div>
</section> <script>
</div> jQuery(function () {
<script> SphinxRtdTheme.Navigation.enable(true);
jQuery(function () { });
SphinxRtdTheme.Navigation.enable(true); </script>
});
</script> </body>
</body>
</html> </html>