diff --git a/docs/sphinx/build/doctrees/environment.pickle b/docs/sphinx/build/doctrees/environment.pickle new file mode 100644 index 0000000..16926ba Binary files /dev/null and b/docs/sphinx/build/doctrees/environment.pickle differ diff --git a/docs/sphinx/build/doctrees/hardware/hw.doctree b/docs/sphinx/build/doctrees/hardware/hw.doctree new file mode 100644 index 0000000..aeb7654 Binary files /dev/null and b/docs/sphinx/build/doctrees/hardware/hw.doctree differ diff --git a/docs/sphinx/build/doctrees/hardware/hw_description.doctree b/docs/sphinx/build/doctrees/hardware/hw_description.doctree new file mode 100644 index 0000000..82cde1e Binary files /dev/null and b/docs/sphinx/build/doctrees/hardware/hw_description.doctree differ diff --git a/docs/sphinx/build/doctrees/hardware/hw_description_md.doctree b/docs/sphinx/build/doctrees/hardware/hw_description_md.doctree new file mode 100644 index 0000000..5db4799 Binary files /dev/null and b/docs/sphinx/build/doctrees/hardware/hw_description_md.doctree differ diff --git a/docs/sphinx/build/doctrees/index.doctree b/docs/sphinx/build/doctrees/index.doctree new file mode 100644 index 0000000..4ba1606 Binary files /dev/null and b/docs/sphinx/build/doctrees/index.doctree differ diff --git a/docs/sphinx/build/doctrees/other/CV_list.doctree b/docs/sphinx/build/doctrees/other/CV_list.doctree new file mode 100644 index 0000000..177f8eb Binary files /dev/null and b/docs/sphinx/build/doctrees/other/CV_list.doctree differ diff --git a/docs/sphinx/build/doctrees/other/getting_started.doctree b/docs/sphinx/build/doctrees/other/getting_started.doctree new file mode 100644 index 0000000..4dc3eb0 Binary files /dev/null and b/docs/sphinx/build/doctrees/other/getting_started.doctree differ diff --git a/docs/sphinx/build/doctrees/other/troubleshooting.doctree b/docs/sphinx/build/doctrees/other/troubleshooting.doctree new file mode 100644 index 0000000..03eaaa5 Binary files /dev/null and b/docs/sphinx/build/doctrees/other/troubleshooting.doctree differ diff --git a/docs/sphinx/build/doctrees/software/header_files.doctree b/docs/sphinx/build/doctrees/software/header_files.doctree new file mode 100644 index 0000000..f3a1635 Binary files /dev/null and b/docs/sphinx/build/doctrees/software/header_files.doctree differ diff --git a/docs/sphinx/build/doctrees/software/sw.doctree b/docs/sphinx/build/doctrees/software/sw.doctree new file mode 100644 index 0000000..6f2e968 Binary files /dev/null and b/docs/sphinx/build/doctrees/software/sw.doctree differ diff --git a/docs/sphinx/build/doctrees/software/sw_description.doctree b/docs/sphinx/build/doctrees/software/sw_description.doctree new file mode 100644 index 0000000..02edb3e Binary files /dev/null and b/docs/sphinx/build/doctrees/software/sw_description.doctree differ diff --git a/docs/sphinx/build/html/_sources/hardware/hw.rst.txt b/docs/sphinx/build/html/_sources/hardware/hw.rst.txt new file mode 100644 index 0000000..3dd3001 --- /dev/null +++ b/docs/sphinx/build/html/_sources/hardware/hw.rst.txt @@ -0,0 +1,8 @@ +Hardware +================= + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + hw_description \ No newline at end of file diff --git a/docs/sphinx/build/html/_sources/hardware/hw_description.rst.txt b/docs/sphinx/build/html/_sources/hardware/hw_description.rst.txt new file mode 100644 index 0000000..9e74695 --- /dev/null +++ b/docs/sphinx/build/html/_sources/hardware/hw_description.rst.txt @@ -0,0 +1,133 @@ +Hardware Description +==================== + +Overview +-------- + +.. image:: https://github.com/1nct/RP2040-Decoder/blob/main/docs/svg/Block_Diagram.svg + :alt: Block Diagram + +The above block diagram gives a general overview regarding the operation of components. For better illustration it has been divided into four functional blocks. Furthermore, these functional blocks can be subdivided and will be explained below. + +* **Input Stage** + - DCC Signal Level Shift + - Bridge Rectifier & Voltage Regulator +* **Motor Driver** + - Motor Driver + - Back EMF measurement (ADC) +* **General Purpose** + - GPIO + - Auxiliary output +* **Microcontroller** + - Flash memory + - Crystal oscillator + +Characteristics +--------------- +.. table:: Characteristics table + :widths: auto + + ===================================================== ============================= ========= ========= ===== + Parameter Symbol Minimum Maximum Unit + ===================================================== ============================= ========= ========= ===== + Absolute max. DCC Input Voltage V\ :sub:`DCC`\ -25 +25 V + Absolute max. GPIO Voltage\ :sup:`(0)`\ V\ :sub:`PIN`\ -0.5 3.3+0.5 V + Input Voltage High\ :sup:`(0)`\ V\ :sub:`IH`\ 2.145 3.6 V + Input Voltage Low\ :sup:`(0)`\ V\ :sub:`IL`\ 0 1.155 V + Total GPIO Current\ :sup:`(0)`\ I\ :sub:`IOVDD`\ 50 mA + Absolute max. motor output current\ :sup:`(1)`\ I\ :sub:`MOTOR`\ 2.8 A + Absolute max. auxiliary output current \ :sup:`(2)`\ I\ :sub:`AUX`\ 400 mA + ===================================================== ============================= ========= ========= ===== + + +(0): According to: `RP2040 Datasheet `_ (assuming V\ :sub:`DD`\ = 3.3V) + +(1): According to: `BDR6133 Datasheet `_ + +(2): According to: `T2N7002BK Datasheet `_ + +Input Stage +----------- + +.. image:: https://github.com/1nct/RP2040-Decoder/blob/main/docs/svg/Input_Stage.svg + :alt: Input Stage + +D1 Rectifies the DCC square-wave into +V, the amplitude is not critical as long as it's within the 25V limit. The rectified voltage +V is then provided to the 3.3V voltage regulator (U1) and to the motor driver (U2). + +The MOSFET on the right effectively translates the rather high DCC voltage to a suitable level for the microcontroller to process. When Q1 is turned off GPIO21 is pulled high by the RP2040 internal pull-up resistor, as soon as Q1 gets turned on (VGS > VGS,th), GPIO21 gets pulled to GND potential. R1 and R2 ensure that VGS doesn't exceed ±20V. + +Motor Driver +------------ + +.. image:: https://github.com/1nct/RP2040-Decoder/blob/main/docs/svg/Motor_Driver.svg + :alt: Motor Driver + +The Motor Driver is a complete H-Bridge IC specifically made for DC-Motors. + +In order to control the motor, it is necessary to measure the back-EMF. This is done by the ADC, which measures at Points ADC_EMF_A and ADC_EMF_B respectively. The two resistors are used as a voltage divider. + +Auxiliary Output +---------------- + +.. image:: https://github.com/1nct/RP2040-Decoder/blob/main/docs/svg/Aux_Outputs.svg + :alt: Auxiliary Output + +Switching of loads up to a maximum of about ~400mA can be done using four N-Channel MOSFETs. They are switching on the low-side, which means the load effectively gets connected to GND potential as the transistor starts to conduct. GPIO24 - GPIO27 are used. + +GPIO +----- + +To switch lighter loads, six soldering pads on the back side of the PCB are connected to GPIO0 - GPIO5 pins. Although not implemented yet, they could theoretically be used as inputs as well (e.g., Reed switch). + +Microcontroller +--------------- + +.. image:: https://github.com/1nct/RP2040-Decoder/blob/main/docs/svg/Microcontroller.svg + :alt: Microcontroller + +The Microcontroller needs a crystal oscillator to function properly. External flash memory is also needed as it holds the configuration variables and the program itself. R3 & C14 are used to filter ADC_AVDD (ADC Reference Voltage). + +Complete Schematic +------------------ + +.. image:: https://github.com/1nct/RP2040-Decoder/blob/main/docs/svg/RP2040-Decoder.svg + :alt: Complete Schematic + + +BOM & Alternative Parts +------------------------ +.. table:: BOM + :widths: auto + + ===================================================== ============================= ==================================== ============================= ===================== ========================= + Ref Quantity Value Component Type Component Name Footprint + ===================================================== ============================= ==================================== ============================= ===================== ========================= + C1, C2, C5, C6, C14 5 10u Ceramic Capacitor / 0603_1608Metric + C3, C4, C7, C8, C9, C10, C11, C12, C13, C15 10 100n Ceramic Capacitor / 0603_1608Metric + C16, C17 2 33p Ceramic Capacitor / 0603_1608Metric + D1 1 V\ :sub:`RMS`\=40V, I\ :sub:`F`\=2A Bridge Rectifier KMB24F MBS (TO-269AA) + Q1, Q2, Q3, Q4, Q5 5 V\ :sub:`DS`\=60V, I\ :sub:`D`\=0.4A N-Channel MOSFET T2N7002BK SOT-23 + R1, R2, R5, R6 4 6k8 Resistor / 0603_1608Metric + R3 1 200 Resistor / 0603_1608Metric + R7, R8, R9 3 1k Resistor / 0603_1608Metric + U1 1 V\ :sub:`OUT`\=3.3V Low Dropout Voltage Regulator HT7533S SOT-23 + U2 1 I=2.8A H-Bridge Driver BDR6133 SOIC-8 + U3 1 64Mb Flash Memory W25Q64JVSSIQ SOIC-8 + U4 1 / Microcontroller RP2040 QFN-56-1EP_7x7mm_P0.4mm + Y1 1 f=12MHz Crystal Oscillator X322512MSB4SI Crystal_SMD_3225-4Pin_3.2x2.5mm + ===================================================== ============================= ==================================== ============================= ===================== ========================= + + + +NOTE: Keep capacitor V\ :sub:`max`\ in mind! + +Alternatives for BDR6133: +-------------------------- + +* `PT5126A-S-TP `_ +* `PT2476 `_ + +Alternative for HT7533S: +------------------------ + +* `GS7533-33TR3 `_ diff --git a/docs/sphinx/build/html/_sources/hardware/hw_description_md.md.txt b/docs/sphinx/build/html/_sources/hardware/hw_description_md.md.txt new file mode 100644 index 0000000..cdb9e19 --- /dev/null +++ b/docs/sphinx/build/html/_sources/hardware/hw_description_md.md.txt @@ -0,0 +1,108 @@ +# Hardware Description + +## Overview + +![Block Diagram](https://github.com/1nct/RP2040-Decoder/blob/main/docs/svg/Block_Diagram.svg) + +The above block diagram gives a general overview regarding the operation of components. For better illustration it has been divided into four functional blocks. Furthermore these functional blocks can be subdivided and will be explained below. + +* Input Stage + - DCC Signal Level Shift + - Bridge Rectifier & Voltage Regulator +* Motor Driver + - Motor Driver + - Back EMF measurement (ADC) +* General Purpose + - GPIO + - Auxillary output +* Microcontroller + - Flash memory + - Crystal oscillator + +## Characteristics + + +| Parameter | Symbol | Minimum | Maximum | Unit | +| ----------------------------------------------------- | -------------- | ------- | -------- | ---- | +| Absolute max. DCC Input Voltage | VDCC | -25 | +25 | V | +| Absolute max. GPIO Voltage(0) | VPIN | -0.5 | 3.3+0.5 | V | +| Input Voltage High(0) | VIH | 2.145 | 3.6 | V | +| Input Voltage Low(0) | VIL | 0 | 1.155 | V | +| Total GPIO Current(0) | IIOVDD_MAX| | 50 | mA | +| Absolute max. motor output current(1) | IMOTOR | | 2.8 | A | +| Absolute max. auxillary output current(2) | IAUX | | 400 | mA | + +(0): According to: [RP2040 Datasheet](https://datasheets.raspberrypi.com/rp2040/rp2040-datasheet.pdf) (assuming VDD = 3.3V) + +(1): According to: [BDR6133 Datasheet](https://datasheet.lcsc.com/lcsc/2101211904_Bardeen-Micro--BDR6133_C2687793.pdf) + +(2): According to: [T2N7002BK Datasheet](https://datasheet.lcsc.com/lcsc/1810271831_TOSHIBA-T2N7002BK-LM_C146372.pdf) + +## Input Stage + +![Input Stage](https://github.com/1nct/RP2040-Decoder/blob/main/docs/svg/Input_Stage.svg) + +D1 Rectifies the DCC square-wave into +V, the amplitude is not critical as long as its within the 25V limit. The rectified voltage +V is then provided to the 3.3V voltage regulator (U1) and to the motor driver (U2). + +The MOSFET on the right effectively translates the rather high DCC voltage to a suitable level for the microcontroller to process. When Q1 is turned off GPIO21 is pulled high by the RP2040 internal pull-up resistor, as soon as Q1 gets turned on (VGS > VGS,th), GPIO21 gets pulled to GND potential. R1 and R2 ensure that VGS doesnt exceed ±20V. + +## Motor Driver + +![Motor Driver](https://github.com/1nct/RP2040-Decoder/blob/main/docs/svg/Motor_Driver.svg) + +The Motor Driver is a complete H-Bridge IC specifically made for DC-Motors. + +In order to control the motor, it is necessary to measure the back-EMF. This is done by the ADC which measures at Points ADC_EMF_A and ADC_EMF_B respectively. The two resistors are used as a voltage divider. + +## Auxillary Output + +![Auxillary Output](https://github.com/1nct/RP2040-Decoder/blob/main/docs/svg/Aux_Outputs.svg) + +Switching of loads up to a maximum of about ~400mA can be done using four N-Channel MOSFETS. They are switching on the low-side which means the load effectively gets connected to GND potential as the transistor starts to conduct. GPIO24 - GPIO27 are used. + +## GPIO + +To switch lighter loads six soldering pads on the back side of the PCB are connected to GPIO0 - GPIO5 pins . Although not implemented yet they could theoretically be used as inputs as well (e.g. Reed switch). + +## Microcontroller + +![Microcontroller](https://github.com/1nct/RP2040-Decoder/blob/main/docs/svg/Microcontroller.svg) + +The Microcontroller needs a crystal oscillator to function properly. External flash memory is also needed as it holds the configuration variables and the program itself. R3 & C14 are used to filter ADC_AVDD (ADC Reference Voltage). + + + +## Complete Schematic + +![Complete schematic](https://github.com/1nct/RP2040-Decoder/blob/main/docs/svg/RP2040-Decoder.svg) + +BOM & Alternative Parts +-------------------------- + +| Ref | Quantity | Value | Component Type | Component Name | Footprint | +| ----------------------------------------------------- | -------------- | ------- | -------- | ---- |---- | +| C1, C2, C5, C6, C14 | 5 | 10u | Ceramic Capacitor | / | 0603_1608Metric | +| C3, C4, C7, C8, C9, C10, C11, C12, C13, C15 | 10 | 100n | Ceramic Capacitor | / | 0603_1608Metric | +| C16, C17 | 2 | 33p | Ceramic Capacitor | / | 0603_1608Metric | +| D1 | 1 | VRMS = 40V , IF = 2A | Bridge Rectifier | KMB24F | MBS (TO-269AA) | +| Q1, Q2, Q3, Q4, Q5 | 5 | VDS = 60V , ID = 0.4A | N-Channel MOSFET |T2N7002BK | SOT-23 | +| R1, R2, R5, R6 | 4 | 6k8 | Resistor | / | 0603_1608Metric | +| R3 | 1 | 200 | Resistor | / | 0603_1608Metric | +| R7, R8, R9 | 3 | 1k | Resistor | / | 0603_1608Metric | +| U1 | 1 | VOUT = 3.3V | Low Dropout Voltage Regulator | HT7533S | SOT-23 | +| U2 | 1 | I = 2.8A | H-Bridge driver | BDR6133 | SOIC-8 | +| U3 | 1 | 64Mb | Serial Flash Memory | W25Q64JVSSIQ | SOIC-8 | +| U4 | 1 | / | Raspberry Pi RP2040 Microcontroller | RP2040 | QFN-56-1EP_7x7mm_P0.4mm | +| Y1 | 1 | f = 12MHz | Crystal Oscillator | X322512MSB4SI | Crystal_SMD_3225-4Pin_3.2x2.5mm | + +NOTE: Keep capacitor Vmax in mind! + +Alternatives for BDR6133: + +[PT5126A-S-TP](https://lcsc.com/product-detail/Motor-Driver-ICs_PTC-Princeton-Tech-PT5126A-S-TP_C162093.html) + +[PT2476](https://lcsc.com/product-detail/Motor-Driver-ICs_PTC-Princeton-Tech-PT2476_C481903.html) + +Alternative for HT7533S: + +[GS7533-33TR3](https://www.lcsc.com/product-detail/Linear-Voltage-Regulators-LDO_Gainsil-GS7533-33TR3_C7427372.html) diff --git a/docs/sphinx/build/html/_sources/index.rst.txt b/docs/sphinx/build/html/_sources/index.rst.txt new file mode 100644 index 0000000..4661325 --- /dev/null +++ b/docs/sphinx/build/html/_sources/index.rst.txt @@ -0,0 +1,17 @@ +.. RP2040-Decoder documentation master file, created by + sphinx-quickstart on Wed Nov 27 08:19:47 2024. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +RP2040-Decoder Documentation +============================ + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + other/getting_started + hardware/hw + software/sw + other/CV_list + other/troubleshooting \ No newline at end of file diff --git a/docs/sphinx/build/html/_sources/other/CV_list.md.txt b/docs/sphinx/build/html/_sources/other/CV_list.md.txt new file mode 100644 index 0000000..0e05c75 --- /dev/null +++ b/docs/sphinx/build/html/_sources/other/CV_list.md.txt @@ -0,0 +1,202 @@ +# Configuration Variables (CV) + +## Note +CV.h contains default values for every CV. When your board is still "factory new" these values are automatically written into flash. CV_65 == 255 indicates a factory condition and resets all CVs to default. Alternatively to reset all CVs to default a value of 8 can be written to CV8. Also note that index 0 in the CV array corresponds with CV_1, index 1 corresponds with CV_2 and so forth. This list only contains CVs that are in use. + +## Speed step configuration +![Speed Table](https://github.com/gab-k/RP2040-Decoder/blob/main/docs/svg/speed_table.svg) +* V_min = CV_2 +* V_mid = CV_6 * 16 +* V_max = CV_5 * 16 + +The illustration above shows how the speed steps can be configured using the corresponding CVs. The red * represents V_min which is always at speed step 1, the green * shows V_mid at speed step 64 and the blue * shows V_max at speed step 126. + +## CV List + +### CV_1 - Basic address +Short DCC address + + +### CV_2 - V_min +Min motor voltage/speed + + +### CV_3 - Acceleration rate +CV_3*CV_175 = Time for one discrete speed step change in ms + + +### CV_4 - Deceleration rate +CV_4*CV_175 = Time for one discrete speed step change in ms + + +### CV_5 - V_max +Max motor voltage/speed - V_max = CV_5 * 16 + + +### CV_6 - V_mid +Mid motor voltage/speed - V_max = CV_6 * 16 + + +### CV_7 - Version No. (Read-Only) +Rev 0.3 = 1 + +Writing a value of 7 triggers am ADC offset adjustment. + +### CV_8 - Manufacturer (Read-Only) +Default = "13" = Public Domain & Do-It-Yourself Decoders + + +Writing a value of 8 resets all CV values to the default values in CV.h. +This will also happen if CV_65 == "255" == "0xFF". + + +### CV_9 - Motor PWM Frequency +f in Hz = CV_9 * 100 + 10000 + + +### CV_11 - Packet timeout +If no package is received for x seconds (x = CV_11) the decoder will automatically stop the motor (Emergency Stop). + + +### CV_12 - Permitted operating modes +Currently DCC Digital mode is the only supported mode. + + +### CV_17 & CV_18 - 14-Bit extended/long address +Address is only used if bit5 has a value of "1" in CV_29. + +![Long Address](https://github.com/gab-k/RP2040-Decoder/blob/main/docs/svg/Long_address.svg) + +Bit15 and bit14 which correspond to bit7 and bit6 of CV_17 are always "1". CV_17 = "192" & CV_18 = "0" is also not a valid address. Otherwise the valid value range of CV_17 ranges from "192" to "231" and "0" to "255" for CV_18 respectively. + + + +### CV_29 - Decoder Configuration + +Bit0 is used to reverse direction i.e. "0" = normal, "1" = reverse. +Bit5 switches between basic and extended addressing modes i.e. "0" = basic address, "1" = extended address. +The other 6 bits are currently not in use and therefore irrelevant. + + +### CV_31 & CV_32 - Extended CV pointer (Read-Only) +Not in use. + +### CV_47 - Feed-forward gain k_ff +k_ff defines the correction behavior with regard to the y2 variable. High values for k_ff lead to a faster change in the variable. Values for k_ff that are too high can lead to oscillations. +k_ff = CV_47/10000 + + +### CV_48 - Filter time constant (tau) in ms +The time constant tau characterizes the low-pass filter which is connected downstream in the D component of the PID controller + + +### CV_49 - PID Control sampling time t in ms +Every t seconds the pid_control() function gets called to compute the new control output + + +### CV_50 - PID Control I Factor +Integral gain factor of the PID-Controller + + +### CV_51 - PID Control D Factor +Derivative gain factor of the PID-Controller + + +### CV_52 & CV_53 - PID Integral Limits +Maximum and minimum integral part values + + +### CV_54 & CV_55 - Gain scheduling config k_p @ x0 +CV_54 - High Byte -- CV_55 - Low Byte + + +### CV_56 & CV_57 - Gain scheduling config k_p @ x1 +CV_56 - High Byte -- CV_57 - Low Byte + + +### CV_58 & CV_59 - Gain scheduling config k_p @ x2 +CV_58 - High Byte -- CV_59 - Low Byte + + +### CV_60 - Gain scheduling config x1 shift percentage +Determines position of x1 in percent -> x1 shift in % ≙ CV_60/255 + + +### CV_61 - Measurement Iterations +Total amount of BEMF-Voltage measurement iterations + + +### CV_62 - Measurement Delay +BEMF-Voltage measurement delay + + +### CV_63 & CV_64 - Measurement array cutoffs +CV_63 determines how many elements from the left side (beginning with index 0) of the array will be discarded while CV_64 determines how many elements from the right side (beginning from highest index) will be discarded. + + +### CV_65 - New flash variable +Each Byte of the factory new flash chip should have a inital state of "0xFF". This will be checked for in the beginning of core0.c (see cv_setup_check()). When CV_65 == "255" == "0xFF" the default config (CV.h) will be written to flash. Alternatively a reset to default can be done by either writing "8" to CV_8 or writing "255" to CV_65 which then triggers a reset on startup. + + +### CV_112, CV_113, CV_114, CV_115 - GPIO PWM Configuration +PWM enabled "1" - PWM disabled "0" + + +### CV_116 to CV_171 - PWM Slice configuration +![GPIO Slices](https://github.com/gab-k/RP2040-Decoder/blob/main/docs/svg/GPIO_slices.svg) + + +Every slice controls two independent output channels, duty cycle from 0% to 100% inclusive and can be configured with several parameters: + + +* Wrap (16Bit): Sets the slice time period of x cycles - effectively determining the frequency +* Clock Divider: Additional clock divider +* Level Channel A / Level Channel B - (16Bit each): Determining how many of the x cycles the signal is at a high level - effectively determining the duty cycle + +To see which CVs correspond to which slice and channel, it is advisable to use CV.h as a reference + +The PWM-frequency is calculated as follows: fPWM = 125 MHz / [ (CVclk_div + 1) * (CVwrap + 1) ] + +The duty-cycle can be calculated as follows: D = CVLevel / CVwrap + 1 + +**Example configuration - (AUX2: PWM-Frequency fPWM = 10kHz; Duty-cycle D = 20%):** + +AUX1 => GPIO25 => Slice 4 / Channel B => Wrap: CV_144 & CV_145; Clock-divider: CV_146; Level(B): CV_149 & CV_150 + +=> fPWM = 10kHz = 125 MHz / [ (0 + 1) * (12499 + 1) ]; + +=> CV_144 = 110000, CV_145 = 11010011, CV_146 = 0; --- (Note: "12499dec" = "11000011010011bin") + +=> CVLevel = CV_149 & CV_150 = D * (CVwrap + 1) = 0.2 * 12500 = 2500 + +=> CV_149 = 1001, CV_150 = 11000100; --- (Note: "2500dec" = "100111000100bin") + +Another configuration which also achieves 10kHz and D = 20% would be CVclk_div = 10, CVwrap = 1249, CVLevel = 250. + + +A more detailed explanation regarding PWM can be found in the [RP2040-Datasheet - Chapter 4.5](https://datasheets.raspberrypi.com/rp2040/rp2040-datasheet.pdf). + +### CV_172 - ADC Offset +If CV_172 = "0xFF" = "255" there will be a measurement procedure on startup + + +### CV_173 - ADC offset measurement cycles +Determines how many ADC offset measurement iterations are done. + + +### CV_174 - Additional motor-PWM clock divider. +Additional Clock Divider - works the same as any GPIO clock divider + + +### CV_175 - speed_helper timer delay +This timer delay can be used to change the time between two speed steps. So basically an additional option to adjust the deceleration and acceleration rate. + + +### CV_176, CV_177, CV_178, CV_179 - Base PWM Level used in feed-forward control +CV_176 - High Byte forward -- CV_177 - Low Byte forward -- CV_178 - High Byte reverse -- CV_179 - Low Byte reverse + +These values are equivalent to y1(forward) and y1(reverse) mentioned [here](https://github.com/gab-k/RP2040-Decoder/wiki/Software-description#feed-forward). Writing "0" to all four CVs schedules a new calibration on startup. + + +### CV_257 to CV_512 - Function Mapping CVs +The switching status of the outputs depends both on the function instruction received and on the current direction of travel. That means you can, for example, use a function to switch two or more outputs or, as is usual with headlights, switch them depending on the direction of travel. For configuration, 32 bits (corresponding to the GPIOs) are available for each function in each direction of travel. diff --git a/docs/sphinx/build/html/_sources/other/getting_started.md.txt b/docs/sphinx/build/html/_sources/other/getting_started.md.txt new file mode 100644 index 0000000..0931104 --- /dev/null +++ b/docs/sphinx/build/html/_sources/other/getting_started.md.txt @@ -0,0 +1,75 @@ +# Getting started +In order to make use of this project, you will need the following: + - The RP2040-Decoder board itself + - Raspberry Pi Pico or another multi-drop SWD debug interfaces might work as well + - Micro-USB cable + +## 1. Where to get the board? +You can of course choose any preferred PCB manufacturer, the PCB is designed to be compliant with JLCPCB.com 2 layer board capabilities (hole diameter/clearence/etc.). Regarding assembly, you can of course assemble the board yourself but I would not recommend it (especially the RP2040 QFN Package is not easy to solder). Alternatively you can order the board fully or partly assembled. All parts are normally available at LCSC.com who supply parts to JLCPCB.com. + +## 2. Production files? +In order to generate export the production files (Gerber/BOM/Pick and Place) you need [KiCad](https://www.kicad.org/download/) 6 which is open source. +[How to do this?](https://jlcpcb.com/help/article/362-how-to-generate-gerber-and-drill-files-in-kicad-7) + +## 3. Building and flashing + +To build the software and run it on the Controller we need to interface the RP2040 using Serial Wire Debug. This can be done using a Raspberry Pi Pico board. + +### Windows + + +1. Connect Raspberry Pi Pico via USB while holding the reset button. Your Pi Pico should now be visible in Windows explorer as a mass storage device. +2. Download the latest prebuilt "picoprobe.uf2" release binary from [here](https://github.com/raspberrypi/picoprobe/releases) or download it from the [Raspberry Pi Website](https://www.raspberrypi.com/documentation/microcontrollers/raspberry-pi-pico.html#debugging-using-another-raspberry-pi-pico). +3. Copy "picoprobe.uf2" to your Pi Pico. The Pi Pico onboard LED should now light up. +4. Connect GND to GND, GPIO2 to SWCLK, GPIO3 to SWDIO, VBUS to +V, as shown in the picture below . + + +5. Download and install [Pico setup for Windows](https://github.com/raspberrypi/pico-setup-windows) +6. Download and install [MSYS2](https://www.msys2.org/) +7. Open a MSYS2 MINGW64 shell window +8. Update all pacman packages +```sh +pacman -Syu +``` +9. Install mingw-w64-x86_64-toolchain (choose to install all) +```sh +pacman -S mingw-w64-x86_64-toolchain +``` +10. Add "C:\msys64\mingw64\bin" to your users PATH environment variable. If you have choosen to not use the default directory for MSYS2 add the one you have choosen. [How to do this?](https://www.computerhope.com/issues/ch000549.htm) +11. Open the Pico - Developer Powershell +12. Navigate to a folder you like and clone the project repository +```sh +git clone https://github.com/gab-k/RP2040-Decoder +``` +13. Enter cloned repository, create and enter build directory +```sh +cd RP2040-Decoder +mkdir build +cd build +``` +14. Run CMake and the mingw32-make to build +```sh +cmake -G "MinGW Makefiles" -DCMAKE_BUILD_TYPE=Debug .. +mingw32 +``` +15. Flash the decoders software using openocd +```sh +openocd -f interface/cmsis-dap.cfg -f target/rp2040.cfg -c "adapter speed 5000" -c"program rp2040-decoder.elf verify reset exit" +``` + +### Other OS + +The first four steps are identical to the steps described above for windows users. Regarding building and flashing, please refer to [Getting started - Pico](https://datasheets.raspberrypi.com/pico/getting-started-with-pico.pdf). Chapter 3 & 5 and Appendix A are the most relevant but you might also refer to chapter 9.1 if you are using macOS. + + +## 4. Wiring and initial startup + + +The illustration above shows an example wiring configuration, you can connect up to 4 outputs(up to 400mA) and 6 GPIOs for lighter loads or custom applications. A Free-wheeling diode should be used when switching inductive loads! + +Another important note is that when the decoder is put into operation for the first time, it automatically performs a motor calibration, which is required for feedforward control. The calibration takes about one to two minutes. + +## 5. If it's not working as expected + +1. Follow the [Troubleshooting instructions](https://github.com/gab-k/RP2040-Decoder/wiki/Troubleshooting) +2. If you still have trouble create a new [discussion](https://github.com/gab-k/RP2040-Decoder/discussions) or [issue](https://github.com/gab-k/RP2040-Decoder/issues) and describe your question/issue. \ No newline at end of file diff --git a/docs/sphinx/build/html/_sources/other/troubleshooting.md.txt b/docs/sphinx/build/html/_sources/other/troubleshooting.md.txt new file mode 100644 index 0000000..0a53c06 --- /dev/null +++ b/docs/sphinx/build/html/_sources/other/troubleshooting.md.txt @@ -0,0 +1,14 @@ +# Troubleshooting + +To narrow down the issue when your decoder is not working as expected, you can do the following: + +Check the power supply of the decoder: +* +3V3 to GND should be 3.3V +* +V to GND should be somewhere in the range of around +10V to +20V +* If you dont measure the correct voltages, try to [measure Track Voltage](https://dccwiki.com/Measuring_Track_Voltage) + +Check your motor: +* Desolder your motor and try the motor with a analog power supply 0...+-16V to check if the motor is working or not (desolder the wires because the decoder doesn't like voltage on these pins!) + +Reset: +* Try to reset the decoder by writing a value of 8 to CV8 (beware, this will reset the complete CV memory!) \ No newline at end of file diff --git a/docs/sphinx/build/html/_sources/software/header_files.rst.txt b/docs/sphinx/build/html/_sources/software/header_files.rst.txt new file mode 100644 index 0000000..a8cf886 --- /dev/null +++ b/docs/sphinx/build/html/_sources/software/header_files.rst.txt @@ -0,0 +1,29 @@ +Header files +================= + +core0.h +------- + +.. doxygenfile:: core0.h + :project: RP2040-Decoder + + +core1.h +------- + +.. doxygenfile:: core1.h + :project: RP2040-Decoder + + +shared.h +------- + +.. doxygenfile:: shared.h + :project: RP2040-Decoder + +CV.h +------- + +.. doxygenfile:: CV.h + :project: RP2040-Decoder + diff --git a/docs/sphinx/build/html/_sources/software/sw.rst.txt b/docs/sphinx/build/html/_sources/software/sw.rst.txt new file mode 100644 index 0000000..0e001b3 --- /dev/null +++ b/docs/sphinx/build/html/_sources/software/sw.rst.txt @@ -0,0 +1,9 @@ +Software +================= + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + sw_description + header_files \ No newline at end of file diff --git a/docs/sphinx/build/html/_sources/software/sw_description.md.txt b/docs/sphinx/build/html/_sources/software/sw_description.md.txt new file mode 100644 index 0000000..6e243ea --- /dev/null +++ b/docs/sphinx/build/html/_sources/software/sw_description.md.txt @@ -0,0 +1,82 @@ +# Software Description + +## Overview + +The Software is structured as follows: +* Core0.c + - DCC package detection & decoding + - Programming mode (Modify and read CVs on programming track) + - ADC-Offset measurement + - Feed-forward base PWM measurement + +* Core1.c + - PID motor controller +* CV.h + - Default configuration variables + +Conveniently The Raspberry Pi Foundation provides a well documented [SDK](https://datasheets.raspberrypi.com/pico/raspberry-pi-pico-c-sdk.pdf) for the RP2040. The SDK provides abstraction to a higher level and therefore there is no need to access any registers directly. Everything is written using the SDK so hopefully the code is easier to understand. In the following, the motor control and the decoding of the DCC signals will be explained. + +## Motor control overview + +![Block Diagram](https://github.com/1nct/RP2040-Decoder/blob/main/docs/svg/Block_Diagram_Control.svg) +*** +**Block diagram - Motor control** + +The above block diagram in essence describes the functionality of the control loop. While the central component is the PID controller, there is an additional block called [Feed-forward](https://en.wikipedia.org/wiki/Feed_forward_(control)) that has an impact on the control output variable. The Feed-forward block adds an additional offset to the output depending on the setpoint, this is done to achieve better control. A more detailed explanation regarding Feed-forward can be found below. The speed helper block is corresponding to the speed_helper() function which delays changing the setpoint according to the configured deceleration/acceleration rates. + + +## PID Controller + +![PID Controller](https://github.com/gab-k/RP2040-Decoder/blob/main/docs/svg/Block_Diagram_PID.svg) + +The block diagram above shows the PID controller in the s-domain. The derivative part contains an additional digital low pass filter used to filter out high-frequency noise. + +Output = E * (KP + KI/s + (KD*s)/(sτ+1)) = P + I + D + +* P = E * KP +* I = E * KI/s +* D = E * (KD*s)/(sτ+1) + +The continuous-time system representation can now be transformed into a discrete-time representation using [bilinear transform](https://en.wikipedia.org/wiki/Bilinear_transform) [ s = 2*(z-1) / Ts*(z+1) ]. + +This results in the following difference equations which are then implemented in software: + +* pn = KP * en +* in = 0.5KI * (en + en-1) + in-1 +* dn = [ 2KD * (en - en-1) + (2τ - Ts) * dn-1 ] / [ 2τ + Ts] + +=> outputn = pn + in + dn + +Also note that instead of using derivative of error, derivative on measurement is used. This is done to prevent a high derivative part in the event of a large change in setpoint. + +### Gain scheduling + +![K_P](https://github.com/gab-k/RP2040-Decoder/blob/main/docs/svg/adaptive_kp.svg) + +Another aspect to consider is the implementation of [gain scheduling](https://en.wikipedia.org/wiki/Gain_scheduling). KP is a function of the current setpoint. Often it is favorable to have a higher proportional gain KP for slow speeds, achieving better control results. The illustration above shows the default setting for KP. CV_54 & CV_55 are used to set KP @ x0, CV_56 & CV_57 for KP @ x1 and CV_58 & CV_59 for KP @ x2. Additionally CV_60 is used to shift x1 from the leftmost point (0% = 0/255) to the rightmost point (100% = 255/255). + +### Feed-forward + +![Feed-forward](https://github.com/gab-k/RP2040-Decoder/blob/main/docs/svg/feed_forward.svg) +To achieve better control [Feed-forward](https://en.wikipedia.org/wiki/Feed_forward_(control)) is used. On startup the decoder will check for a configuration regarding Feed-forward control - when no configuration is found the decoder automatically runs a calibration to establish a base pwm level (y1) for both directions. The base pwm level (y1) will vary depending on load, motor and voltage on the tracks and can be configured with CV_176 - CV_179. If the setpoint is greater than the threshold, y2 is corrected automatically when in reaches 0.5imin or 0.5imax. CV_47 can be used to set how sensitive this correction is. + +### Back-EMF voltage measurement + +To provide a feedback signal which is proportional to the motor speed the ADC is used to measure the [Back-EMF voltage](https://en.wikipedia.org/wiki/Counter-electromotive_force). The measurement works by setting the PWM duty cycle to 0%, waiting for a certain delay time (CV_62) and then measuring x times (x = CV_63). While measuring the array with measurement values are being sorted using insertion sort. Afterwards y elements (y = CV_63) from the left (lowest values) and z elements (z = CV_64) from the right (highest values) will be dismissed to mitigate the impact of potential outliers in measurement. The average value of the remaining values will be computed and fed back into the control algorithm. Considering default settings (100us delay, 100 samples, ~2µs sampling time) the complete measurement run including averaging takes about 0.3ms to 0.35ms which effectively reduces the maximum possible duty cycle to about 93% to 94%. + +## DCC signal decoding + +The detection of the DCC signal works by looking at every rising and falling edge and calculating the time between them. When the time between rising and falling edge is greater than 87μs then this is equivalent to "0", else "1" - This value then gets shifted into a 64-Bit variable. + +Decoding is done after every falling edge. It starts with an error detection which when not passed will dismiss the received command. Then the address will be decoded and compared to the address stored in the configuration. If the address matches the command/instruction will be decoded. + +Only a few instructions are currently implemented, only 128 speed step instructions are supported. + +**Implemented instructions:** +* 0011-1111 - (128 Speed Step Control) - 2 Byte length +* 10XX-XXXX - (Function Group Instruction) (F0 - F12) +* 110X-XXXX - Expansion Instruction (F13 - F31) + +All DCC instructions can be found in Section 9.2, 9.2.1 and 9.2.1.1 of the [NMRA Communications Standard ](https://www.nmra.org/index-nmra-standards-and-recommended-practices) + + diff --git a/docs/sphinx/build/html/_static/_sphinx_javascript_frameworks_compat.js b/docs/sphinx/build/html/_static/_sphinx_javascript_frameworks_compat.js new file mode 100644 index 0000000..8141580 --- /dev/null +++ b/docs/sphinx/build/html/_static/_sphinx_javascript_frameworks_compat.js @@ -0,0 +1,123 @@ +/* Compatability shim for jQuery and underscores.js. + * + * Copyright Sphinx contributors + * Released under the two clause BSD licence + */ + +/** + * 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) { + if (!x) { + return x + } + return decodeURIComponent(x.replace(/\+/g, ' ')); +}; + +/** + * small helper function to urlencode strings + */ +jQuery.urlencode = encodeURIComponent; + +/** + * This function returns the parsed url parameters of the + * current request. Multiple values per key are supported, + * it will always return arrays of strings for the value parts. + */ +jQuery.getQueryParameters = function(s) { + if (typeof s === 'undefined') + s = document.location.search; + var parts = s.substr(s.indexOf('?') + 1).split('&'); + var result = {}; + for (var i = 0; i < parts.length; i++) { + var tmp = parts[i].split('=', 2); + var key = jQuery.urldecode(tmp[0]); + var value = jQuery.urldecode(tmp[1]); + if (key in result) + result[key].push(value); + else + result[key] = [value]; + } + return result; +}; + +/** + * highlight a given string on a jquery object by wrapping it in + * span elements with the given class name. + */ +jQuery.fn.highlightText = function(text, className) { + function highlight(node, addItems) { + if (node.nodeType === 3) { + var val = node.nodeValue; + var pos = val.toLowerCase().indexOf(text); + if (pos >= 0 && + !jQuery(node.parentNode).hasClass(className) && + !jQuery(node.parentNode).hasClass("nohighlight")) { + var span; + var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.className = className; + } + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + node.parentNode.insertBefore(span, node.parentNode.insertBefore( + document.createTextNode(val.substr(pos + text.length)), + node.nextSibling)); + node.nodeValue = val.substr(0, pos); + if (isInSVG) { + var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); + var bbox = node.parentElement.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute('class', className); + addItems.push({ + "parent": node.parentNode, + "target": rect}); + } + } + } + else if (!jQuery(node).is("button, select, textarea")) { + jQuery.each(node.childNodes, function() { + highlight(this, addItems); + }); + } + } + var addItems = []; + var result = this.each(function() { + highlight(this, addItems); + }); + for (var i = 0; i < addItems.length; ++i) { + jQuery(addItems[i].parent).before(addItems[i].target); + } + return result; +}; + +/* + * backward compatibility for jQuery.browser + * This will be supported until firefox bug is fixed. + */ +if (!jQuery.browser) { + jQuery.uaMatch = function(ua) { + ua = ua.toLowerCase(); + + var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || + /(webkit)[ \/]([\w.]+)/.exec(ua) || + /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || + /(msie) ([\w.]+)/.exec(ua) || + ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || + []; + + return { + browser: match[ 1 ] || "", + version: match[ 2 ] || "0" + }; + }; + jQuery.browser = {}; + jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; +} diff --git a/docs/sphinx/build/html/_static/basic.css b/docs/sphinx/build/html/_static/basic.css new file mode 100644 index 0000000..7ebbd6d --- /dev/null +++ b/docs/sphinx/build/html/_static/basic.css @@ -0,0 +1,914 @@ +/* + * Sphinx stylesheet -- basic theme. + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +div.section::after { + display: block; + content: ''; + clear: left; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + +div.sphinxsidebar #searchbox input[type="text"] { + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; +} + + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin-top: 10px; +} + +ul.search li { + padding: 5px 0; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li p.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body { + min-width: 360px; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +a:visited { + color: #551A8B; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, figure.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, figure.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, figure.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, figure.align-default, .figure.align-default { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-default { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar, +aside.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px; + background-color: #ffe; + width: 40%; + float: right; + clear: right; + overflow-x: auto; +} + +p.sidebar-title { + font-weight: bold; +} + +nav.contents, +aside.topic, +div.admonition, div.topic, blockquote { + clear: left; +} + +/* -- topics ---------------------------------------------------------------- */ + +nav.contents, +aside.topic, +div.topic { + border: 1px solid #ccc; + padding: 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- content of sidebars/topics/admonitions -------------------------------- */ + +div.sidebar > :last-child, +aside.sidebar > :last-child, +nav.contents > :last-child, +aside.topic > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + +div.sidebar::after, +aside.sidebar::after, +nav.contents::after, +aside.topic::after, +div.topic::after, +div.admonition::after, +blockquote::after { + display: block; + content: ''; + clear: both; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + margin-top: 10px; + margin-bottom: 10px; + border: 0; + border-collapse: collapse; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +table.align-default { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +th > :first-child, +td > :first-child { + margin-top: 0px; +} + +th > :last-child, +td > :last-child { + margin-bottom: 0px; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure, figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption, figcaption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number, +figcaption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text, +figcaption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist { + margin: 1em 0; +} + +table.hlist td { + vertical-align: top; +} + +/* -- object description styles --------------------------------------------- */ + +.sig { + font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; +} + +.sig-name, code.descname { + background-color: transparent; + font-weight: bold; +} + +.sig-name { + font-size: 1.1em; +} + +code.descname { + font-size: 1.2em; +} + +.sig-prename, code.descclassname { + background-color: transparent; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.sig-param.n { + font-style: italic; +} + +/* C++ specific styling */ + +.sig-inline.c-texpr, +.sig-inline.cpp-texpr { + font-family: unset; +} + +.sig.c .k, .sig.c .kt, +.sig.cpp .k, .sig.cpp .kt { + color: #0033B3; +} + +.sig.c .m, +.sig.cpp .m { + color: #1750EB; +} + +.sig.c .s, .sig.c .sc, +.sig.cpp .s, .sig.cpp .sc { + color: #067D17; +} + + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +:not(li) > ol > li:first-child > :first-child, +:not(li) > ul > li:first-child > :first-child { + margin-top: 0px; +} + +:not(li) > ol > li:last-child > :last-child, +:not(li) > ul > li:last-child > :last-child { + margin-bottom: 0px; +} + +ol.simple ol p, +ol.simple ul p, +ul.simple ol p, +ul.simple ul p { + margin-top: 0; +} + +ol.simple > li:not(:first-child) > p, +ul.simple > li:not(:first-child) > p { + margin-top: 0; +} + +ol.simple p, +ul.simple p { + margin-bottom: 0; +} + +aside.footnote > span, +div.citation > span { + float: left; +} +aside.footnote > span:last-of-type, +div.citation > span:last-of-type { + padding-right: 0.5em; +} +aside.footnote > p { + margin-left: 2em; +} +div.citation > p { + margin-left: 4em; +} +aside.footnote > p:last-of-type, +div.citation > p:last-of-type { + margin-bottom: 0em; +} +aside.footnote > p:last-of-type:after, +div.citation > p:last-of-type:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + +dl { + margin-bottom: 15px; +} + +dd > :first-child { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +.sig dd { + margin-top: 0px; + margin-bottom: 0px; +} + +.sig dl { + margin-top: 0px; + margin-bottom: 0px; +} + +dl > dd:last-child, +dl > dd:last-child > :last-child { + margin-bottom: 0; +} + +dt:target, span.highlighted { + background-color: #fbe54e; +} + +rect.highlighted { + fill: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +.classifier:before { + font-style: normal; + margin: 0 0.5em; + content: ":"; + display: inline-block; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +.translated { + background-color: rgba(207, 255, 207, 0.2) +} + +.untranslated { + background-color: rgba(255, 207, 207, 0.2) +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +pre, div[class*="highlight-"] { + clear: both; +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; + white-space: nowrap; +} + +div[class*="highlight-"] { + margin: 1em 0; +} + +td.linenos pre { + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + display: block; +} + +table.highlighttable tbody { + display: block; +} + +table.highlighttable tr { + display: flex; +} + +table.highlighttable td { + margin: 0; + padding: 0; +} + +table.highlighttable td.linenos { + padding-right: 0.5em; +} + +table.highlighttable td.code { + flex: 1; + overflow: hidden; +} + +.highlight .hll { + display: block; +} + +div.highlight pre, +table.highlighttable pre { + margin: 0; +} + +div.code-block-caption + div { + margin-top: 0; +} + +div.code-block-caption { + margin-top: 1em; + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +table.highlighttable td.linenos, +span.linenos, +div.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; + -webkit-user-select: text; /* Safari fallback only */ + -webkit-user-select: none; /* Chrome/Safari */ + -moz-user-select: none; /* Firefox */ + -ms-user-select: none; /* IE10+ */ +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + margin: 1em 0; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: absolute; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/docs/sphinx/build/html/_static/css/badge_only.css b/docs/sphinx/build/html/_static/css/badge_only.css new file mode 100644 index 0000000..88ba55b --- /dev/null +++ b/docs/sphinx/build/html/_static/css/badge_only.css @@ -0,0 +1 @@ +.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions .rst-other-versions .rtd-current-item{font-weight:700}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}#flyout-search-form{padding:6px} \ No newline at end of file diff --git a/docs/sphinx/build/html/_static/css/fonts/Roboto-Slab-Bold.woff b/docs/sphinx/build/html/_static/css/fonts/Roboto-Slab-Bold.woff new file mode 100644 index 0000000..6cb6000 Binary files /dev/null and b/docs/sphinx/build/html/_static/css/fonts/Roboto-Slab-Bold.woff differ diff --git a/docs/sphinx/build/html/_static/css/fonts/Roboto-Slab-Bold.woff2 b/docs/sphinx/build/html/_static/css/fonts/Roboto-Slab-Bold.woff2 new file mode 100644 index 0000000..7059e23 Binary files /dev/null and b/docs/sphinx/build/html/_static/css/fonts/Roboto-Slab-Bold.woff2 differ diff --git a/docs/sphinx/build/html/_static/css/fonts/Roboto-Slab-Regular.woff b/docs/sphinx/build/html/_static/css/fonts/Roboto-Slab-Regular.woff new file mode 100644 index 0000000..f815f63 Binary files /dev/null and b/docs/sphinx/build/html/_static/css/fonts/Roboto-Slab-Regular.woff differ diff --git a/docs/sphinx/build/html/_static/css/fonts/Roboto-Slab-Regular.woff2 b/docs/sphinx/build/html/_static/css/fonts/Roboto-Slab-Regular.woff2 new file mode 100644 index 0000000..f2c76e5 Binary files /dev/null and b/docs/sphinx/build/html/_static/css/fonts/Roboto-Slab-Regular.woff2 differ diff --git a/docs/sphinx/build/html/_static/css/fonts/fontawesome-webfont.eot b/docs/sphinx/build/html/_static/css/fonts/fontawesome-webfont.eot new file mode 100644 index 0000000..e9f60ca Binary files /dev/null and b/docs/sphinx/build/html/_static/css/fonts/fontawesome-webfont.eot differ diff --git a/docs/sphinx/build/html/_static/css/fonts/fontawesome-webfont.svg b/docs/sphinx/build/html/_static/css/fonts/fontawesome-webfont.svg new file mode 100644 index 0000000..855c845 --- /dev/null +++ b/docs/sphinx/build/html/_static/css/fonts/fontawesome-webfont.svg @@ -0,0 +1,2671 @@ + + + + +Created by FontForge 20120731 at Mon Oct 24 17:37:40 2016 + By ,,, +Copyright Dave Gandy 2016. All rights reserved. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/sphinx/build/html/_static/css/fonts/fontawesome-webfont.ttf b/docs/sphinx/build/html/_static/css/fonts/fontawesome-webfont.ttf new file mode 100644 index 0000000..35acda2 Binary files /dev/null and b/docs/sphinx/build/html/_static/css/fonts/fontawesome-webfont.ttf differ diff --git a/docs/sphinx/build/html/_static/css/fonts/fontawesome-webfont.woff b/docs/sphinx/build/html/_static/css/fonts/fontawesome-webfont.woff new file mode 100644 index 0000000..400014a Binary files /dev/null and b/docs/sphinx/build/html/_static/css/fonts/fontawesome-webfont.woff differ diff --git a/docs/sphinx/build/html/_static/css/fonts/fontawesome-webfont.woff2 b/docs/sphinx/build/html/_static/css/fonts/fontawesome-webfont.woff2 new file mode 100644 index 0000000..4d13fc6 Binary files /dev/null and b/docs/sphinx/build/html/_static/css/fonts/fontawesome-webfont.woff2 differ diff --git a/docs/sphinx/build/html/_static/css/fonts/lato-bold-italic.woff b/docs/sphinx/build/html/_static/css/fonts/lato-bold-italic.woff new file mode 100644 index 0000000..88ad05b Binary files /dev/null and b/docs/sphinx/build/html/_static/css/fonts/lato-bold-italic.woff differ diff --git a/docs/sphinx/build/html/_static/css/fonts/lato-bold-italic.woff2 b/docs/sphinx/build/html/_static/css/fonts/lato-bold-italic.woff2 new file mode 100644 index 0000000..c4e3d80 Binary files /dev/null and b/docs/sphinx/build/html/_static/css/fonts/lato-bold-italic.woff2 differ diff --git a/docs/sphinx/build/html/_static/css/fonts/lato-bold.woff b/docs/sphinx/build/html/_static/css/fonts/lato-bold.woff new file mode 100644 index 0000000..c6dff51 Binary files /dev/null and b/docs/sphinx/build/html/_static/css/fonts/lato-bold.woff differ diff --git a/docs/sphinx/build/html/_static/css/fonts/lato-bold.woff2 b/docs/sphinx/build/html/_static/css/fonts/lato-bold.woff2 new file mode 100644 index 0000000..bb19504 Binary files /dev/null and b/docs/sphinx/build/html/_static/css/fonts/lato-bold.woff2 differ diff --git a/docs/sphinx/build/html/_static/css/fonts/lato-normal-italic.woff b/docs/sphinx/build/html/_static/css/fonts/lato-normal-italic.woff new file mode 100644 index 0000000..76114bc Binary files /dev/null and b/docs/sphinx/build/html/_static/css/fonts/lato-normal-italic.woff differ diff --git a/docs/sphinx/build/html/_static/css/fonts/lato-normal-italic.woff2 b/docs/sphinx/build/html/_static/css/fonts/lato-normal-italic.woff2 new file mode 100644 index 0000000..3404f37 Binary files /dev/null and b/docs/sphinx/build/html/_static/css/fonts/lato-normal-italic.woff2 differ diff --git a/docs/sphinx/build/html/_static/css/fonts/lato-normal.woff b/docs/sphinx/build/html/_static/css/fonts/lato-normal.woff new file mode 100644 index 0000000..ae1307f Binary files /dev/null and b/docs/sphinx/build/html/_static/css/fonts/lato-normal.woff differ diff --git a/docs/sphinx/build/html/_static/css/fonts/lato-normal.woff2 b/docs/sphinx/build/html/_static/css/fonts/lato-normal.woff2 new file mode 100644 index 0000000..3bf9843 Binary files /dev/null and b/docs/sphinx/build/html/_static/css/fonts/lato-normal.woff2 differ diff --git a/docs/sphinx/build/html/_static/css/theme.css b/docs/sphinx/build/html/_static/css/theme.css new file mode 100644 index 0000000..0f14f10 --- /dev/null +++ b/docs/sphinx/build/html/_static/css/theme.css @@ -0,0 +1,4 @@ +html{box-sizing:border-box}*,:after,:before{box-sizing:inherit}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}[hidden],audio:not([controls]){display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:700}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;text-decoration:none}ins,mark{color:#000}mark{background:#ff0;font-style:italic;font-weight:700}.rst-content code,.rst-content tt,code,kbd,pre,samp{font-family:monospace,serif;_font-family:courier new,monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:after,q:before{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-.5em}sub{bottom:-.25em}dl,ol,ul{margin:0;padding:0;list-style:none;list-style-image:none}li{list-style:none}dd{margin:0}img{border:0;-ms-interpolation-mode:bicubic;vertical-align:middle;max-width:100%}svg:not(:root){overflow:hidden}figure,form{margin:0}label{cursor:pointer}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,input[type=button],input[type=reset],input[type=submit]{cursor:pointer;-webkit-appearance:button;*overflow:visible}button[disabled],input[disabled]{cursor:default}input[type=search]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}textarea{resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:.2em 0;background:#ccc;color:#000;padding:.2em 0}.ir{display:block;border:0;text-indent:-999em;overflow:hidden;background-color:transparent;background-repeat:no-repeat;text-align:left;direction:ltr;*line-height:0}.ir br{display:none}.hidden{display:none!important;visibility:hidden}.visuallyhidden{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}.invisible{visibility:hidden}.relative{position:relative}big,small{font-size:100%}@media print{body,html,section{background:none!important}*{box-shadow:none!important;text-shadow:none!important;filter:none!important;-ms-filter:none!important}a,a:visited{text-decoration:underline}.ir a:after,a[href^="#"]:after,a[href^="javascript:"]:after{content:""}blockquote,pre{page-break-inside:avoid}thead{display:table-header-group}img,tr{page-break-inside:avoid}img{max-width:100%!important}@page{margin:.5cm}.rst-content .toctree-wrapper>p.caption,h2,h3,p{orphans:3;widows:3}.rst-content .toctree-wrapper>p.caption,h2,h3{page-break-after:avoid}}.btn,.fa:before,.icon:before,.rst-content .admonition,.rst-content .admonition-title:before,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .code-block-caption .headerlink:before,.rst-content .danger,.rst-content .eqno .headerlink:before,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-alert,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before,input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week],select,textarea{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}/*! + * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome + * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) + */@font-face{font-family:FontAwesome;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713);src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix&v=4.7.0) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#fontawesomeregular) format("svg");font-weight:400;font-style:normal}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14286em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14286em;width:2.14286em;top:.14286em;text-align:center}.fa-li.fa-lg{left:-1.85714em}.fa-border{padding:.2em .25em .15em;border:.08em solid #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa-pull-left.icon,.fa.fa-pull-left,.rst-content .code-block-caption .fa-pull-left.headerlink,.rst-content .eqno .fa-pull-left.headerlink,.rst-content .fa-pull-left.admonition-title,.rst-content code.download span.fa-pull-left:first-child,.rst-content dl dt .fa-pull-left.headerlink,.rst-content h1 .fa-pull-left.headerlink,.rst-content h2 .fa-pull-left.headerlink,.rst-content h3 .fa-pull-left.headerlink,.rst-content h4 .fa-pull-left.headerlink,.rst-content h5 .fa-pull-left.headerlink,.rst-content h6 .fa-pull-left.headerlink,.rst-content p .fa-pull-left.headerlink,.rst-content table>caption .fa-pull-left.headerlink,.rst-content tt.download span.fa-pull-left:first-child,.wy-menu-vertical li.current>a button.fa-pull-left.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-left.toctree-expand,.wy-menu-vertical li button.fa-pull-left.toctree-expand{margin-right:.3em}.fa-pull-right.icon,.fa.fa-pull-right,.rst-content .code-block-caption .fa-pull-right.headerlink,.rst-content .eqno .fa-pull-right.headerlink,.rst-content .fa-pull-right.admonition-title,.rst-content code.download span.fa-pull-right:first-child,.rst-content dl dt .fa-pull-right.headerlink,.rst-content h1 .fa-pull-right.headerlink,.rst-content h2 .fa-pull-right.headerlink,.rst-content h3 .fa-pull-right.headerlink,.rst-content h4 .fa-pull-right.headerlink,.rst-content h5 .fa-pull-right.headerlink,.rst-content h6 .fa-pull-right.headerlink,.rst-content p .fa-pull-right.headerlink,.rst-content table>caption .fa-pull-right.headerlink,.rst-content tt.download span.fa-pull-right:first-child,.wy-menu-vertical li.current>a button.fa-pull-right.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-right.toctree-expand,.wy-menu-vertical li button.fa-pull-right.toctree-expand{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.pull-left.icon,.rst-content .code-block-caption .pull-left.headerlink,.rst-content .eqno .pull-left.headerlink,.rst-content .pull-left.admonition-title,.rst-content code.download span.pull-left:first-child,.rst-content dl dt .pull-left.headerlink,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content p .pull-left.headerlink,.rst-content table>caption .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.wy-menu-vertical li.current>a button.pull-left.toctree-expand,.wy-menu-vertical li.on a button.pull-left.toctree-expand,.wy-menu-vertical li button.pull-left.toctree-expand{margin-right:.3em}.fa.pull-right,.pull-right.icon,.rst-content .code-block-caption .pull-right.headerlink,.rst-content .eqno .pull-right.headerlink,.rst-content .pull-right.admonition-title,.rst-content code.download span.pull-right:first-child,.rst-content dl dt .pull-right.headerlink,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content p .pull-right.headerlink,.rst-content table>caption .pull-right.headerlink,.rst-content tt.download span.pull-right:first-child,.wy-menu-vertical li.current>a button.pull-right.toctree-expand,.wy-menu-vertical li.on a button.pull-right.toctree-expand,.wy-menu-vertical li button.pull-right.toctree-expand{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s linear infinite;animation:fa-spin 2s linear infinite}.fa-pulse{-webkit-animation:fa-spin 1s steps(8) infinite;animation:fa-spin 1s steps(8) infinite}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scaleX(-1);-ms-transform:scaleX(-1);transform:scaleX(-1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scaleY(-1);-ms-transform:scaleY(-1);transform:scaleY(-1)}:root .fa-flip-horizontal,:root .fa-flip-vertical,:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:""}.fa-music:before{content:""}.fa-search:before,.icon-search:before{content:""}.fa-envelope-o:before{content:""}.fa-heart:before{content:""}.fa-star:before{content:""}.fa-star-o:before{content:""}.fa-user:before{content:""}.fa-film:before{content:""}.fa-th-large:before{content:""}.fa-th:before{content:""}.fa-th-list:before{content:""}.fa-check:before{content:""}.fa-close:before,.fa-remove:before,.fa-times:before{content:""}.fa-search-plus:before{content:""}.fa-search-minus:before{content:""}.fa-power-off:before{content:""}.fa-signal:before{content:""}.fa-cog:before,.fa-gear:before{content:""}.fa-trash-o:before{content:""}.fa-home:before,.icon-home:before{content:""}.fa-file-o:before{content:""}.fa-clock-o:before{content:""}.fa-road:before{content:""}.fa-download:before,.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{content:""}.fa-arrow-circle-o-down:before{content:""}.fa-arrow-circle-o-up:before{content:""}.fa-inbox:before{content:""}.fa-play-circle-o:before{content:""}.fa-repeat:before,.fa-rotate-right:before{content:""}.fa-refresh:before{content:""}.fa-list-alt:before{content:""}.fa-lock:before{content:""}.fa-flag:before{content:""}.fa-headphones:before{content:""}.fa-volume-off:before{content:""}.fa-volume-down:before{content:""}.fa-volume-up:before{content:""}.fa-qrcode:before{content:""}.fa-barcode:before{content:""}.fa-tag:before{content:""}.fa-tags:before{content:""}.fa-book:before,.icon-book:before{content:""}.fa-bookmark:before{content:""}.fa-print:before{content:""}.fa-camera:before{content:""}.fa-font:before{content:""}.fa-bold:before{content:""}.fa-italic:before{content:""}.fa-text-height:before{content:""}.fa-text-width:before{content:""}.fa-align-left:before{content:""}.fa-align-center:before{content:""}.fa-align-right:before{content:""}.fa-align-justify:before{content:""}.fa-list:before{content:""}.fa-dedent:before,.fa-outdent:before{content:""}.fa-indent:before{content:""}.fa-video-camera:before{content:""}.fa-image:before,.fa-photo:before,.fa-picture-o:before{content:""}.fa-pencil:before{content:""}.fa-map-marker:before{content:""}.fa-adjust:before{content:""}.fa-tint:before{content:""}.fa-edit:before,.fa-pencil-square-o:before{content:""}.fa-share-square-o:before{content:""}.fa-check-square-o:before{content:""}.fa-arrows:before{content:""}.fa-step-backward:before{content:""}.fa-fast-backward:before{content:""}.fa-backward:before{content:""}.fa-play:before{content:""}.fa-pause:before{content:""}.fa-stop:before{content:""}.fa-forward:before{content:""}.fa-fast-forward:before{content:""}.fa-step-forward:before{content:""}.fa-eject:before{content:""}.fa-chevron-left:before{content:""}.fa-chevron-right:before{content:""}.fa-plus-circle:before{content:""}.fa-minus-circle:before{content:""}.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:""}.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:""}.fa-question-circle:before{content:""}.fa-info-circle:before{content:""}.fa-crosshairs:before{content:""}.fa-times-circle-o:before{content:""}.fa-check-circle-o:before{content:""}.fa-ban:before{content:""}.fa-arrow-left:before{content:""}.fa-arrow-right:before{content:""}.fa-arrow-up:before{content:""}.fa-arrow-down:before{content:""}.fa-mail-forward:before,.fa-share:before{content:""}.fa-expand:before{content:""}.fa-compress:before{content:""}.fa-plus:before{content:""}.fa-minus:before{content:""}.fa-asterisk:before{content:""}.fa-exclamation-circle:before,.rst-content .admonition-title:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before{content:""}.fa-gift:before{content:""}.fa-leaf:before{content:""}.fa-fire:before,.icon-fire:before{content:""}.fa-eye:before{content:""}.fa-eye-slash:before{content:""}.fa-exclamation-triangle:before,.fa-warning:before{content:""}.fa-plane:before{content:""}.fa-calendar:before{content:""}.fa-random:before{content:""}.fa-comment:before{content:""}.fa-magnet:before{content:""}.fa-chevron-up:before{content:""}.fa-chevron-down:before{content:""}.fa-retweet:before{content:""}.fa-shopping-cart:before{content:""}.fa-folder:before{content:""}.fa-folder-open:before{content:""}.fa-arrows-v:before{content:""}.fa-arrows-h:before{content:""}.fa-bar-chart-o:before,.fa-bar-chart:before{content:""}.fa-twitter-square:before{content:""}.fa-facebook-square:before{content:""}.fa-camera-retro:before{content:""}.fa-key:before{content:""}.fa-cogs:before,.fa-gears:before{content:""}.fa-comments:before{content:""}.fa-thumbs-o-up:before{content:""}.fa-thumbs-o-down:before{content:""}.fa-star-half:before{content:""}.fa-heart-o:before{content:""}.fa-sign-out:before{content:""}.fa-linkedin-square:before{content:""}.fa-thumb-tack:before{content:""}.fa-external-link:before{content:""}.fa-sign-in:before{content:""}.fa-trophy:before{content:""}.fa-github-square:before{content:""}.fa-upload:before{content:""}.fa-lemon-o:before{content:""}.fa-phone:before{content:""}.fa-square-o:before{content:""}.fa-bookmark-o:before{content:""}.fa-phone-square:before{content:""}.fa-twitter:before{content:""}.fa-facebook-f:before,.fa-facebook:before{content:""}.fa-github:before,.icon-github:before{content:""}.fa-unlock:before{content:""}.fa-credit-card:before{content:""}.fa-feed:before,.fa-rss:before{content:""}.fa-hdd-o:before{content:""}.fa-bullhorn:before{content:""}.fa-bell:before{content:""}.fa-certificate:before{content:""}.fa-hand-o-right:before{content:""}.fa-hand-o-left:before{content:""}.fa-hand-o-up:before{content:""}.fa-hand-o-down:before{content:""}.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:""}.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:""}.fa-arrow-circle-up:before{content:""}.fa-arrow-circle-down:before{content:""}.fa-globe:before{content:""}.fa-wrench:before{content:""}.fa-tasks:before{content:""}.fa-filter:before{content:""}.fa-briefcase:before{content:""}.fa-arrows-alt:before{content:""}.fa-group:before,.fa-users:before{content:""}.fa-chain:before,.fa-link:before,.icon-link:before{content:""}.fa-cloud:before{content:""}.fa-flask:before{content:""}.fa-cut:before,.fa-scissors:before{content:""}.fa-copy:before,.fa-files-o:before{content:""}.fa-paperclip:before{content:""}.fa-floppy-o:before,.fa-save:before{content:""}.fa-square:before{content:""}.fa-bars:before,.fa-navicon:before,.fa-reorder:before{content:""}.fa-list-ul:before{content:""}.fa-list-ol:before{content:""}.fa-strikethrough:before{content:""}.fa-underline:before{content:""}.fa-table:before{content:""}.fa-magic:before{content:""}.fa-truck:before{content:""}.fa-pinterest:before{content:""}.fa-pinterest-square:before{content:""}.fa-google-plus-square:before{content:""}.fa-google-plus:before{content:""}.fa-money:before{content:""}.fa-caret-down:before,.icon-caret-down:before,.wy-dropdown .caret:before{content:""}.fa-caret-up:before{content:""}.fa-caret-left:before{content:""}.fa-caret-right:before{content:""}.fa-columns:before{content:""}.fa-sort:before,.fa-unsorted:before{content:""}.fa-sort-desc:before,.fa-sort-down:before{content:""}.fa-sort-asc:before,.fa-sort-up:before{content:""}.fa-envelope:before{content:""}.fa-linkedin:before{content:""}.fa-rotate-left:before,.fa-undo:before{content:""}.fa-gavel:before,.fa-legal:before{content:""}.fa-dashboard:before,.fa-tachometer:before{content:""}.fa-comment-o:before{content:""}.fa-comments-o:before{content:""}.fa-bolt:before,.fa-flash:before{content:""}.fa-sitemap:before{content:""}.fa-umbrella:before{content:""}.fa-clipboard:before,.fa-paste:before{content:""}.fa-lightbulb-o:before{content:""}.fa-exchange:before{content:""}.fa-cloud-download:before{content:""}.fa-cloud-upload:before{content:""}.fa-user-md:before{content:""}.fa-stethoscope:before{content:""}.fa-suitcase:before{content:""}.fa-bell-o:before{content:""}.fa-coffee:before{content:""}.fa-cutlery:before{content:""}.fa-file-text-o:before{content:""}.fa-building-o:before{content:""}.fa-hospital-o:before{content:""}.fa-ambulance:before{content:""}.fa-medkit:before{content:""}.fa-fighter-jet:before{content:""}.fa-beer:before{content:""}.fa-h-square:before{content:""}.fa-plus-square:before{content:""}.fa-angle-double-left:before{content:""}.fa-angle-double-right:before{content:""}.fa-angle-double-up:before{content:""}.fa-angle-double-down:before{content:""}.fa-angle-left:before{content:""}.fa-angle-right:before{content:""}.fa-angle-up:before{content:""}.fa-angle-down:before{content:""}.fa-desktop:before{content:""}.fa-laptop:before{content:""}.fa-tablet:before{content:""}.fa-mobile-phone:before,.fa-mobile:before{content:""}.fa-circle-o:before{content:""}.fa-quote-left:before{content:""}.fa-quote-right:before{content:""}.fa-spinner:before{content:""}.fa-circle:before{content:""}.fa-mail-reply:before,.fa-reply:before{content:""}.fa-github-alt:before{content:""}.fa-folder-o:before{content:""}.fa-folder-open-o:before{content:""}.fa-smile-o:before{content:""}.fa-frown-o:before{content:""}.fa-meh-o:before{content:""}.fa-gamepad:before{content:""}.fa-keyboard-o:before{content:""}.fa-flag-o:before{content:""}.fa-flag-checkered:before{content:""}.fa-terminal:before{content:""}.fa-code:before{content:""}.fa-mail-reply-all:before,.fa-reply-all:before{content:""}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:""}.fa-location-arrow:before{content:""}.fa-crop:before{content:""}.fa-code-fork:before{content:""}.fa-chain-broken:before,.fa-unlink:before{content:""}.fa-question:before{content:""}.fa-info:before{content:""}.fa-exclamation:before{content:""}.fa-superscript:before{content:""}.fa-subscript:before{content:""}.fa-eraser:before{content:""}.fa-puzzle-piece:before{content:""}.fa-microphone:before{content:""}.fa-microphone-slash:before{content:""}.fa-shield:before{content:""}.fa-calendar-o:before{content:""}.fa-fire-extinguisher:before{content:""}.fa-rocket:before{content:""}.fa-maxcdn:before{content:""}.fa-chevron-circle-left:before{content:""}.fa-chevron-circle-right:before{content:""}.fa-chevron-circle-up:before{content:""}.fa-chevron-circle-down:before{content:""}.fa-html5:before{content:""}.fa-css3:before{content:""}.fa-anchor:before{content:""}.fa-unlock-alt:before{content:""}.fa-bullseye:before{content:""}.fa-ellipsis-h:before{content:""}.fa-ellipsis-v:before{content:""}.fa-rss-square:before{content:""}.fa-play-circle:before{content:""}.fa-ticket:before{content:""}.fa-minus-square:before{content:""}.fa-minus-square-o:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before{content:""}.fa-level-up:before{content:""}.fa-level-down:before{content:""}.fa-check-square:before{content:""}.fa-pencil-square:before{content:""}.fa-external-link-square:before{content:""}.fa-share-square:before{content:""}.fa-compass:before{content:""}.fa-caret-square-o-down:before,.fa-toggle-down:before{content:""}.fa-caret-square-o-up:before,.fa-toggle-up:before{content:""}.fa-caret-square-o-right:before,.fa-toggle-right:before{content:""}.fa-eur:before,.fa-euro:before{content:""}.fa-gbp:before{content:""}.fa-dollar:before,.fa-usd:before{content:""}.fa-inr:before,.fa-rupee:before{content:""}.fa-cny:before,.fa-jpy:before,.fa-rmb:before,.fa-yen:before{content:""}.fa-rouble:before,.fa-rub:before,.fa-ruble:before{content:""}.fa-krw:before,.fa-won:before{content:""}.fa-bitcoin:before,.fa-btc:before{content:""}.fa-file:before{content:""}.fa-file-text:before{content:""}.fa-sort-alpha-asc:before{content:""}.fa-sort-alpha-desc:before{content:""}.fa-sort-amount-asc:before{content:""}.fa-sort-amount-desc:before{content:""}.fa-sort-numeric-asc:before{content:""}.fa-sort-numeric-desc:before{content:""}.fa-thumbs-up:before{content:""}.fa-thumbs-down:before{content:""}.fa-youtube-square:before{content:""}.fa-youtube:before{content:""}.fa-xing:before{content:""}.fa-xing-square:before{content:""}.fa-youtube-play:before{content:""}.fa-dropbox:before{content:""}.fa-stack-overflow:before{content:""}.fa-instagram:before{content:""}.fa-flickr:before{content:""}.fa-adn:before{content:""}.fa-bitbucket:before,.icon-bitbucket:before{content:""}.fa-bitbucket-square:before{content:""}.fa-tumblr:before{content:""}.fa-tumblr-square:before{content:""}.fa-long-arrow-down:before{content:""}.fa-long-arrow-up:before{content:""}.fa-long-arrow-left:before{content:""}.fa-long-arrow-right:before{content:""}.fa-apple:before{content:""}.fa-windows:before{content:""}.fa-android:before{content:""}.fa-linux:before{content:""}.fa-dribbble:before{content:""}.fa-skype:before{content:""}.fa-foursquare:before{content:""}.fa-trello:before{content:""}.fa-female:before{content:""}.fa-male:before{content:""}.fa-gittip:before,.fa-gratipay:before{content:""}.fa-sun-o:before{content:""}.fa-moon-o:before{content:""}.fa-archive:before{content:""}.fa-bug:before{content:""}.fa-vk:before{content:""}.fa-weibo:before{content:""}.fa-renren:before{content:""}.fa-pagelines:before{content:""}.fa-stack-exchange:before{content:""}.fa-arrow-circle-o-right:before{content:""}.fa-arrow-circle-o-left:before{content:""}.fa-caret-square-o-left:before,.fa-toggle-left:before{content:""}.fa-dot-circle-o:before{content:""}.fa-wheelchair:before{content:""}.fa-vimeo-square:before{content:""}.fa-try:before,.fa-turkish-lira:before{content:""}.fa-plus-square-o:before,.wy-menu-vertical li button.toctree-expand:before{content:""}.fa-space-shuttle:before{content:""}.fa-slack:before{content:""}.fa-envelope-square:before{content:""}.fa-wordpress:before{content:""}.fa-openid:before{content:""}.fa-bank:before,.fa-institution:before,.fa-university:before{content:""}.fa-graduation-cap:before,.fa-mortar-board:before{content:""}.fa-yahoo:before{content:""}.fa-google:before{content:""}.fa-reddit:before{content:""}.fa-reddit-square:before{content:""}.fa-stumbleupon-circle:before{content:""}.fa-stumbleupon:before{content:""}.fa-delicious:before{content:""}.fa-digg:before{content:""}.fa-pied-piper-pp:before{content:""}.fa-pied-piper-alt:before{content:""}.fa-drupal:before{content:""}.fa-joomla:before{content:""}.fa-language:before{content:""}.fa-fax:before{content:""}.fa-building:before{content:""}.fa-child:before{content:""}.fa-paw:before{content:""}.fa-spoon:before{content:""}.fa-cube:before{content:""}.fa-cubes:before{content:""}.fa-behance:before{content:""}.fa-behance-square:before{content:""}.fa-steam:before{content:""}.fa-steam-square:before{content:""}.fa-recycle:before{content:""}.fa-automobile:before,.fa-car:before{content:""}.fa-cab:before,.fa-taxi:before{content:""}.fa-tree:before{content:""}.fa-spotify:before{content:""}.fa-deviantart:before{content:""}.fa-soundcloud:before{content:""}.fa-database:before{content:""}.fa-file-pdf-o:before{content:""}.fa-file-word-o:before{content:""}.fa-file-excel-o:before{content:""}.fa-file-powerpoint-o:before{content:""}.fa-file-image-o:before,.fa-file-photo-o:before,.fa-file-picture-o:before{content:""}.fa-file-archive-o:before,.fa-file-zip-o:before{content:""}.fa-file-audio-o:before,.fa-file-sound-o:before{content:""}.fa-file-movie-o:before,.fa-file-video-o:before{content:""}.fa-file-code-o:before{content:""}.fa-vine:before{content:""}.fa-codepen:before{content:""}.fa-jsfiddle:before{content:""}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-ring:before,.fa-life-saver:before,.fa-support:before{content:""}.fa-circle-o-notch:before{content:""}.fa-ra:before,.fa-rebel:before,.fa-resistance:before{content:""}.fa-empire:before,.fa-ge:before{content:""}.fa-git-square:before{content:""}.fa-git:before{content:""}.fa-hacker-news:before,.fa-y-combinator-square:before,.fa-yc-square:before{content:""}.fa-tencent-weibo:before{content:""}.fa-qq:before{content:""}.fa-wechat:before,.fa-weixin:before{content:""}.fa-paper-plane:before,.fa-send:before{content:""}.fa-paper-plane-o:before,.fa-send-o:before{content:""}.fa-history:before{content:""}.fa-circle-thin:before{content:""}.fa-header:before{content:""}.fa-paragraph:before{content:""}.fa-sliders:before{content:""}.fa-share-alt:before{content:""}.fa-share-alt-square:before{content:""}.fa-bomb:before{content:""}.fa-futbol-o:before,.fa-soccer-ball-o:before{content:""}.fa-tty:before{content:""}.fa-binoculars:before{content:""}.fa-plug:before{content:""}.fa-slideshare:before{content:""}.fa-twitch:before{content:""}.fa-yelp:before{content:""}.fa-newspaper-o:before{content:""}.fa-wifi:before{content:""}.fa-calculator:before{content:""}.fa-paypal:before{content:""}.fa-google-wallet:before{content:""}.fa-cc-visa:before{content:""}.fa-cc-mastercard:before{content:""}.fa-cc-discover:before{content:""}.fa-cc-amex:before{content:""}.fa-cc-paypal:before{content:""}.fa-cc-stripe:before{content:""}.fa-bell-slash:before{content:""}.fa-bell-slash-o:before{content:""}.fa-trash:before{content:""}.fa-copyright:before{content:""}.fa-at:before{content:""}.fa-eyedropper:before{content:""}.fa-paint-brush:before{content:""}.fa-birthday-cake:before{content:""}.fa-area-chart:before{content:""}.fa-pie-chart:before{content:""}.fa-line-chart:before{content:""}.fa-lastfm:before{content:""}.fa-lastfm-square:before{content:""}.fa-toggle-off:before{content:""}.fa-toggle-on:before{content:""}.fa-bicycle:before{content:""}.fa-bus:before{content:""}.fa-ioxhost:before{content:""}.fa-angellist:before{content:""}.fa-cc:before{content:""}.fa-ils:before,.fa-shekel:before,.fa-sheqel:before{content:""}.fa-meanpath:before{content:""}.fa-buysellads:before{content:""}.fa-connectdevelop:before{content:""}.fa-dashcube:before{content:""}.fa-forumbee:before{content:""}.fa-leanpub:before{content:""}.fa-sellsy:before{content:""}.fa-shirtsinbulk:before{content:""}.fa-simplybuilt:before{content:""}.fa-skyatlas:before{content:""}.fa-cart-plus:before{content:""}.fa-cart-arrow-down:before{content:""}.fa-diamond:before{content:""}.fa-ship:before{content:""}.fa-user-secret:before{content:""}.fa-motorcycle:before{content:""}.fa-street-view:before{content:""}.fa-heartbeat:before{content:""}.fa-venus:before{content:""}.fa-mars:before{content:""}.fa-mercury:before{content:""}.fa-intersex:before,.fa-transgender:before{content:""}.fa-transgender-alt:before{content:""}.fa-venus-double:before{content:""}.fa-mars-double:before{content:""}.fa-venus-mars:before{content:""}.fa-mars-stroke:before{content:""}.fa-mars-stroke-v:before{content:""}.fa-mars-stroke-h:before{content:""}.fa-neuter:before{content:""}.fa-genderless:before{content:""}.fa-facebook-official:before{content:""}.fa-pinterest-p:before{content:""}.fa-whatsapp:before{content:""}.fa-server:before{content:""}.fa-user-plus:before{content:""}.fa-user-times:before{content:""}.fa-bed:before,.fa-hotel:before{content:""}.fa-viacoin:before{content:""}.fa-train:before{content:""}.fa-subway:before{content:""}.fa-medium:before{content:""}.fa-y-combinator:before,.fa-yc:before{content:""}.fa-optin-monster:before{content:""}.fa-opencart:before{content:""}.fa-expeditedssl:before{content:""}.fa-battery-4:before,.fa-battery-full:before,.fa-battery:before{content:""}.fa-battery-3:before,.fa-battery-three-quarters:before{content:""}.fa-battery-2:before,.fa-battery-half:before{content:""}.fa-battery-1:before,.fa-battery-quarter:before{content:""}.fa-battery-0:before,.fa-battery-empty:before{content:""}.fa-mouse-pointer:before{content:""}.fa-i-cursor:before{content:""}.fa-object-group:before{content:""}.fa-object-ungroup:before{content:""}.fa-sticky-note:before{content:""}.fa-sticky-note-o:before{content:""}.fa-cc-jcb:before{content:""}.fa-cc-diners-club:before{content:""}.fa-clone:before{content:""}.fa-balance-scale:before{content:""}.fa-hourglass-o:before{content:""}.fa-hourglass-1:before,.fa-hourglass-start:before{content:""}.fa-hourglass-2:before,.fa-hourglass-half:before{content:""}.fa-hourglass-3:before,.fa-hourglass-end:before{content:""}.fa-hourglass:before{content:""}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:""}.fa-hand-paper-o:before,.fa-hand-stop-o:before{content:""}.fa-hand-scissors-o:before{content:""}.fa-hand-lizard-o:before{content:""}.fa-hand-spock-o:before{content:""}.fa-hand-pointer-o:before{content:""}.fa-hand-peace-o:before{content:""}.fa-trademark:before{content:""}.fa-registered:before{content:""}.fa-creative-commons:before{content:""}.fa-gg:before{content:""}.fa-gg-circle:before{content:""}.fa-tripadvisor:before{content:""}.fa-odnoklassniki:before{content:""}.fa-odnoklassniki-square:before{content:""}.fa-get-pocket:before{content:""}.fa-wikipedia-w:before{content:""}.fa-safari:before{content:""}.fa-chrome:before{content:""}.fa-firefox:before{content:""}.fa-opera:before{content:""}.fa-internet-explorer:before{content:""}.fa-television:before,.fa-tv:before{content:""}.fa-contao:before{content:""}.fa-500px:before{content:""}.fa-amazon:before{content:""}.fa-calendar-plus-o:before{content:""}.fa-calendar-minus-o:before{content:""}.fa-calendar-times-o:before{content:""}.fa-calendar-check-o:before{content:""}.fa-industry:before{content:""}.fa-map-pin:before{content:""}.fa-map-signs:before{content:""}.fa-map-o:before{content:""}.fa-map:before{content:""}.fa-commenting:before{content:""}.fa-commenting-o:before{content:""}.fa-houzz:before{content:""}.fa-vimeo:before{content:""}.fa-black-tie:before{content:""}.fa-fonticons:before{content:""}.fa-reddit-alien:before{content:""}.fa-edge:before{content:""}.fa-credit-card-alt:before{content:""}.fa-codiepie:before{content:""}.fa-modx:before{content:""}.fa-fort-awesome:before{content:""}.fa-usb:before{content:""}.fa-product-hunt:before{content:""}.fa-mixcloud:before{content:""}.fa-scribd:before{content:""}.fa-pause-circle:before{content:""}.fa-pause-circle-o:before{content:""}.fa-stop-circle:before{content:""}.fa-stop-circle-o:before{content:""}.fa-shopping-bag:before{content:""}.fa-shopping-basket:before{content:""}.fa-hashtag:before{content:""}.fa-bluetooth:before{content:""}.fa-bluetooth-b:before{content:""}.fa-percent:before{content:""}.fa-gitlab:before,.icon-gitlab:before{content:""}.fa-wpbeginner:before{content:""}.fa-wpforms:before{content:""}.fa-envira:before{content:""}.fa-universal-access:before{content:""}.fa-wheelchair-alt:before{content:""}.fa-question-circle-o:before{content:""}.fa-blind:before{content:""}.fa-audio-description:before{content:""}.fa-volume-control-phone:before{content:""}.fa-braille:before{content:""}.fa-assistive-listening-systems:before{content:""}.fa-american-sign-language-interpreting:before,.fa-asl-interpreting:before{content:""}.fa-deaf:before,.fa-deafness:before,.fa-hard-of-hearing:before{content:""}.fa-glide:before{content:""}.fa-glide-g:before{content:""}.fa-sign-language:before,.fa-signing:before{content:""}.fa-low-vision:before{content:""}.fa-viadeo:before{content:""}.fa-viadeo-square:before{content:""}.fa-snapchat:before{content:""}.fa-snapchat-ghost:before{content:""}.fa-snapchat-square:before{content:""}.fa-pied-piper:before{content:""}.fa-first-order:before{content:""}.fa-yoast:before{content:""}.fa-themeisle:before{content:""}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:""}.fa-fa:before,.fa-font-awesome:before{content:""}.fa-handshake-o:before{content:""}.fa-envelope-open:before{content:""}.fa-envelope-open-o:before{content:""}.fa-linode:before{content:""}.fa-address-book:before{content:""}.fa-address-book-o:before{content:""}.fa-address-card:before,.fa-vcard:before{content:""}.fa-address-card-o:before,.fa-vcard-o:before{content:""}.fa-user-circle:before{content:""}.fa-user-circle-o:before{content:""}.fa-user-o:before{content:""}.fa-id-badge:before{content:""}.fa-drivers-license:before,.fa-id-card:before{content:""}.fa-drivers-license-o:before,.fa-id-card-o:before{content:""}.fa-quora:before{content:""}.fa-free-code-camp:before{content:""}.fa-telegram:before{content:""}.fa-thermometer-4:before,.fa-thermometer-full:before,.fa-thermometer:before{content:""}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:""}.fa-thermometer-2:before,.fa-thermometer-half:before{content:""}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:""}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:""}.fa-shower:before{content:""}.fa-bath:before,.fa-bathtub:before,.fa-s15:before{content:""}.fa-podcast:before{content:""}.fa-window-maximize:before{content:""}.fa-window-minimize:before{content:""}.fa-window-restore:before{content:""}.fa-times-rectangle:before,.fa-window-close:before{content:""}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:""}.fa-bandcamp:before{content:""}.fa-grav:before{content:""}.fa-etsy:before{content:""}.fa-imdb:before{content:""}.fa-ravelry:before{content:""}.fa-eercast:before{content:""}.fa-microchip:before{content:""}.fa-snowflake-o:before{content:""}.fa-superpowers:before{content:""}.fa-wpexplorer:before{content:""}.fa-meetup:before{content:""}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-dropdown .caret,.wy-inline-validate.wy-inline-validate-danger .wy-input-context,.wy-inline-validate.wy-inline-validate-info .wy-input-context,.wy-inline-validate.wy-inline-validate-success .wy-input-context,.wy-inline-validate.wy-inline-validate-warning .wy-input-context,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{font-family:inherit}.fa:before,.icon:before,.rst-content .admonition-title:before,.rst-content .code-block-caption .headerlink:before,.rst-content .eqno .headerlink:before,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before{font-family:FontAwesome;display:inline-block;font-style:normal;font-weight:400;line-height:1;text-decoration:inherit}.rst-content .code-block-caption a .headerlink,.rst-content .eqno a .headerlink,.rst-content a .admonition-title,.rst-content code.download a span:first-child,.rst-content dl dt a .headerlink,.rst-content h1 a .headerlink,.rst-content h2 a .headerlink,.rst-content h3 a .headerlink,.rst-content h4 a .headerlink,.rst-content h5 a .headerlink,.rst-content h6 a .headerlink,.rst-content p.caption a .headerlink,.rst-content p a .headerlink,.rst-content table>caption a .headerlink,.rst-content tt.download a span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li a button.toctree-expand,a .fa,a .icon,a .rst-content .admonition-title,a .rst-content .code-block-caption .headerlink,a .rst-content .eqno .headerlink,a .rst-content code.download span:first-child,a .rst-content dl dt .headerlink,a .rst-content h1 .headerlink,a .rst-content h2 .headerlink,a .rst-content h3 .headerlink,a .rst-content h4 .headerlink,a .rst-content h5 .headerlink,a .rst-content h6 .headerlink,a .rst-content p.caption .headerlink,a .rst-content p .headerlink,a .rst-content table>caption .headerlink,a .rst-content tt.download span:first-child,a .wy-menu-vertical li button.toctree-expand{display:inline-block;text-decoration:inherit}.btn .fa,.btn .icon,.btn .rst-content .admonition-title,.btn .rst-content .code-block-caption .headerlink,.btn .rst-content .eqno .headerlink,.btn .rst-content code.download span:first-child,.btn .rst-content dl dt .headerlink,.btn .rst-content h1 .headerlink,.btn .rst-content h2 .headerlink,.btn .rst-content h3 .headerlink,.btn .rst-content h4 .headerlink,.btn .rst-content h5 .headerlink,.btn .rst-content h6 .headerlink,.btn .rst-content p .headerlink,.btn .rst-content table>caption .headerlink,.btn .rst-content tt.download span:first-child,.btn .wy-menu-vertical li.current>a button.toctree-expand,.btn .wy-menu-vertical li.on a button.toctree-expand,.btn .wy-menu-vertical li button.toctree-expand,.nav .fa,.nav .icon,.nav .rst-content .admonition-title,.nav .rst-content .code-block-caption .headerlink,.nav .rst-content .eqno .headerlink,.nav .rst-content code.download span:first-child,.nav .rst-content dl dt .headerlink,.nav .rst-content h1 .headerlink,.nav .rst-content h2 .headerlink,.nav .rst-content h3 .headerlink,.nav .rst-content h4 .headerlink,.nav .rst-content h5 .headerlink,.nav .rst-content h6 .headerlink,.nav .rst-content p .headerlink,.nav .rst-content table>caption .headerlink,.nav .rst-content tt.download span:first-child,.nav .wy-menu-vertical li.current>a button.toctree-expand,.nav .wy-menu-vertical li.on a button.toctree-expand,.nav .wy-menu-vertical li button.toctree-expand,.rst-content .btn .admonition-title,.rst-content .code-block-caption .btn .headerlink,.rst-content .code-block-caption .nav .headerlink,.rst-content .eqno .btn .headerlink,.rst-content .eqno .nav .headerlink,.rst-content .nav .admonition-title,.rst-content code.download .btn span:first-child,.rst-content code.download .nav span:first-child,.rst-content dl dt .btn .headerlink,.rst-content dl dt .nav .headerlink,.rst-content h1 .btn .headerlink,.rst-content h1 .nav .headerlink,.rst-content h2 .btn .headerlink,.rst-content h2 .nav .headerlink,.rst-content h3 .btn .headerlink,.rst-content h3 .nav .headerlink,.rst-content h4 .btn .headerlink,.rst-content h4 .nav .headerlink,.rst-content h5 .btn .headerlink,.rst-content h5 .nav .headerlink,.rst-content h6 .btn .headerlink,.rst-content h6 .nav .headerlink,.rst-content p .btn .headerlink,.rst-content p .nav .headerlink,.rst-content table>caption .btn .headerlink,.rst-content table>caption .nav .headerlink,.rst-content tt.download .btn span:first-child,.rst-content tt.download .nav span:first-child,.wy-menu-vertical li .btn button.toctree-expand,.wy-menu-vertical li.current>a .btn button.toctree-expand,.wy-menu-vertical li.current>a .nav button.toctree-expand,.wy-menu-vertical li .nav button.toctree-expand,.wy-menu-vertical li.on a .btn button.toctree-expand,.wy-menu-vertical li.on a .nav button.toctree-expand{display:inline}.btn .fa-large.icon,.btn .fa.fa-large,.btn .rst-content .code-block-caption .fa-large.headerlink,.btn .rst-content .eqno .fa-large.headerlink,.btn .rst-content .fa-large.admonition-title,.btn .rst-content code.download span.fa-large:first-child,.btn .rst-content dl dt .fa-large.headerlink,.btn .rst-content h1 .fa-large.headerlink,.btn .rst-content h2 .fa-large.headerlink,.btn .rst-content h3 .fa-large.headerlink,.btn .rst-content h4 .fa-large.headerlink,.btn .rst-content h5 .fa-large.headerlink,.btn .rst-content h6 .fa-large.headerlink,.btn .rst-content p .fa-large.headerlink,.btn .rst-content table>caption .fa-large.headerlink,.btn .rst-content tt.download span.fa-large:first-child,.btn .wy-menu-vertical li button.fa-large.toctree-expand,.nav .fa-large.icon,.nav .fa.fa-large,.nav .rst-content .code-block-caption .fa-large.headerlink,.nav .rst-content .eqno .fa-large.headerlink,.nav .rst-content .fa-large.admonition-title,.nav .rst-content code.download span.fa-large:first-child,.nav .rst-content dl dt .fa-large.headerlink,.nav .rst-content h1 .fa-large.headerlink,.nav .rst-content h2 .fa-large.headerlink,.nav .rst-content h3 .fa-large.headerlink,.nav .rst-content h4 .fa-large.headerlink,.nav .rst-content h5 .fa-large.headerlink,.nav .rst-content h6 .fa-large.headerlink,.nav .rst-content p .fa-large.headerlink,.nav .rst-content table>caption .fa-large.headerlink,.nav .rst-content tt.download span.fa-large:first-child,.nav .wy-menu-vertical li button.fa-large.toctree-expand,.rst-content .btn .fa-large.admonition-title,.rst-content .code-block-caption .btn .fa-large.headerlink,.rst-content .code-block-caption .nav .fa-large.headerlink,.rst-content .eqno .btn .fa-large.headerlink,.rst-content .eqno .nav .fa-large.headerlink,.rst-content .nav .fa-large.admonition-title,.rst-content code.download .btn span.fa-large:first-child,.rst-content code.download .nav span.fa-large:first-child,.rst-content dl dt .btn .fa-large.headerlink,.rst-content dl dt .nav .fa-large.headerlink,.rst-content h1 .btn .fa-large.headerlink,.rst-content h1 .nav .fa-large.headerlink,.rst-content h2 .btn .fa-large.headerlink,.rst-content h2 .nav .fa-large.headerlink,.rst-content h3 .btn .fa-large.headerlink,.rst-content h3 .nav .fa-large.headerlink,.rst-content h4 .btn .fa-large.headerlink,.rst-content h4 .nav .fa-large.headerlink,.rst-content h5 .btn .fa-large.headerlink,.rst-content h5 .nav .fa-large.headerlink,.rst-content h6 .btn .fa-large.headerlink,.rst-content h6 .nav .fa-large.headerlink,.rst-content p .btn .fa-large.headerlink,.rst-content p .nav .fa-large.headerlink,.rst-content table>caption .btn .fa-large.headerlink,.rst-content table>caption .nav .fa-large.headerlink,.rst-content tt.download .btn span.fa-large:first-child,.rst-content tt.download .nav span.fa-large:first-child,.wy-menu-vertical li .btn button.fa-large.toctree-expand,.wy-menu-vertical li .nav button.fa-large.toctree-expand{line-height:.9em}.btn .fa-spin.icon,.btn .fa.fa-spin,.btn .rst-content .code-block-caption .fa-spin.headerlink,.btn .rst-content .eqno .fa-spin.headerlink,.btn .rst-content .fa-spin.admonition-title,.btn .rst-content code.download span.fa-spin:first-child,.btn .rst-content dl dt .fa-spin.headerlink,.btn .rst-content h1 .fa-spin.headerlink,.btn .rst-content h2 .fa-spin.headerlink,.btn .rst-content h3 .fa-spin.headerlink,.btn .rst-content h4 .fa-spin.headerlink,.btn .rst-content h5 .fa-spin.headerlink,.btn .rst-content h6 .fa-spin.headerlink,.btn .rst-content p .fa-spin.headerlink,.btn .rst-content table>caption .fa-spin.headerlink,.btn .rst-content tt.download span.fa-spin:first-child,.btn .wy-menu-vertical li button.fa-spin.toctree-expand,.nav .fa-spin.icon,.nav .fa.fa-spin,.nav .rst-content .code-block-caption .fa-spin.headerlink,.nav .rst-content .eqno .fa-spin.headerlink,.nav .rst-content .fa-spin.admonition-title,.nav .rst-content code.download span.fa-spin:first-child,.nav .rst-content dl dt .fa-spin.headerlink,.nav .rst-content h1 .fa-spin.headerlink,.nav .rst-content h2 .fa-spin.headerlink,.nav .rst-content h3 .fa-spin.headerlink,.nav .rst-content h4 .fa-spin.headerlink,.nav .rst-content h5 .fa-spin.headerlink,.nav .rst-content h6 .fa-spin.headerlink,.nav .rst-content p .fa-spin.headerlink,.nav .rst-content table>caption .fa-spin.headerlink,.nav .rst-content tt.download span.fa-spin:first-child,.nav .wy-menu-vertical li button.fa-spin.toctree-expand,.rst-content .btn .fa-spin.admonition-title,.rst-content .code-block-caption .btn .fa-spin.headerlink,.rst-content .code-block-caption .nav .fa-spin.headerlink,.rst-content .eqno .btn .fa-spin.headerlink,.rst-content .eqno .nav .fa-spin.headerlink,.rst-content .nav .fa-spin.admonition-title,.rst-content code.download .btn span.fa-spin:first-child,.rst-content code.download .nav span.fa-spin:first-child,.rst-content dl dt .btn .fa-spin.headerlink,.rst-content dl dt .nav .fa-spin.headerlink,.rst-content h1 .btn .fa-spin.headerlink,.rst-content h1 .nav .fa-spin.headerlink,.rst-content h2 .btn .fa-spin.headerlink,.rst-content h2 .nav .fa-spin.headerlink,.rst-content h3 .btn .fa-spin.headerlink,.rst-content h3 .nav .fa-spin.headerlink,.rst-content h4 .btn .fa-spin.headerlink,.rst-content h4 .nav .fa-spin.headerlink,.rst-content h5 .btn .fa-spin.headerlink,.rst-content h5 .nav .fa-spin.headerlink,.rst-content h6 .btn .fa-spin.headerlink,.rst-content h6 .nav .fa-spin.headerlink,.rst-content p .btn .fa-spin.headerlink,.rst-content p .nav .fa-spin.headerlink,.rst-content table>caption .btn .fa-spin.headerlink,.rst-content table>caption .nav .fa-spin.headerlink,.rst-content tt.download .btn span.fa-spin:first-child,.rst-content tt.download .nav span.fa-spin:first-child,.wy-menu-vertical li .btn button.fa-spin.toctree-expand,.wy-menu-vertical li .nav button.fa-spin.toctree-expand{display:inline-block}.btn.fa:before,.btn.icon:before,.rst-content .btn.admonition-title:before,.rst-content .code-block-caption .btn.headerlink:before,.rst-content .eqno .btn.headerlink:before,.rst-content code.download span.btn:first-child:before,.rst-content dl dt .btn.headerlink:before,.rst-content h1 .btn.headerlink:before,.rst-content h2 .btn.headerlink:before,.rst-content h3 .btn.headerlink:before,.rst-content h4 .btn.headerlink:before,.rst-content h5 .btn.headerlink:before,.rst-content h6 .btn.headerlink:before,.rst-content p .btn.headerlink:before,.rst-content table>caption .btn.headerlink:before,.rst-content tt.download span.btn:first-child:before,.wy-menu-vertical li button.btn.toctree-expand:before{opacity:.5;-webkit-transition:opacity .05s ease-in;-moz-transition:opacity .05s ease-in;transition:opacity .05s ease-in}.btn.fa:hover:before,.btn.icon:hover:before,.rst-content .btn.admonition-title:hover:before,.rst-content .code-block-caption .btn.headerlink:hover:before,.rst-content .eqno .btn.headerlink:hover:before,.rst-content code.download span.btn:first-child:hover:before,.rst-content dl dt .btn.headerlink:hover:before,.rst-content h1 .btn.headerlink:hover:before,.rst-content h2 .btn.headerlink:hover:before,.rst-content h3 .btn.headerlink:hover:before,.rst-content h4 .btn.headerlink:hover:before,.rst-content h5 .btn.headerlink:hover:before,.rst-content h6 .btn.headerlink:hover:before,.rst-content p .btn.headerlink:hover:before,.rst-content table>caption .btn.headerlink:hover:before,.rst-content tt.download span.btn:first-child:hover:before,.wy-menu-vertical li button.btn.toctree-expand:hover:before{opacity:1}.btn-mini .fa:before,.btn-mini .icon:before,.btn-mini .rst-content .admonition-title:before,.btn-mini .rst-content .code-block-caption .headerlink:before,.btn-mini .rst-content .eqno .headerlink:before,.btn-mini .rst-content code.download span:first-child:before,.btn-mini .rst-content dl dt .headerlink:before,.btn-mini .rst-content h1 .headerlink:before,.btn-mini .rst-content h2 .headerlink:before,.btn-mini .rst-content h3 .headerlink:before,.btn-mini .rst-content h4 .headerlink:before,.btn-mini .rst-content h5 .headerlink:before,.btn-mini .rst-content h6 .headerlink:before,.btn-mini .rst-content p .headerlink:before,.btn-mini .rst-content table>caption .headerlink:before,.btn-mini .rst-content tt.download span:first-child:before,.btn-mini .wy-menu-vertical li button.toctree-expand:before,.rst-content .btn-mini .admonition-title:before,.rst-content .code-block-caption .btn-mini .headerlink:before,.rst-content .eqno .btn-mini .headerlink:before,.rst-content code.download .btn-mini span:first-child:before,.rst-content dl dt .btn-mini .headerlink:before,.rst-content h1 .btn-mini .headerlink:before,.rst-content h2 .btn-mini .headerlink:before,.rst-content h3 .btn-mini .headerlink:before,.rst-content h4 .btn-mini .headerlink:before,.rst-content h5 .btn-mini .headerlink:before,.rst-content h6 .btn-mini .headerlink:before,.rst-content p .btn-mini .headerlink:before,.rst-content table>caption .btn-mini .headerlink:before,.rst-content tt.download .btn-mini span:first-child:before,.wy-menu-vertical li .btn-mini button.toctree-expand:before{font-size:14px;vertical-align:-15%}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.wy-alert{padding:12px;line-height:24px;margin-bottom:24px;background:#e7f2fa}.rst-content .admonition-title,.wy-alert-title{font-weight:700;display:block;color:#fff;background:#6ab0de;padding:6px 12px;margin:-12px -12px 12px}.rst-content .danger,.rst-content .error,.rst-content .wy-alert-danger.admonition,.rst-content .wy-alert-danger.admonition-todo,.rst-content .wy-alert-danger.attention,.rst-content .wy-alert-danger.caution,.rst-content .wy-alert-danger.hint,.rst-content .wy-alert-danger.important,.rst-content .wy-alert-danger.note,.rst-content .wy-alert-danger.seealso,.rst-content .wy-alert-danger.tip,.rst-content .wy-alert-danger.warning,.wy-alert.wy-alert-danger{background:#fdf3f2}.rst-content .danger .admonition-title,.rst-content .danger .wy-alert-title,.rst-content .error .admonition-title,.rst-content .error .wy-alert-title,.rst-content .wy-alert-danger.admonition-todo .admonition-title,.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,.rst-content .wy-alert-danger.admonition .admonition-title,.rst-content .wy-alert-danger.admonition .wy-alert-title,.rst-content .wy-alert-danger.attention .admonition-title,.rst-content .wy-alert-danger.attention .wy-alert-title,.rst-content .wy-alert-danger.caution .admonition-title,.rst-content .wy-alert-danger.caution .wy-alert-title,.rst-content .wy-alert-danger.hint .admonition-title,.rst-content .wy-alert-danger.hint .wy-alert-title,.rst-content .wy-alert-danger.important .admonition-title,.rst-content .wy-alert-danger.important .wy-alert-title,.rst-content .wy-alert-danger.note .admonition-title,.rst-content .wy-alert-danger.note .wy-alert-title,.rst-content .wy-alert-danger.seealso .admonition-title,.rst-content .wy-alert-danger.seealso .wy-alert-title,.rst-content .wy-alert-danger.tip .admonition-title,.rst-content .wy-alert-danger.tip .wy-alert-title,.rst-content .wy-alert-danger.warning .admonition-title,.rst-content .wy-alert-danger.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-danger .admonition-title,.wy-alert.wy-alert-danger .rst-content .admonition-title,.wy-alert.wy-alert-danger .wy-alert-title{background:#f29f97}.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .warning,.rst-content .wy-alert-warning.admonition,.rst-content .wy-alert-warning.danger,.rst-content .wy-alert-warning.error,.rst-content .wy-alert-warning.hint,.rst-content .wy-alert-warning.important,.rst-content .wy-alert-warning.note,.rst-content .wy-alert-warning.seealso,.rst-content .wy-alert-warning.tip,.wy-alert.wy-alert-warning{background:#ffedcc}.rst-content .admonition-todo .admonition-title,.rst-content .admonition-todo .wy-alert-title,.rst-content .attention .admonition-title,.rst-content .attention .wy-alert-title,.rst-content .caution .admonition-title,.rst-content .caution .wy-alert-title,.rst-content .warning .admonition-title,.rst-content .warning .wy-alert-title,.rst-content .wy-alert-warning.admonition .admonition-title,.rst-content .wy-alert-warning.admonition .wy-alert-title,.rst-content .wy-alert-warning.danger .admonition-title,.rst-content .wy-alert-warning.danger .wy-alert-title,.rst-content .wy-alert-warning.error .admonition-title,.rst-content .wy-alert-warning.error .wy-alert-title,.rst-content .wy-alert-warning.hint .admonition-title,.rst-content .wy-alert-warning.hint .wy-alert-title,.rst-content .wy-alert-warning.important .admonition-title,.rst-content .wy-alert-warning.important .wy-alert-title,.rst-content .wy-alert-warning.note .admonition-title,.rst-content .wy-alert-warning.note .wy-alert-title,.rst-content .wy-alert-warning.seealso .admonition-title,.rst-content .wy-alert-warning.seealso .wy-alert-title,.rst-content .wy-alert-warning.tip .admonition-title,.rst-content .wy-alert-warning.tip .wy-alert-title,.rst-content .wy-alert.wy-alert-warning .admonition-title,.wy-alert.wy-alert-warning .rst-content .admonition-title,.wy-alert.wy-alert-warning .wy-alert-title{background:#f0b37e}.rst-content .note,.rst-content .seealso,.rst-content .wy-alert-info.admonition,.rst-content .wy-alert-info.admonition-todo,.rst-content .wy-alert-info.attention,.rst-content .wy-alert-info.caution,.rst-content .wy-alert-info.danger,.rst-content .wy-alert-info.error,.rst-content .wy-alert-info.hint,.rst-content .wy-alert-info.important,.rst-content .wy-alert-info.tip,.rst-content .wy-alert-info.warning,.wy-alert.wy-alert-info{background:#e7f2fa}.rst-content .note .admonition-title,.rst-content .note .wy-alert-title,.rst-content .seealso .admonition-title,.rst-content .seealso .wy-alert-title,.rst-content .wy-alert-info.admonition-todo .admonition-title,.rst-content .wy-alert-info.admonition-todo .wy-alert-title,.rst-content .wy-alert-info.admonition .admonition-title,.rst-content .wy-alert-info.admonition .wy-alert-title,.rst-content .wy-alert-info.attention .admonition-title,.rst-content .wy-alert-info.attention .wy-alert-title,.rst-content .wy-alert-info.caution .admonition-title,.rst-content .wy-alert-info.caution .wy-alert-title,.rst-content .wy-alert-info.danger .admonition-title,.rst-content .wy-alert-info.danger .wy-alert-title,.rst-content .wy-alert-info.error .admonition-title,.rst-content .wy-alert-info.error .wy-alert-title,.rst-content .wy-alert-info.hint .admonition-title,.rst-content .wy-alert-info.hint .wy-alert-title,.rst-content .wy-alert-info.important .admonition-title,.rst-content .wy-alert-info.important .wy-alert-title,.rst-content .wy-alert-info.tip .admonition-title,.rst-content .wy-alert-info.tip .wy-alert-title,.rst-content .wy-alert-info.warning .admonition-title,.rst-content .wy-alert-info.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-info .admonition-title,.wy-alert.wy-alert-info .rst-content .admonition-title,.wy-alert.wy-alert-info .wy-alert-title{background:#6ab0de}.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .wy-alert-success.admonition,.rst-content .wy-alert-success.admonition-todo,.rst-content .wy-alert-success.attention,.rst-content .wy-alert-success.caution,.rst-content .wy-alert-success.danger,.rst-content .wy-alert-success.error,.rst-content .wy-alert-success.note,.rst-content .wy-alert-success.seealso,.rst-content .wy-alert-success.warning,.wy-alert.wy-alert-success{background:#dbfaf4}.rst-content .hint .admonition-title,.rst-content .hint .wy-alert-title,.rst-content .important .admonition-title,.rst-content .important .wy-alert-title,.rst-content .tip .admonition-title,.rst-content .tip .wy-alert-title,.rst-content .wy-alert-success.admonition-todo .admonition-title,.rst-content .wy-alert-success.admonition-todo .wy-alert-title,.rst-content .wy-alert-success.admonition .admonition-title,.rst-content .wy-alert-success.admonition .wy-alert-title,.rst-content .wy-alert-success.attention .admonition-title,.rst-content .wy-alert-success.attention .wy-alert-title,.rst-content .wy-alert-success.caution .admonition-title,.rst-content .wy-alert-success.caution .wy-alert-title,.rst-content .wy-alert-success.danger .admonition-title,.rst-content .wy-alert-success.danger .wy-alert-title,.rst-content .wy-alert-success.error .admonition-title,.rst-content .wy-alert-success.error .wy-alert-title,.rst-content .wy-alert-success.note .admonition-title,.rst-content .wy-alert-success.note .wy-alert-title,.rst-content .wy-alert-success.seealso .admonition-title,.rst-content .wy-alert-success.seealso .wy-alert-title,.rst-content .wy-alert-success.warning .admonition-title,.rst-content .wy-alert-success.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-success .admonition-title,.wy-alert.wy-alert-success .rst-content .admonition-title,.wy-alert.wy-alert-success .wy-alert-title{background:#1abc9c}.rst-content .wy-alert-neutral.admonition,.rst-content .wy-alert-neutral.admonition-todo,.rst-content .wy-alert-neutral.attention,.rst-content .wy-alert-neutral.caution,.rst-content .wy-alert-neutral.danger,.rst-content .wy-alert-neutral.error,.rst-content .wy-alert-neutral.hint,.rst-content .wy-alert-neutral.important,.rst-content .wy-alert-neutral.note,.rst-content .wy-alert-neutral.seealso,.rst-content .wy-alert-neutral.tip,.rst-content .wy-alert-neutral.warning,.wy-alert.wy-alert-neutral{background:#f3f6f6}.rst-content .wy-alert-neutral.admonition-todo .admonition-title,.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title,.rst-content .wy-alert-neutral.admonition .admonition-title,.rst-content .wy-alert-neutral.admonition .wy-alert-title,.rst-content .wy-alert-neutral.attention .admonition-title,.rst-content .wy-alert-neutral.attention .wy-alert-title,.rst-content .wy-alert-neutral.caution .admonition-title,.rst-content .wy-alert-neutral.caution .wy-alert-title,.rst-content .wy-alert-neutral.danger .admonition-title,.rst-content .wy-alert-neutral.danger .wy-alert-title,.rst-content .wy-alert-neutral.error .admonition-title,.rst-content .wy-alert-neutral.error .wy-alert-title,.rst-content .wy-alert-neutral.hint .admonition-title,.rst-content .wy-alert-neutral.hint .wy-alert-title,.rst-content .wy-alert-neutral.important .admonition-title,.rst-content .wy-alert-neutral.important .wy-alert-title,.rst-content .wy-alert-neutral.note .admonition-title,.rst-content .wy-alert-neutral.note .wy-alert-title,.rst-content .wy-alert-neutral.seealso .admonition-title,.rst-content .wy-alert-neutral.seealso .wy-alert-title,.rst-content .wy-alert-neutral.tip .admonition-title,.rst-content .wy-alert-neutral.tip .wy-alert-title,.rst-content .wy-alert-neutral.warning .admonition-title,.rst-content .wy-alert-neutral.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-neutral .admonition-title,.wy-alert.wy-alert-neutral .rst-content .admonition-title,.wy-alert.wy-alert-neutral .wy-alert-title{color:#404040;background:#e1e4e5}.rst-content .wy-alert-neutral.admonition-todo a,.rst-content .wy-alert-neutral.admonition a,.rst-content .wy-alert-neutral.attention a,.rst-content .wy-alert-neutral.caution a,.rst-content .wy-alert-neutral.danger a,.rst-content .wy-alert-neutral.error a,.rst-content .wy-alert-neutral.hint a,.rst-content .wy-alert-neutral.important a,.rst-content .wy-alert-neutral.note a,.rst-content .wy-alert-neutral.seealso a,.rst-content .wy-alert-neutral.tip a,.rst-content .wy-alert-neutral.warning a,.wy-alert.wy-alert-neutral a{color:#2980b9}.rst-content .admonition-todo p:last-child,.rst-content .admonition p:last-child,.rst-content .attention p:last-child,.rst-content .caution p:last-child,.rst-content .danger p:last-child,.rst-content .error p:last-child,.rst-content .hint p:last-child,.rst-content .important p:last-child,.rst-content .note p:last-child,.rst-content .seealso p:last-child,.rst-content .tip p:last-child,.rst-content .warning p:last-child,.wy-alert p:last-child{margin-bottom:0}.wy-tray-container{position:fixed;bottom:0;left:0;z-index:600}.wy-tray-container li{display:block;width:300px;background:transparent;color:#fff;text-align:center;box-shadow:0 5px 5px 0 rgba(0,0,0,.1);padding:0 24px;min-width:20%;opacity:0;height:0;line-height:56px;overflow:hidden;-webkit-transition:all .3s ease-in;-moz-transition:all .3s ease-in;transition:all .3s ease-in}.wy-tray-container li.wy-tray-item-success{background:#27ae60}.wy-tray-container li.wy-tray-item-info{background:#2980b9}.wy-tray-container li.wy-tray-item-warning{background:#e67e22}.wy-tray-container li.wy-tray-item-danger{background:#e74c3c}.wy-tray-container li.on{opacity:1;height:56px}@media screen and (max-width:768px){.wy-tray-container{bottom:auto;top:0;width:100%}.wy-tray-container li{width:100%}}button{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle;cursor:pointer;line-height:normal;-webkit-appearance:button;*overflow:visible}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}button[disabled]{cursor:default}.btn{display:inline-block;border-radius:2px;line-height:normal;white-space:nowrap;text-align:center;cursor:pointer;font-size:100%;padding:6px 12px 8px;color:#fff;border:1px solid rgba(0,0,0,.1);background-color:#27ae60;text-decoration:none;font-weight:400;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 2px -1px hsla(0,0%,100%,.5),inset 0 -2px 0 0 rgba(0,0,0,.1);outline-none:false;vertical-align:middle;*display:inline;zoom:1;-webkit-user-drag:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-transition:all .1s linear;-moz-transition:all .1s linear;transition:all .1s linear}.btn-hover{background:#2e8ece;color:#fff}.btn:hover{background:#2cc36b;color:#fff}.btn:focus{background:#2cc36b;outline:0}.btn:active{box-shadow:inset 0 -1px 0 0 rgba(0,0,0,.05),inset 0 2px 0 0 rgba(0,0,0,.1);padding:8px 12px 6px}.btn:visited{color:#fff}.btn-disabled,.btn-disabled:active,.btn-disabled:focus,.btn-disabled:hover,.btn:disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn::-moz-focus-inner{padding:0;border:0}.btn-small{font-size:80%}.btn-info{background-color:#2980b9!important}.btn-info:hover{background-color:#2e8ece!important}.btn-neutral{background-color:#f3f6f6!important;color:#404040!important}.btn-neutral:hover{background-color:#e5ebeb!important;color:#404040}.btn-neutral:visited{color:#404040!important}.btn-success{background-color:#27ae60!important}.btn-success:hover{background-color:#295!important}.btn-danger{background-color:#e74c3c!important}.btn-danger:hover{background-color:#ea6153!important}.btn-warning{background-color:#e67e22!important}.btn-warning:hover{background-color:#e98b39!important}.btn-invert{background-color:#222}.btn-invert:hover{background-color:#2f2f2f!important}.btn-link{background-color:transparent!important;color:#2980b9;box-shadow:none;border-color:transparent!important}.btn-link:active,.btn-link:hover{background-color:transparent!important;color:#409ad5!important;box-shadow:none}.btn-link:visited{color:#9b59b6}.wy-btn-group .btn,.wy-control .btn{vertical-align:middle}.wy-btn-group{margin-bottom:24px;*zoom:1}.wy-btn-group:after,.wy-btn-group:before{display:table;content:""}.wy-btn-group:after{clear:both}.wy-dropdown{position:relative;display:inline-block}.wy-dropdown-active .wy-dropdown-menu{display:block}.wy-dropdown-menu{position:absolute;left:0;display:none;float:left;top:100%;min-width:100%;background:#fcfcfc;z-index:100;border:1px solid #cfd7dd;box-shadow:0 2px 2px 0 rgba(0,0,0,.1);padding:12px}.wy-dropdown-menu>dd>a{display:block;clear:both;color:#404040;white-space:nowrap;font-size:90%;padding:0 12px;cursor:pointer}.wy-dropdown-menu>dd>a:hover{background:#2980b9;color:#fff}.wy-dropdown-menu>dd.divider{border-top:1px solid #cfd7dd;margin:6px 0}.wy-dropdown-menu>dd.search{padding-bottom:12px}.wy-dropdown-menu>dd.search input[type=search]{width:100%}.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3;text-transform:uppercase;font-weight:500;font-size:80%}.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3}.wy-dropdown-menu>dd.call-to-action .btn{color:#fff}.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%;top:auto;left:auto;right:0}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc;margin-top:2px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#2980b9;color:#fff}.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0;left:auto;text-align:right}.wy-dropdown-arrow:before{content:" ";border-bottom:5px solid #f5f5f5;border-left:5px solid transparent;border-right:5px solid transparent;position:absolute;display:block;top:-4px;left:50%;margin-left:-3px}.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px}.wy-form-stacked select{display:block}.wy-form-aligned .wy-help-inline,.wy-form-aligned input,.wy-form-aligned label,.wy-form-aligned select,.wy-form-aligned textarea{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-form-aligned .wy-control-group>label{display:inline-block;vertical-align:middle;width:10em;margin:6px 12px 0 0;float:left}.wy-form-aligned .wy-control{float:left}.wy-form-aligned .wy-control label{display:block}.wy-form-aligned .wy-control select{margin-top:6px}fieldset{margin:0}fieldset,legend{border:0;padding:0}legend{width:100%;white-space:normal;margin-bottom:24px;font-size:150%;*margin-left:-7px}label,legend{display:block}label{margin:0 0 .3125em;color:#333;font-size:90%}input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}.wy-control-group{margin-bottom:24px;max-width:1200px;margin-left:auto;margin-right:auto;*zoom:1}.wy-control-group:after,.wy-control-group:before{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group.wy-control-group-required>label:after{content:" *";color:#e74c3c}.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px}.wy-control-group .wy-form-full input[type=color],.wy-control-group .wy-form-full input[type=date],.wy-control-group .wy-form-full input[type=datetime-local],.wy-control-group .wy-form-full input[type=datetime],.wy-control-group .wy-form-full input[type=email],.wy-control-group .wy-form-full input[type=month],.wy-control-group .wy-form-full input[type=number],.wy-control-group .wy-form-full input[type=password],.wy-control-group .wy-form-full input[type=search],.wy-control-group .wy-form-full input[type=tel],.wy-control-group .wy-form-full input[type=text],.wy-control-group .wy-form-full input[type=time],.wy-control-group .wy-form-full input[type=url],.wy-control-group .wy-form-full input[type=week],.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves input[type=color],.wy-control-group .wy-form-halves input[type=date],.wy-control-group .wy-form-halves input[type=datetime-local],.wy-control-group .wy-form-halves input[type=datetime],.wy-control-group .wy-form-halves input[type=email],.wy-control-group .wy-form-halves input[type=month],.wy-control-group .wy-form-halves input[type=number],.wy-control-group .wy-form-halves input[type=password],.wy-control-group .wy-form-halves input[type=search],.wy-control-group .wy-form-halves input[type=tel],.wy-control-group .wy-form-halves input[type=text],.wy-control-group .wy-form-halves input[type=time],.wy-control-group .wy-form-halves input[type=url],.wy-control-group .wy-form-halves input[type=week],.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds input[type=color],.wy-control-group .wy-form-thirds input[type=date],.wy-control-group .wy-form-thirds input[type=datetime-local],.wy-control-group .wy-form-thirds input[type=datetime],.wy-control-group .wy-form-thirds input[type=email],.wy-control-group .wy-form-thirds input[type=month],.wy-control-group .wy-form-thirds input[type=number],.wy-control-group .wy-form-thirds input[type=password],.wy-control-group .wy-form-thirds input[type=search],.wy-control-group .wy-form-thirds input[type=tel],.wy-control-group .wy-form-thirds input[type=text],.wy-control-group .wy-form-thirds input[type=time],.wy-control-group .wy-form-thirds input[type=url],.wy-control-group .wy-form-thirds input[type=week],.wy-control-group .wy-form-thirds select{width:100%}.wy-control-group .wy-form-full{float:left;display:block;width:100%;margin-right:0}.wy-control-group .wy-form-full:last-child{margin-right:0}.wy-control-group .wy-form-halves{float:left;display:block;margin-right:2.35765%;width:48.82117%}.wy-control-group .wy-form-halves:last-child,.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(odd){clear:left}.wy-control-group .wy-form-thirds{float:left;display:block;margin-right:2.35765%;width:31.76157%}.wy-control-group .wy-form-thirds:last-child,.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left}.wy-control-group.wy-control-group-no-input .wy-control,.wy-control-no-input{margin:6px 0 0;font-size:90%}.wy-control-no-input{display:inline-block}.wy-control-group.fluid-input input[type=color],.wy-control-group.fluid-input input[type=date],.wy-control-group.fluid-input input[type=datetime-local],.wy-control-group.fluid-input input[type=datetime],.wy-control-group.fluid-input input[type=email],.wy-control-group.fluid-input input[type=month],.wy-control-group.fluid-input input[type=number],.wy-control-group.fluid-input input[type=password],.wy-control-group.fluid-input input[type=search],.wy-control-group.fluid-input input[type=tel],.wy-control-group.fluid-input input[type=text],.wy-control-group.fluid-input input[type=time],.wy-control-group.fluid-input input[type=url],.wy-control-group.fluid-input input[type=week]{width:100%}.wy-form-message-inline{padding-left:.3em;color:#666;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:.3125em;font-style:italic}.wy-form-message p{font-size:inherit;font-style:italic;margin-bottom:6px}.wy-form-message p:last-child{margin-bottom:0}input{line-height:normal}input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;*overflow:visible}input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week]{-webkit-appearance:none;padding:6px;display:inline-block;border:1px solid #ccc;font-size:80%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 3px #ddd;border-radius:0;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}input[type=datetime-local]{padding:.34375em .625em}input[disabled]{cursor:default}input[type=checkbox],input[type=radio]{padding:0;margin-right:.3125em;*height:13px;*width:13px}input[type=checkbox],input[type=radio],input[type=search]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type=search]::-webkit-search-cancel-button,input[type=search]::-webkit-search-decoration{-webkit-appearance:none}input[type=color]:focus,input[type=date]:focus,input[type=datetime-local]:focus,input[type=datetime]:focus,input[type=email]:focus,input[type=month]:focus,input[type=number]:focus,input[type=password]:focus,input[type=search]:focus,input[type=tel]:focus,input[type=text]:focus,input[type=time]:focus,input[type=url]:focus,input[type=week]:focus{outline:0;outline:thin dotted\9;border-color:#333}input.no-focus:focus{border-color:#ccc!important}input[type=checkbox]:focus,input[type=file]:focus,input[type=radio]:focus{outline:thin dotted #333;outline:1px auto #129fea}input[type=color][disabled],input[type=date][disabled],input[type=datetime-local][disabled],input[type=datetime][disabled],input[type=email][disabled],input[type=month][disabled],input[type=number][disabled],input[type=password][disabled],input[type=search][disabled],input[type=tel][disabled],input[type=text][disabled],input[type=time][disabled],input[type=url][disabled],input[type=week][disabled]{cursor:not-allowed;background-color:#fafafa}input:focus:invalid,select:focus:invalid,textarea:focus:invalid{color:#e74c3c;border:1px solid #e74c3c}input:focus:invalid:focus,select:focus:invalid:focus,textarea:focus:invalid:focus{border-color:#e74c3c}input[type=checkbox]:focus:invalid:focus,input[type=file]:focus:invalid:focus,input[type=radio]:focus:invalid:focus{outline-color:#e74c3c}input.wy-input-large{padding:12px;font-size:100%}textarea{overflow:auto;vertical-align:top;width:100%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif}select,textarea{padding:.5em .625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}select{border:1px solid #ccc;background-color:#fff}select[multiple]{height:auto}select:focus,textarea:focus{outline:0}input[readonly],select[disabled],select[readonly],textarea[disabled],textarea[readonly]{cursor:not-allowed;background-color:#fafafa}input[type=checkbox][disabled],input[type=radio][disabled]{cursor:not-allowed}.wy-checkbox,.wy-radio{margin:6px 0;color:#404040;display:block}.wy-checkbox input,.wy-radio input{vertical-align:baseline}.wy-form-message-inline{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-input-prefix,.wy-input-suffix{white-space:nowrap;padding:6px}.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px;padding:0 8px;display:inline-block;font-size:80%;background-color:#f3f6f6;border:1px solid #ccc;color:#999}.wy-input-suffix .wy-input-context{border-left:0}.wy-input-prefix .wy-input-context{border-right:0}.wy-switch{position:relative;display:block;height:24px;margin-top:12px;cursor:pointer}.wy-switch:before{left:0;top:0;width:36px;height:12px;background:#ccc}.wy-switch:after,.wy-switch:before{position:absolute;content:"";display:block;border-radius:4px;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch:after{width:18px;height:18px;background:#999;left:-3px;top:-3px}.wy-switch span{position:absolute;left:48px;display:block;font-size:12px;color:#ccc;line-height:1}.wy-switch.active:before{background:#1e8449}.wy-switch.active:after{left:24px;background:#27ae60}.wy-switch.disabled{cursor:not-allowed;opacity:.8}.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#e74c3c}.wy-control-group.wy-control-group-error input[type=color],.wy-control-group.wy-control-group-error input[type=date],.wy-control-group.wy-control-group-error input[type=datetime-local],.wy-control-group.wy-control-group-error input[type=datetime],.wy-control-group.wy-control-group-error input[type=email],.wy-control-group.wy-control-group-error input[type=month],.wy-control-group.wy-control-group-error input[type=number],.wy-control-group.wy-control-group-error input[type=password],.wy-control-group.wy-control-group-error input[type=search],.wy-control-group.wy-control-group-error input[type=tel],.wy-control-group.wy-control-group-error input[type=text],.wy-control-group.wy-control-group-error input[type=time],.wy-control-group.wy-control-group-error input[type=url],.wy-control-group.wy-control-group-error input[type=week],.wy-control-group.wy-control-group-error textarea{border:1px solid #e74c3c}.wy-inline-validate{white-space:nowrap}.wy-inline-validate .wy-input-context{padding:.5em .625em;display:inline-block;font-size:80%}.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27ae60}.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#e74c3c}.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#e67e22}.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#2980b9}.rotate-90{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.rotate-180{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.rotate-270{-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.mirror{-webkit-transform:scaleX(-1);-moz-transform:scaleX(-1);-ms-transform:scaleX(-1);-o-transform:scaleX(-1);transform:scaleX(-1)}.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg);-moz-transform:scaleX(-1) rotate(90deg);-ms-transform:scaleX(-1) rotate(90deg);-o-transform:scaleX(-1) rotate(90deg);transform:scaleX(-1) rotate(90deg)}.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg);-moz-transform:scaleX(-1) rotate(180deg);-ms-transform:scaleX(-1) rotate(180deg);-o-transform:scaleX(-1) rotate(180deg);transform:scaleX(-1) rotate(180deg)}.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg);-moz-transform:scaleX(-1) rotate(270deg);-ms-transform:scaleX(-1) rotate(270deg);-o-transform:scaleX(-1) rotate(270deg);transform:scaleX(-1) rotate(270deg)}@media only screen and (max-width:480px){.wy-form button[type=submit]{margin:.7em 0 0}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=text],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week],.wy-form label{margin-bottom:.3em;display:block}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week]{margin-bottom:0}.wy-form-aligned .wy-control-group label{margin-bottom:.3em;text-align:left;display:block;width:100%}.wy-form-aligned .wy-control{margin:1.5em 0 0}.wy-form-message,.wy-form-message-inline,.wy-form .wy-help-inline{display:block;font-size:80%;padding:6px 0}}@media screen and (max-width:768px){.tablet-hide{display:none}}@media screen and (max-width:480px){.mobile-hide{display:none}}.float-left{float:left}.float-right{float:right}.full-width{width:100%}.rst-content table.docutils,.rst-content table.field-list,.wy-table{border-collapse:collapse;border-spacing:0;empty-cells:show;margin-bottom:24px}.rst-content table.docutils caption,.rst-content table.field-list caption,.wy-table caption{color:#000;font:italic 85%/1 arial,sans-serif;padding:1em 0;text-align:center}.rst-content table.docutils td,.rst-content table.docutils th,.rst-content table.field-list td,.rst-content table.field-list th,.wy-table td,.wy-table th{font-size:90%;margin:0;overflow:visible;padding:8px 16px}.rst-content table.docutils td:first-child,.rst-content table.docutils th:first-child,.rst-content table.field-list td:first-child,.rst-content table.field-list th:first-child,.wy-table td:first-child,.wy-table th:first-child{border-left-width:0}.rst-content table.docutils thead,.rst-content table.field-list thead,.wy-table thead{color:#000;text-align:left;vertical-align:bottom;white-space:nowrap}.rst-content table.docutils thead th,.rst-content table.field-list thead th,.wy-table thead th{font-weight:700;border-bottom:2px solid #e1e4e5}.rst-content table.docutils td,.rst-content table.field-list td,.wy-table td{background-color:transparent;vertical-align:middle}.rst-content table.docutils td p,.rst-content table.field-list td p,.wy-table td p{line-height:18px}.rst-content table.docutils td p:last-child,.rst-content table.field-list td p:last-child,.wy-table td p:last-child{margin-bottom:0}.rst-content table.docutils .wy-table-cell-min,.rst-content table.field-list .wy-table-cell-min,.wy-table .wy-table-cell-min{width:1%;padding-right:0}.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox]{margin:0}.wy-table-secondary{color:grey;font-size:90%}.wy-table-tertiary{color:grey;font-size:80%}.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td,.wy-table-backed,.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td{background-color:#f3f6f6}.rst-content table.docutils,.wy-table-bordered-all{border:1px solid #e1e4e5}.rst-content table.docutils td,.wy-table-bordered-all td{border-bottom:1px solid #e1e4e5;border-left:1px solid #e1e4e5}.rst-content table.docutils tbody>tr:last-child td,.wy-table-bordered-all tbody>tr:last-child td{border-bottom-width:0}.wy-table-bordered{border:1px solid #e1e4e5}.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5}.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px;border-bottom:1px solid #e1e4e5}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-responsive{margin-bottom:24px;max-width:100%;overflow:auto}.wy-table-responsive table{margin-bottom:0!important}.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap}a{color:#2980b9;text-decoration:none;cursor:pointer}a:hover{color:#3091d1}a:visited{color:#9b59b6}html{height:100%}body,html{overflow-x:hidden}body{font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;font-weight:400;color:#404040;min-height:100%;background:#edf0f2}.wy-text-left{text-align:left}.wy-text-center{text-align:center}.wy-text-right{text-align:right}.wy-text-large{font-size:120%}.wy-text-normal{font-size:100%}.wy-text-small,small{font-size:80%}.wy-text-strike{text-decoration:line-through}.wy-text-warning{color:#e67e22!important}a.wy-text-warning:hover{color:#eb9950!important}.wy-text-info{color:#2980b9!important}a.wy-text-info:hover{color:#409ad5!important}.wy-text-success{color:#27ae60!important}a.wy-text-success:hover{color:#36d278!important}.wy-text-danger{color:#e74c3c!important}a.wy-text-danger:hover{color:#ed7669!important}.wy-text-neutral{color:#404040!important}a.wy-text-neutral:hover{color:#595959!important}.rst-content .toctree-wrapper>p.caption,h1,h2,h3,h4,h5,h6,legend{margin-top:0;font-weight:700;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif}p{line-height:24px;font-size:16px;margin:0 0 24px}h1{font-size:175%}.rst-content .toctree-wrapper>p.caption,h2{font-size:150%}h3{font-size:125%}h4{font-size:115%}h5{font-size:110%}h6{font-size:100%}hr{display:block;height:1px;border:0;border-top:1px solid #e1e4e5;margin:24px 0;padding:0}.rst-content code,.rst-content tt,code{white-space:nowrap;max-width:100%;background:#fff;border:1px solid #e1e4e5;font-size:75%;padding:0 5px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#e74c3c;overflow-x:auto}.rst-content tt.code-large,code.code-large{font-size:90%}.rst-content .section ul,.rst-content .toctree-wrapper ul,.rst-content section ul,.wy-plain-list-disc,article ul{list-style:disc;line-height:24px;margin-bottom:24px}.rst-content .section ul li,.rst-content .toctree-wrapper ul li,.rst-content section ul li,.wy-plain-list-disc li,article ul li{list-style:disc;margin-left:24px}.rst-content .section ul li p:last-child,.rst-content .section ul li ul,.rst-content .toctree-wrapper ul li p:last-child,.rst-content .toctree-wrapper ul li ul,.rst-content section ul li p:last-child,.rst-content section ul li ul,.wy-plain-list-disc li p:last-child,.wy-plain-list-disc li ul,article ul li p:last-child,article ul li ul{margin-bottom:0}.rst-content .section ul li li,.rst-content .toctree-wrapper ul li li,.rst-content section ul li li,.wy-plain-list-disc li li,article ul li li{list-style:circle}.rst-content .section ul li li li,.rst-content .toctree-wrapper ul li li li,.rst-content section ul li li li,.wy-plain-list-disc li li li,article ul li li li{list-style:square}.rst-content .section ul li ol li,.rst-content .toctree-wrapper ul li ol li,.rst-content section ul li ol li,.wy-plain-list-disc li ol li,article ul li ol li{list-style:decimal}.rst-content .section ol,.rst-content .section ol.arabic,.rst-content .toctree-wrapper ol,.rst-content .toctree-wrapper ol.arabic,.rst-content section ol,.rst-content section ol.arabic,.wy-plain-list-decimal,article ol{list-style:decimal;line-height:24px;margin-bottom:24px}.rst-content .section ol.arabic li,.rst-content .section ol li,.rst-content .toctree-wrapper ol.arabic li,.rst-content .toctree-wrapper ol li,.rst-content section ol.arabic li,.rst-content section ol li,.wy-plain-list-decimal li,article ol li{list-style:decimal;margin-left:24px}.rst-content .section ol.arabic li ul,.rst-content .section ol li p:last-child,.rst-content .section ol li ul,.rst-content .toctree-wrapper ol.arabic li ul,.rst-content .toctree-wrapper ol li p:last-child,.rst-content .toctree-wrapper ol li ul,.rst-content section ol.arabic li ul,.rst-content section ol li p:last-child,.rst-content section ol li ul,.wy-plain-list-decimal li p:last-child,.wy-plain-list-decimal li ul,article ol li p:last-child,article ol li ul{margin-bottom:0}.rst-content .section ol.arabic li ul li,.rst-content .section ol li ul li,.rst-content .toctree-wrapper ol.arabic li ul li,.rst-content .toctree-wrapper ol li ul li,.rst-content section ol.arabic li ul li,.rst-content section ol li ul li,.wy-plain-list-decimal li ul li,article ol li ul li{list-style:disc}.wy-breadcrumbs{*zoom:1}.wy-breadcrumbs:after,.wy-breadcrumbs:before{display:table;content:""}.wy-breadcrumbs:after{clear:both}.wy-breadcrumbs>li{display:inline-block;padding-top:5px}.wy-breadcrumbs>li.wy-breadcrumbs-aside{float:right}.rst-content .wy-breadcrumbs>li code,.rst-content .wy-breadcrumbs>li tt,.wy-breadcrumbs>li .rst-content tt,.wy-breadcrumbs>li code{all:inherit;color:inherit}.breadcrumb-item:before{content:"/";color:#bbb;font-size:13px;padding:0 6px 0 3px}.wy-breadcrumbs-extra{margin-bottom:0;color:#b3b3b3;font-size:80%;display:inline-block}@media screen and (max-width:480px){.wy-breadcrumbs-extra,.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}@media print{.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}html{font-size:16px}.wy-affix{position:fixed;top:1.618em}.wy-menu a:hover{text-decoration:none}.wy-menu-horiz{*zoom:1}.wy-menu-horiz:after,.wy-menu-horiz:before{display:table;content:""}.wy-menu-horiz:after{clear:both}.wy-menu-horiz li,.wy-menu-horiz ul{display:inline-block}.wy-menu-horiz li:hover{background:hsla(0,0%,100%,.1)}.wy-menu-horiz li.divide-left{border-left:1px solid #404040}.wy-menu-horiz li.divide-right{border-right:1px solid #404040}.wy-menu-horiz a{height:32px;display:inline-block;line-height:32px;padding:0 16px}.wy-menu-vertical{width:300px}.wy-menu-vertical header,.wy-menu-vertical p.caption{color:#55a5d9;height:32px;line-height:32px;padding:0 1.618em;margin:12px 0 0;display:block;font-weight:700;text-transform:uppercase;font-size:85%;white-space:nowrap}.wy-menu-vertical ul{margin-bottom:0}.wy-menu-vertical li.divide-top{border-top:1px solid #404040}.wy-menu-vertical li.divide-bottom{border-bottom:1px solid #404040}.wy-menu-vertical li.current{background:#e3e3e3}.wy-menu-vertical li.current a{color:grey;border-right:1px solid #c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.current a:hover{background:#d6d6d6}.rst-content .wy-menu-vertical li tt,.wy-menu-vertical li .rst-content tt,.wy-menu-vertical li code{border:none;background:inherit;color:inherit;padding-left:0;padding-right:0}.wy-menu-vertical li button.toctree-expand{display:block;float:left;margin-left:-1.2em;line-height:18px;color:#4d4d4d;border:none;background:none;padding:0}.wy-menu-vertical li.current>a,.wy-menu-vertical li.on a{color:#404040;font-weight:700;position:relative;background:#fcfcfc;border:none;padding:.4045em 1.618em}.wy-menu-vertical li.current>a:hover,.wy-menu-vertical li.on a:hover{background:#fcfcfc}.wy-menu-vertical li.current>a:hover button.toctree-expand,.wy-menu-vertical li.on a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand{display:block;line-height:18px;color:#333}.wy-menu-vertical li.toctree-l1.current>a{border-bottom:1px solid #c9c9c9;border-top:1px solid #c9c9c9}.wy-menu-vertical .toctree-l1.current .toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .toctree-l11>ul{display:none}.wy-menu-vertical .toctree-l1.current .current.toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .current.toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .current.toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .current.toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .current.toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .current.toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .current.toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .current.toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .current.toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .current.toctree-l11>ul{display:block}.wy-menu-vertical li.toctree-l3,.wy-menu-vertical li.toctree-l4{font-size:.9em}.wy-menu-vertical li.toctree-l2 a,.wy-menu-vertical li.toctree-l3 a,.wy-menu-vertical li.toctree-l4 a,.wy-menu-vertical li.toctree-l5 a,.wy-menu-vertical li.toctree-l6 a,.wy-menu-vertical li.toctree-l7 a,.wy-menu-vertical li.toctree-l8 a,.wy-menu-vertical li.toctree-l9 a,.wy-menu-vertical li.toctree-l10 a{color:#404040}.wy-menu-vertical li.toctree-l2 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l3 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l4 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l5 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l6 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l7 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l8 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l9 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l10 a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a,.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a,.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a,.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a,.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a,.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a,.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a,.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{display:block}.wy-menu-vertical li.toctree-l2.current>a{padding:.4045em 2.427em}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{padding:.4045em 1.618em .4045em 4.045em}.wy-menu-vertical li.toctree-l3.current>a{padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{padding:.4045em 1.618em .4045em 5.663em}.wy-menu-vertical li.toctree-l4.current>a{padding:.4045em 5.663em}.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a{padding:.4045em 1.618em .4045em 7.281em}.wy-menu-vertical li.toctree-l5.current>a{padding:.4045em 7.281em}.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a{padding:.4045em 1.618em .4045em 8.899em}.wy-menu-vertical li.toctree-l6.current>a{padding:.4045em 8.899em}.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a{padding:.4045em 1.618em .4045em 10.517em}.wy-menu-vertical li.toctree-l7.current>a{padding:.4045em 10.517em}.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a{padding:.4045em 1.618em .4045em 12.135em}.wy-menu-vertical li.toctree-l8.current>a{padding:.4045em 12.135em}.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a{padding:.4045em 1.618em .4045em 13.753em}.wy-menu-vertical li.toctree-l9.current>a{padding:.4045em 13.753em}.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a{padding:.4045em 1.618em .4045em 15.371em}.wy-menu-vertical li.toctree-l10.current>a{padding:.4045em 15.371em}.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{padding:.4045em 1.618em .4045em 16.989em}.wy-menu-vertical li.toctree-l2.current>a,.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{background:#c9c9c9}.wy-menu-vertical li.toctree-l2 button.toctree-expand{color:#a3a3a3}.wy-menu-vertical li.toctree-l3.current>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{background:#bdbdbd}.wy-menu-vertical li.toctree-l3 button.toctree-expand{color:#969696}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical li ul li a{margin-bottom:0;color:#d9d9d9;font-weight:400}.wy-menu-vertical a{line-height:18px;padding:.4045em 1.618em;display:block;position:relative;font-size:90%;color:#d9d9d9}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:hover button.toctree-expand{color:#d9d9d9}.wy-menu-vertical a:active{background-color:#2980b9;cursor:pointer;color:#fff}.wy-menu-vertical a:active button.toctree-expand{color:#fff}.wy-side-nav-search{display:block;width:300px;padding:.809em;margin-bottom:.809em;z-index:200;background-color:#2980b9;text-align:center;color:#fcfcfc}.wy-side-nav-search input[type=text]{width:100%;border-radius:50px;padding:6px 12px;border-color:#2472a4}.wy-side-nav-search img{display:block;margin:auto auto .809em;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-side-nav-search .wy-dropdown>a,.wy-side-nav-search>a{color:#fcfcfc;font-size:100%;font-weight:700;display:inline-block;padding:4px 6px;margin-bottom:.809em;max-width:100%}.wy-side-nav-search .wy-dropdown>a:hover,.wy-side-nav-search .wy-dropdown>aactive,.wy-side-nav-search .wy-dropdown>afocus,.wy-side-nav-search>a:hover,.wy-side-nav-search>aactive,.wy-side-nav-search>afocus{background:hsla(0,0%,100%,.1)}.wy-side-nav-search .wy-dropdown>a img.logo,.wy-side-nav-search>a img.logo{display:block;margin:0 auto;height:auto;width:auto;border-radius:0;max-width:100%;background:transparent}.wy-side-nav-search .wy-dropdown>a.icon,.wy-side-nav-search>a.icon{display:block}.wy-side-nav-search .wy-dropdown>a.icon img.logo,.wy-side-nav-search>a.icon img.logo{margin-top:.85em}.wy-side-nav-search>div.switch-menus{position:relative;display:block;margin-top:-.4045em;margin-bottom:.809em;font-weight:400;color:hsla(0,0%,100%,.3)}.wy-side-nav-search>div.switch-menus>div.language-switch,.wy-side-nav-search>div.switch-menus>div.version-switch{display:inline-block;padding:.2em}.wy-side-nav-search>div.switch-menus>div.language-switch select,.wy-side-nav-search>div.switch-menus>div.version-switch select{display:inline-block;margin-right:-2rem;padding-right:2rem;max-width:240px;text-align-last:center;background:none;border:none;border-radius:0;box-shadow:none;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;font-size:1em;font-weight:400;color:hsla(0,0%,100%,.3);cursor:pointer;appearance:none;-webkit-appearance:none;-moz-appearance:none}.wy-side-nav-search>div.switch-menus>div.language-switch select:active,.wy-side-nav-search>div.switch-menus>div.language-switch select:focus,.wy-side-nav-search>div.switch-menus>div.language-switch select:hover,.wy-side-nav-search>div.switch-menus>div.version-switch select:active,.wy-side-nav-search>div.switch-menus>div.version-switch select:focus,.wy-side-nav-search>div.switch-menus>div.version-switch select:hover{background:hsla(0,0%,100%,.1);color:hsla(0,0%,100%,.5)}.wy-side-nav-search>div.switch-menus>div.language-switch select option,.wy-side-nav-search>div.switch-menus>div.version-switch select option{color:#000}.wy-side-nav-search>div.switch-menus>div.language-switch:has(>select):after,.wy-side-nav-search>div.switch-menus>div.version-switch:has(>select):after{display:inline-block;width:1.5em;height:100%;padding:.1em;content:"\f0d7";font-size:1em;line-height:1.2em;font-family:FontAwesome;text-align:center;pointer-events:none;box-sizing:border-box}.wy-nav .wy-menu-vertical header{color:#2980b9}.wy-nav .wy-menu-vertical a{color:#b3b3b3}.wy-nav .wy-menu-vertical a:hover{background-color:#2980b9;color:#fff}[data-menu-wrap]{-webkit-transition:all .2s ease-in;-moz-transition:all .2s ease-in;transition:all .2s ease-in;position:absolute;opacity:1;width:100%;opacity:0}[data-menu-wrap].move-center{left:0;right:auto;opacity:1}[data-menu-wrap].move-left{right:auto;left:-100%;opacity:0}[data-menu-wrap].move-right{right:-100%;left:auto;opacity:0}.wy-body-for-nav{background:#fcfcfc}.wy-grid-for-nav{position:absolute;width:100%;height:100%}.wy-nav-side{position:fixed;top:0;bottom:0;left:0;padding-bottom:2em;width:300px;overflow-x:hidden;overflow-y:hidden;min-height:100%;color:#9b9b9b;background:#343131;z-index:200}.wy-side-scroll{width:320px;position:relative;overflow-x:hidden;overflow-y:scroll;height:100%}.wy-nav-top{display:none;background:#2980b9;color:#fff;padding:.4045em .809em;position:relative;line-height:50px;text-align:center;font-size:100%;*zoom:1}.wy-nav-top:after,.wy-nav-top:before{display:table;content:""}.wy-nav-top:after{clear:both}.wy-nav-top a{color:#fff;font-weight:700}.wy-nav-top img{margin-right:12px;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-nav-top i{font-size:30px;float:left;cursor:pointer;padding-top:inherit}.wy-nav-content-wrap{margin-left:300px;background:#fcfcfc;min-height:100%}.wy-nav-content{padding:1.618em 3.236em;height:100%;max-width:800px;margin:auto}.wy-body-mask{position:fixed;width:100%;height:100%;background:rgba(0,0,0,.2);display:none;z-index:499}.wy-body-mask.on{display:block}footer{color:grey}footer p{margin-bottom:12px}.rst-content footer span.commit tt,footer span.commit .rst-content tt,footer span.commit code{padding:0;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:1em;background:none;border:none;color:grey}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:after,.rst-footer-buttons:before{width:100%;display:table;content:""}.rst-footer-buttons:after{clear:both}.rst-breadcrumbs-buttons{margin-top:12px;*zoom:1}.rst-breadcrumbs-buttons:after,.rst-breadcrumbs-buttons:before{display:table;content:""}.rst-breadcrumbs-buttons:after{clear:both}#search-results .search li{margin-bottom:24px;border-bottom:1px solid #e1e4e5;padding-bottom:24px}#search-results .search li:first-child{border-top:1px solid #e1e4e5;padding-top:24px}#search-results .search li a{font-size:120%;margin-bottom:12px;display:inline-block}#search-results .context{color:grey;font-size:90%}.genindextable li>ul{margin-left:24px}@media screen and (max-width:768px){.wy-body-for-nav{background:#fcfcfc}.wy-nav-top{display:block}.wy-nav-side{left:-300px}.wy-nav-side.shift{width:85%;left:0}.wy-menu.wy-menu-vertical,.wy-side-nav-search,.wy-side-scroll{width:auto}.wy-nav-content-wrap{margin-left:0}.wy-nav-content-wrap .wy-nav-content{padding:1.618em}.wy-nav-content-wrap.shift{position:fixed;min-width:100%;left:85%;top:0;height:100%;overflow:hidden}}@media screen and (min-width:1100px){.wy-nav-content-wrap{background:rgba(0,0,0,.05)}.wy-nav-content{margin:0;background:#fcfcfc}}@media print{.rst-versions,.wy-nav-side,footer{display:none}.wy-nav-content-wrap{margin-left:0}}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60;*zoom:1}.rst-versions .rst-current-version:after,.rst-versions .rst-current-version:before{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-content .code-block-caption .rst-versions .rst-current-version .headerlink,.rst-content .eqno .rst-versions .rst-current-version .headerlink,.rst-content .rst-versions .rst-current-version .admonition-title,.rst-content code.download .rst-versions .rst-current-version span:first-child,.rst-content dl dt .rst-versions .rst-current-version .headerlink,.rst-content h1 .rst-versions .rst-current-version .headerlink,.rst-content h2 .rst-versions .rst-current-version .headerlink,.rst-content h3 .rst-versions .rst-current-version .headerlink,.rst-content h4 .rst-versions .rst-current-version .headerlink,.rst-content h5 .rst-versions .rst-current-version .headerlink,.rst-content h6 .rst-versions .rst-current-version .headerlink,.rst-content p .rst-versions .rst-current-version .headerlink,.rst-content table>caption .rst-versions .rst-current-version .headerlink,.rst-content tt.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .fa,.rst-versions .rst-current-version .icon,.rst-versions .rst-current-version .rst-content .admonition-title,.rst-versions .rst-current-version .rst-content .code-block-caption .headerlink,.rst-versions .rst-current-version .rst-content .eqno .headerlink,.rst-versions .rst-current-version .rst-content code.download span:first-child,.rst-versions .rst-current-version .rst-content dl dt .headerlink,.rst-versions .rst-current-version .rst-content h1 .headerlink,.rst-versions .rst-current-version .rst-content h2 .headerlink,.rst-versions .rst-current-version .rst-content h3 .headerlink,.rst-versions .rst-current-version .rst-content h4 .headerlink,.rst-versions .rst-current-version .rst-content h5 .headerlink,.rst-versions .rst-current-version .rst-content h6 .headerlink,.rst-versions .rst-current-version .rst-content p .headerlink,.rst-versions .rst-current-version .rst-content table>caption .headerlink,.rst-versions .rst-current-version .rst-content tt.download span:first-child,.rst-versions .rst-current-version .wy-menu-vertical li button.toctree-expand,.wy-menu-vertical li .rst-versions .rst-current-version button.toctree-expand{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions .rst-other-versions .rtd-current-item{font-weight:700}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}#flyout-search-form{padding:6px}.rst-content .toctree-wrapper>p.caption,.rst-content h1,.rst-content h2,.rst-content h3,.rst-content h4,.rst-content h5,.rst-content h6{margin-bottom:24px}.rst-content img{max-width:100%;height:auto}.rst-content div.figure,.rst-content figure{margin-bottom:24px}.rst-content div.figure .caption-text,.rst-content figure .caption-text{font-style:italic}.rst-content div.figure p:last-child.caption,.rst-content figure p:last-child.caption{margin-bottom:0}.rst-content div.figure.align-center,.rst-content figure.align-center{text-align:center}.rst-content .section>a>img,.rst-content .section>img,.rst-content section>a>img,.rst-content section>img{margin-bottom:24px}.rst-content abbr[title]{text-decoration:none}.rst-content.style-external-links a.reference.external:after{font-family:FontAwesome;content:"\f08e";color:#b3b3b3;vertical-align:super;font-size:60%;margin:0 .2em}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content pre.literal-block{white-space:pre;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;display:block;overflow:auto}.rst-content div[class^=highlight],.rst-content pre.literal-block{border:1px solid #e1e4e5;overflow-x:auto;margin:1px 0 24px}.rst-content div[class^=highlight] div[class^=highlight],.rst-content pre.literal-block div[class^=highlight]{padding:0;border:none;margin:0}.rst-content div[class^=highlight] td.code{width:100%}.rst-content .linenodiv pre{border-right:1px solid #e6e9ea;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;user-select:none;pointer-events:none}.rst-content div[class^=highlight] pre{white-space:pre;margin:0;padding:12px;display:block;overflow:auto}.rst-content div[class^=highlight] pre .hll{display:block;margin:0 -12px;padding:0 12px}.rst-content .linenodiv pre,.rst-content div[class^=highlight] pre,.rst-content pre.literal-block{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:12px;line-height:1.4}.rst-content div.highlight .gp,.rst-content div.highlight span.linenos{user-select:none;pointer-events:none}.rst-content div.highlight span.linenos{display:inline-block;padding-left:0;padding-right:12px;margin-right:12px;border-right:1px solid #e6e9ea}.rst-content .code-block-caption{font-style:italic;font-size:85%;line-height:1;padding:1em 0;text-align:center}@media print{.rst-content .codeblock,.rst-content div[class^=highlight],.rst-content div[class^=highlight] pre{white-space:pre-wrap}}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning{clear:both}.rst-content .admonition-todo .last,.rst-content .admonition-todo>:last-child,.rst-content .admonition .last,.rst-content .admonition>:last-child,.rst-content .attention .last,.rst-content .attention>:last-child,.rst-content .caution .last,.rst-content .caution>:last-child,.rst-content .danger .last,.rst-content .danger>:last-child,.rst-content .error .last,.rst-content .error>:last-child,.rst-content .hint .last,.rst-content .hint>:last-child,.rst-content .important .last,.rst-content .important>:last-child,.rst-content .note .last,.rst-content .note>:last-child,.rst-content .seealso .last,.rst-content .seealso>:last-child,.rst-content .tip .last,.rst-content .tip>:last-child,.rst-content .warning .last,.rst-content .warning>:last-child{margin-bottom:0}.rst-content .admonition-title:before{margin-right:4px}.rst-content .admonition table{border-color:rgba(0,0,0,.1)}.rst-content .admonition table td,.rst-content .admonition table th{background:transparent!important;border-color:rgba(0,0,0,.1)!important}.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha>li,.rst-content .toctree-wrapper ol.loweralpha,.rst-content .toctree-wrapper ol.loweralpha>li,.rst-content section ol.loweralpha,.rst-content section ol.loweralpha>li{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha>li,.rst-content .toctree-wrapper ol.upperalpha,.rst-content .toctree-wrapper ol.upperalpha>li,.rst-content section ol.upperalpha,.rst-content section ol.upperalpha>li{list-style:upper-alpha}.rst-content .section ol li>*,.rst-content .section ul li>*,.rst-content .toctree-wrapper ol li>*,.rst-content .toctree-wrapper ul li>*,.rst-content section ol li>*,.rst-content section ul li>*{margin-top:12px;margin-bottom:12px}.rst-content .section ol li>:first-child,.rst-content .section ul li>:first-child,.rst-content .toctree-wrapper ol li>:first-child,.rst-content .toctree-wrapper ul li>:first-child,.rst-content section ol li>:first-child,.rst-content section ul li>:first-child{margin-top:0}.rst-content .section ol li>p,.rst-content .section ol li>p:last-child,.rst-content .section ul li>p,.rst-content .section ul li>p:last-child,.rst-content .toctree-wrapper ol li>p,.rst-content .toctree-wrapper ol li>p:last-child,.rst-content .toctree-wrapper ul li>p,.rst-content .toctree-wrapper ul li>p:last-child,.rst-content section ol li>p,.rst-content section ol li>p:last-child,.rst-content section ul li>p,.rst-content section ul li>p:last-child{margin-bottom:12px}.rst-content .section ol li>p:only-child,.rst-content .section ol li>p:only-child:last-child,.rst-content .section ul li>p:only-child,.rst-content .section ul li>p:only-child:last-child,.rst-content .toctree-wrapper ol li>p:only-child,.rst-content .toctree-wrapper ol li>p:only-child:last-child,.rst-content .toctree-wrapper ul li>p:only-child,.rst-content .toctree-wrapper ul li>p:only-child:last-child,.rst-content section ol li>p:only-child,.rst-content section ol li>p:only-child:last-child,.rst-content section ul li>p:only-child,.rst-content section ul li>p:only-child:last-child{margin-bottom:0}.rst-content .section ol li>ol,.rst-content .section ol li>ul,.rst-content .section ul li>ol,.rst-content .section ul li>ul,.rst-content .toctree-wrapper ol li>ol,.rst-content .toctree-wrapper ol li>ul,.rst-content .toctree-wrapper ul li>ol,.rst-content .toctree-wrapper ul li>ul,.rst-content section ol li>ol,.rst-content section ol li>ul,.rst-content section ul li>ol,.rst-content section ul li>ul{margin-bottom:12px}.rst-content .section ol.simple li>*,.rst-content .section ol.simple li ol,.rst-content .section ol.simple li ul,.rst-content .section ul.simple li>*,.rst-content .section ul.simple li ol,.rst-content .section ul.simple li ul,.rst-content .toctree-wrapper ol.simple li>*,.rst-content .toctree-wrapper ol.simple li ol,.rst-content .toctree-wrapper ol.simple li ul,.rst-content .toctree-wrapper ul.simple li>*,.rst-content .toctree-wrapper ul.simple li ol,.rst-content .toctree-wrapper ul.simple li ul,.rst-content section ol.simple li>*,.rst-content section ol.simple li ol,.rst-content section ol.simple li ul,.rst-content section ul.simple li>*,.rst-content section ul.simple li ol,.rst-content section ul.simple li ul{margin-top:0;margin-bottom:0}.rst-content .line-block{margin-left:0;margin-bottom:24px;line-height:24px}.rst-content .line-block .line-block{margin-left:24px;margin-bottom:0}.rst-content .topic-title{font-weight:700;margin-bottom:12px}.rst-content .toc-backref{color:#404040}.rst-content .align-right{float:right;margin:0 0 24px 24px}.rst-content .align-left{float:left;margin:0 24px 24px 0}.rst-content .align-center{margin:auto}.rst-content .align-center:not(table){display:block}.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink{opacity:0;font-size:14px;font-family:FontAwesome;margin-left:.5em}.rst-content .code-block-caption .headerlink:focus,.rst-content .code-block-caption:hover .headerlink,.rst-content .eqno .headerlink:focus,.rst-content .eqno:hover .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink:focus,.rst-content .toctree-wrapper>p.caption:hover .headerlink,.rst-content dl dt .headerlink:focus,.rst-content dl dt:hover .headerlink,.rst-content h1 .headerlink:focus,.rst-content h1:hover .headerlink,.rst-content h2 .headerlink:focus,.rst-content h2:hover .headerlink,.rst-content h3 .headerlink:focus,.rst-content h3:hover .headerlink,.rst-content h4 .headerlink:focus,.rst-content h4:hover .headerlink,.rst-content h5 .headerlink:focus,.rst-content h5:hover .headerlink,.rst-content h6 .headerlink:focus,.rst-content h6:hover .headerlink,.rst-content p.caption .headerlink:focus,.rst-content p.caption:hover .headerlink,.rst-content p .headerlink:focus,.rst-content p:hover .headerlink,.rst-content table>caption .headerlink:focus,.rst-content table>caption:hover .headerlink{opacity:1}.rst-content p a{overflow-wrap:anywhere}.rst-content .wy-table td p,.rst-content .wy-table td ul,.rst-content .wy-table th p,.rst-content .wy-table th ul,.rst-content table.docutils td p,.rst-content table.docutils td ul,.rst-content table.docutils th p,.rst-content table.docutils th ul,.rst-content table.field-list td p,.rst-content table.field-list td ul,.rst-content table.field-list th p,.rst-content table.field-list th ul{font-size:inherit}.rst-content .btn:focus{outline:2px solid}.rst-content table>caption .headerlink:after{font-size:12px}.rst-content .centered{text-align:center}.rst-content .sidebar{float:right;width:40%;display:block;margin:0 0 24px 24px;padding:24px;background:#f3f6f6;border:1px solid #e1e4e5}.rst-content .sidebar dl,.rst-content .sidebar p,.rst-content .sidebar ul{font-size:90%}.rst-content .sidebar .last,.rst-content .sidebar>:last-child{margin-bottom:0}.rst-content .sidebar .sidebar-title{display:block;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif;font-weight:700;background:#e1e4e5;padding:6px 12px;margin:-24px -24px 24px;font-size:100%}.rst-content .highlighted{background:#f1c40f;box-shadow:0 0 0 2px #f1c40f;display:inline;font-weight:700}.rst-content .citation-reference,.rst-content .footnote-reference{vertical-align:baseline;position:relative;top:-.4em;line-height:0;font-size:90%}.rst-content .citation-reference>span.fn-bracket,.rst-content .footnote-reference>span.fn-bracket{display:none}.rst-content .hlist{width:100%}.rst-content dl dt span.classifier:before{content:" : "}.rst-content dl dt span.classifier-delimiter{display:none!important}html.writer-html4 .rst-content table.docutils.citation,html.writer-html4 .rst-content table.docutils.footnote{background:none;border:none}html.writer-html4 .rst-content table.docutils.citation td,html.writer-html4 .rst-content table.docutils.citation tr,html.writer-html4 .rst-content table.docutils.footnote td,html.writer-html4 .rst-content table.docutils.footnote tr{border:none;background-color:transparent!important;white-space:normal}html.writer-html4 .rst-content table.docutils.citation td.label,html.writer-html4 .rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{display:grid;grid-template-columns:auto minmax(80%,95%)}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{display:inline-grid;grid-template-columns:max-content auto}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{display:grid;grid-template-columns:auto auto minmax(.65rem,auto) minmax(40%,95%)}html.writer-html5 .rst-content aside.citation>span.label,html.writer-html5 .rst-content aside.footnote>span.label,html.writer-html5 .rst-content div.citation>span.label{grid-column-start:1;grid-column-end:2}html.writer-html5 .rst-content aside.citation>span.backrefs,html.writer-html5 .rst-content aside.footnote>span.backrefs,html.writer-html5 .rst-content div.citation>span.backrefs{grid-column-start:2;grid-column-end:3;grid-row-start:1;grid-row-end:3}html.writer-html5 .rst-content aside.citation>p,html.writer-html5 .rst-content aside.footnote>p,html.writer-html5 .rst-content div.citation>p{grid-column-start:4;grid-column-end:5}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{margin-bottom:24px}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{padding-left:1rem}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dd,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dd,html.writer-html5 .rst-content dl.footnote>dt{margin-bottom:0}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{font-size:.9rem}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.footnote>dt{margin:0 .5rem .5rem 0;line-height:1.2rem;word-break:break-all;font-weight:400}html.writer-html5 .rst-content dl.citation>dt>span.brackets:before,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:before{content:"["}html.writer-html5 .rst-content dl.citation>dt>span.brackets:after,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:after{content:"]"}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a{word-break:keep-all}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a:not(:first-child):before,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.footnote>dd{margin:0 0 .5rem;line-height:1.2rem}html.writer-html5 .rst-content dl.citation>dd p,html.writer-html5 .rst-content dl.footnote>dd p{font-size:.9rem}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{padding-left:1rem;padding-right:1rem;font-size:.9rem;line-height:1.2rem}html.writer-html5 .rst-content aside.citation p,html.writer-html5 .rst-content aside.footnote p,html.writer-html5 .rst-content div.citation p{font-size:.9rem;line-height:1.2rem;margin-bottom:12px}html.writer-html5 .rst-content aside.citation span.backrefs,html.writer-html5 .rst-content aside.footnote span.backrefs,html.writer-html5 .rst-content div.citation span.backrefs{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content aside.citation span.backrefs>a,html.writer-html5 .rst-content aside.footnote span.backrefs>a,html.writer-html5 .rst-content div.citation span.backrefs>a{word-break:keep-all}html.writer-html5 .rst-content aside.citation span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content aside.footnote span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content div.citation span.backrefs>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content aside.citation span.label,html.writer-html5 .rst-content aside.footnote span.label,html.writer-html5 .rst-content div.citation span.label{line-height:1.2rem}html.writer-html5 .rst-content aside.citation-list,html.writer-html5 .rst-content aside.footnote-list,html.writer-html5 .rst-content div.citation-list{margin-bottom:24px}html.writer-html5 .rst-content dl.option-list kbd{font-size:.9rem}.rst-content table.docutils.footnote,html.writer-html4 .rst-content table.docutils.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content aside.footnote-list aside.footnote,html.writer-html5 .rst-content div.citation-list>div.citation,html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{color:grey}.rst-content table.docutils.footnote code,.rst-content table.docutils.footnote tt,html.writer-html4 .rst-content table.docutils.citation code,html.writer-html4 .rst-content table.docutils.citation tt,html.writer-html5 .rst-content aside.footnote-list aside.footnote code,html.writer-html5 .rst-content aside.footnote-list aside.footnote tt,html.writer-html5 .rst-content aside.footnote code,html.writer-html5 .rst-content aside.footnote tt,html.writer-html5 .rst-content div.citation-list>div.citation code,html.writer-html5 .rst-content div.citation-list>div.citation tt,html.writer-html5 .rst-content dl.citation code,html.writer-html5 .rst-content dl.citation tt,html.writer-html5 .rst-content dl.footnote code,html.writer-html5 .rst-content dl.footnote tt{color:#555}.rst-content .wy-table-responsive.citation,.rst-content .wy-table-responsive.footnote{margin-bottom:0}.rst-content .wy-table-responsive.citation+:not(.citation),.rst-content .wy-table-responsive.footnote+:not(.footnote){margin-top:24px}.rst-content .wy-table-responsive.citation:last-child,.rst-content .wy-table-responsive.footnote:last-child{margin-bottom:24px}.rst-content table.docutils th{border-color:#e1e4e5}html.writer-html5 .rst-content table.docutils th{border:1px solid #e1e4e5}html.writer-html5 .rst-content table.docutils td>p,html.writer-html5 .rst-content table.docutils th>p{line-height:1rem;margin-bottom:0;font-size:.9rem}.rst-content table.docutils td .last,.rst-content table.docutils td .last>:last-child{margin-bottom:0}.rst-content table.field-list,.rst-content table.field-list td{border:none}.rst-content table.field-list td p{line-height:inherit}.rst-content table.field-list td>strong{display:inline-block}.rst-content table.field-list .field-name{padding-right:10px;text-align:left;white-space:nowrap}.rst-content table.field-list .field-body{text-align:left}.rst-content code,.rst-content tt{color:#000;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;padding:2px 5px}.rst-content code big,.rst-content code em,.rst-content tt big,.rst-content tt em{font-size:100%!important;line-height:normal}.rst-content code.literal,.rst-content tt.literal{color:#e74c3c;white-space:normal}.rst-content code.xref,.rst-content tt.xref,a .rst-content code,a .rst-content tt{font-weight:700;color:#404040;overflow-wrap:normal}.rst-content kbd,.rst-content pre,.rst-content samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace}.rst-content a code,.rst-content a tt{color:#2980b9}.rst-content dl{margin-bottom:24px}.rst-content dl dt{font-weight:700;margin-bottom:12px}.rst-content dl ol,.rst-content dl p,.rst-content dl table,.rst-content dl ul{margin-bottom:12px}.rst-content dl dd{margin:0 0 12px 24px;line-height:24px}.rst-content dl dd>ol:last-child,.rst-content dl dd>p:last-child,.rst-content dl dd>table:last-child,.rst-content dl dd>ul:last-child{margin-bottom:0}html.writer-html4 .rst-content dl:not(.docutils),html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple){margin-bottom:24px}html.writer-html4 .rst-content dl:not(.docutils)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{display:table;margin:6px 0;font-size:90%;line-height:normal;background:#e7f2fa;color:#2980b9;border-top:3px solid #6ab0de;padding:6px;position:relative}html.writer-html4 .rst-content dl:not(.docutils)>dt:before,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:before{color:#6ab0de}html.writer-html4 .rst-content dl:not(.docutils)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{margin-bottom:6px;border:none;border-left:3px solid #ccc;background:#f0f0f0;color:#555}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils)>dt:first-child,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:first-child{margin-top:0}html.writer-html4 .rst-content dl:not(.docutils) code.descclassname,html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descclassname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{background-color:transparent;border:none;padding:0;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .optional,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .property,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .property{display:inline-block;padding-right:8px;max-width:100%}html.writer-html4 .rst-content dl:not(.docutils) .k,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .k{font-style:italic}html.writer-html4 .rst-content dl:not(.docutils) .descclassname,html.writer-html4 .rst-content dl:not(.docutils) .descname,html.writer-html4 .rst-content dl:not(.docutils) .sig-name,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .sig-name{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#000}.rst-content .viewcode-back,.rst-content .viewcode-link{display:inline-block;color:#27ae60;font-size:80%;padding-left:24px}.rst-content .viewcode-back{display:block;float:right}.rst-content p.rubric{margin-bottom:12px;font-weight:700}.rst-content code.download,.rst-content tt.download{background:inherit;padding:inherit;font-weight:400;font-family:inherit;font-size:inherit;color:inherit;border:inherit;white-space:inherit}.rst-content code.download span:first-child,.rst-content tt.download span:first-child{-webkit-font-smoothing:subpixel-antialiased}.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{margin-right:4px}.rst-content .guilabel,.rst-content .menuselection{font-size:80%;font-weight:700;border-radius:4px;padding:2.4px 6px;margin:auto 2px}.rst-content .guilabel,.rst-content .menuselection{border:1px solid #7fbbe3;background:#e7f2fa}.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>.kbd,.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>kbd{color:inherit;font-size:80%;background-color:#fff;border:1px solid #a6a6a6;border-radius:4px;box-shadow:0 2px grey;padding:2.4px 6px;margin:auto 0}.rst-content .versionmodified{font-style:italic}@media screen and (max-width:480px){.rst-content .sidebar{width:100%}}span[id*=MathJax-Span]{color:#404040}.math{text-align:center}@font-face{font-family:Lato;src:url(fonts/lato-normal.woff2?bd03a2cc277bbbc338d464e679fe9942) format("woff2"),url(fonts/lato-normal.woff?27bd77b9162d388cb8d4c4217c7c5e2a) format("woff");font-weight:400;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold.woff2?cccb897485813c7c256901dbca54ecf2) format("woff2"),url(fonts/lato-bold.woff?d878b6c29b10beca227e9eef4246111b) format("woff");font-weight:700;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold-italic.woff2?0b6bb6725576b072c5d0b02ecdd1900d) format("woff2"),url(fonts/lato-bold-italic.woff?9c7e4e9eb485b4a121c760e61bc3707c) format("woff");font-weight:700;font-style:italic;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-normal-italic.woff2?4eb103b4d12be57cb1d040ed5e162e9d) format("woff2"),url(fonts/lato-normal-italic.woff?f28f2d6482446544ef1ea1ccc6dd5892) format("woff");font-weight:400;font-style:italic;font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:400;src:url(fonts/Roboto-Slab-Regular.woff2?7abf5b8d04d26a2cafea937019bca958) format("woff2"),url(fonts/Roboto-Slab-Regular.woff?c1be9284088d487c5e3ff0a10a92e58c) format("woff");font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:700;src:url(fonts/Roboto-Slab-Bold.woff2?9984f4a9bda09be08e83f2506954adbe) format("woff2"),url(fonts/Roboto-Slab-Bold.woff?bed5564a116b05148e3b3bea6fb1162a) format("woff");font-display:block} \ No newline at end of file diff --git a/docs/sphinx/build/html/_static/doctools.js b/docs/sphinx/build/html/_static/doctools.js new file mode 100644 index 0000000..0398ebb --- /dev/null +++ b/docs/sphinx/build/html/_static/doctools.js @@ -0,0 +1,149 @@ +/* + * Base JavaScript utilities for all Sphinx HTML documentation. + */ +"use strict"; + +const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([ + "TEXTAREA", + "INPUT", + "SELECT", + "BUTTON", +]); + +const _ready = (callback) => { + if (document.readyState !== "loading") { + callback(); + } else { + document.addEventListener("DOMContentLoaded", callback); + } +}; + +/** + * Small JavaScript module for the documentation. + */ +const Documentation = { + init: () => { + Documentation.initDomainIndexTable(); + Documentation.initOnKeyListeners(); + }, + + /** + * i18n support + */ + TRANSLATIONS: {}, + PLURAL_EXPR: (n) => (n === 1 ? 0 : 1), + LOCALE: "unknown", + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext: (string) => { + const translated = Documentation.TRANSLATIONS[string]; + switch (typeof translated) { + case "undefined": + return string; // no translation + case "string": + return translated; // translation exists + default: + return translated[0]; // (singular, plural) translation tuple exists + } + }, + + ngettext: (singular, plural, n) => { + const translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated !== "undefined") + return translated[Documentation.PLURAL_EXPR(n)]; + return n === 1 ? singular : plural; + }, + + addTranslations: (catalog) => { + Object.assign(Documentation.TRANSLATIONS, catalog.messages); + Documentation.PLURAL_EXPR = new Function( + "n", + `return (${catalog.plural_expr})` + ); + Documentation.LOCALE = catalog.locale; + }, + + /** + * helper function to focus on search bar + */ + focusSearchBar: () => { + document.querySelectorAll("input[name=q]")[0]?.focus(); + }, + + /** + * Initialise the domain index toggle buttons + */ + initDomainIndexTable: () => { + const toggler = (el) => { + const idNumber = el.id.substr(7); + const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`); + if (el.src.substr(-9) === "minus.png") { + el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`; + toggledRows.forEach((el) => (el.style.display = "none")); + } else { + el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`; + toggledRows.forEach((el) => (el.style.display = "")); + } + }; + + const togglerElements = document.querySelectorAll("img.toggler"); + togglerElements.forEach((el) => + el.addEventListener("click", (event) => toggler(event.currentTarget)) + ); + togglerElements.forEach((el) => (el.style.display = "")); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler); + }, + + initOnKeyListeners: () => { + // only install a listener if it is really needed + if ( + !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS && + !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS + ) + return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.altKey || event.ctrlKey || event.metaKey) return; + + if (!event.shiftKey) { + switch (event.key) { + case "ArrowLeft": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const prevLink = document.querySelector('link[rel="prev"]'); + if (prevLink && prevLink.href) { + window.location.href = prevLink.href; + event.preventDefault(); + } + break; + case "ArrowRight": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const nextLink = document.querySelector('link[rel="next"]'); + if (nextLink && nextLink.href) { + window.location.href = nextLink.href; + event.preventDefault(); + } + break; + } + } + + // some keyboard layouts may need Shift to get / + switch (event.key) { + case "/": + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break; + Documentation.focusSearchBar(); + event.preventDefault(); + } + }); + }, +}; + +// quick alias for translations +const _ = Documentation.gettext; + +_ready(Documentation.init); diff --git a/docs/sphinx/build/html/_static/documentation_options.js b/docs/sphinx/build/html/_static/documentation_options.js new file mode 100644 index 0000000..8c2e408 --- /dev/null +++ b/docs/sphinx/build/html/_static/documentation_options.js @@ -0,0 +1,13 @@ +const DOCUMENTATION_OPTIONS = { + VERSION: '0.3, 1.0', + LANGUAGE: 'en', + COLLAPSE_INDEX: false, + BUILDER: 'html', + FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false, + SHOW_SEARCH_SUMMARY: true, + ENABLE_SEARCH_SHORTCUTS: true, +}; \ No newline at end of file diff --git a/docs/sphinx/build/html/_static/file.png b/docs/sphinx/build/html/_static/file.png new file mode 100644 index 0000000..a858a41 Binary files /dev/null and b/docs/sphinx/build/html/_static/file.png differ diff --git a/docs/sphinx/build/html/_static/fonts/Lato/lato-bold.eot b/docs/sphinx/build/html/_static/fonts/Lato/lato-bold.eot new file mode 100644 index 0000000..3361183 Binary files /dev/null and b/docs/sphinx/build/html/_static/fonts/Lato/lato-bold.eot differ diff --git a/docs/sphinx/build/html/_static/fonts/Lato/lato-bold.ttf b/docs/sphinx/build/html/_static/fonts/Lato/lato-bold.ttf new file mode 100644 index 0000000..29f691d Binary files /dev/null and b/docs/sphinx/build/html/_static/fonts/Lato/lato-bold.ttf differ diff --git a/docs/sphinx/build/html/_static/fonts/Lato/lato-bold.woff b/docs/sphinx/build/html/_static/fonts/Lato/lato-bold.woff new file mode 100644 index 0000000..c6dff51 Binary files /dev/null and b/docs/sphinx/build/html/_static/fonts/Lato/lato-bold.woff differ diff --git a/docs/sphinx/build/html/_static/fonts/Lato/lato-bold.woff2 b/docs/sphinx/build/html/_static/fonts/Lato/lato-bold.woff2 new file mode 100644 index 0000000..bb19504 Binary files /dev/null and b/docs/sphinx/build/html/_static/fonts/Lato/lato-bold.woff2 differ diff --git a/docs/sphinx/build/html/_static/fonts/Lato/lato-bolditalic.eot b/docs/sphinx/build/html/_static/fonts/Lato/lato-bolditalic.eot new file mode 100644 index 0000000..3d41549 Binary files /dev/null and b/docs/sphinx/build/html/_static/fonts/Lato/lato-bolditalic.eot differ diff --git a/docs/sphinx/build/html/_static/fonts/Lato/lato-bolditalic.ttf b/docs/sphinx/build/html/_static/fonts/Lato/lato-bolditalic.ttf new file mode 100644 index 0000000..f402040 Binary files /dev/null and b/docs/sphinx/build/html/_static/fonts/Lato/lato-bolditalic.ttf differ diff --git a/docs/sphinx/build/html/_static/fonts/Lato/lato-bolditalic.woff b/docs/sphinx/build/html/_static/fonts/Lato/lato-bolditalic.woff new file mode 100644 index 0000000..88ad05b Binary files /dev/null and b/docs/sphinx/build/html/_static/fonts/Lato/lato-bolditalic.woff differ diff --git a/docs/sphinx/build/html/_static/fonts/Lato/lato-bolditalic.woff2 b/docs/sphinx/build/html/_static/fonts/Lato/lato-bolditalic.woff2 new file mode 100644 index 0000000..c4e3d80 Binary files /dev/null and b/docs/sphinx/build/html/_static/fonts/Lato/lato-bolditalic.woff2 differ diff --git a/docs/sphinx/build/html/_static/fonts/Lato/lato-italic.eot b/docs/sphinx/build/html/_static/fonts/Lato/lato-italic.eot new file mode 100644 index 0000000..3f82642 Binary files /dev/null and b/docs/sphinx/build/html/_static/fonts/Lato/lato-italic.eot differ diff --git a/docs/sphinx/build/html/_static/fonts/Lato/lato-italic.ttf b/docs/sphinx/build/html/_static/fonts/Lato/lato-italic.ttf new file mode 100644 index 0000000..b4bfc9b Binary files /dev/null and b/docs/sphinx/build/html/_static/fonts/Lato/lato-italic.ttf differ diff --git a/docs/sphinx/build/html/_static/fonts/Lato/lato-italic.woff b/docs/sphinx/build/html/_static/fonts/Lato/lato-italic.woff new file mode 100644 index 0000000..76114bc Binary files /dev/null and b/docs/sphinx/build/html/_static/fonts/Lato/lato-italic.woff differ diff --git a/docs/sphinx/build/html/_static/fonts/Lato/lato-italic.woff2 b/docs/sphinx/build/html/_static/fonts/Lato/lato-italic.woff2 new file mode 100644 index 0000000..3404f37 Binary files /dev/null and b/docs/sphinx/build/html/_static/fonts/Lato/lato-italic.woff2 differ diff --git a/docs/sphinx/build/html/_static/fonts/Lato/lato-regular.eot b/docs/sphinx/build/html/_static/fonts/Lato/lato-regular.eot new file mode 100644 index 0000000..11e3f2a Binary files /dev/null and b/docs/sphinx/build/html/_static/fonts/Lato/lato-regular.eot differ diff --git a/docs/sphinx/build/html/_static/fonts/Lato/lato-regular.ttf b/docs/sphinx/build/html/_static/fonts/Lato/lato-regular.ttf new file mode 100644 index 0000000..74decd9 Binary files /dev/null and b/docs/sphinx/build/html/_static/fonts/Lato/lato-regular.ttf differ diff --git a/docs/sphinx/build/html/_static/fonts/Lato/lato-regular.woff b/docs/sphinx/build/html/_static/fonts/Lato/lato-regular.woff new file mode 100644 index 0000000..ae1307f Binary files /dev/null and b/docs/sphinx/build/html/_static/fonts/Lato/lato-regular.woff differ diff --git a/docs/sphinx/build/html/_static/fonts/Lato/lato-regular.woff2 b/docs/sphinx/build/html/_static/fonts/Lato/lato-regular.woff2 new file mode 100644 index 0000000..3bf9843 Binary files /dev/null and b/docs/sphinx/build/html/_static/fonts/Lato/lato-regular.woff2 differ diff --git a/docs/sphinx/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.eot b/docs/sphinx/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.eot new file mode 100644 index 0000000..79dc8ef Binary files /dev/null and b/docs/sphinx/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.eot differ diff --git a/docs/sphinx/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.ttf b/docs/sphinx/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.ttf new file mode 100644 index 0000000..df5d1df Binary files /dev/null and b/docs/sphinx/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.ttf differ diff --git a/docs/sphinx/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff b/docs/sphinx/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff new file mode 100644 index 0000000..6cb6000 Binary files /dev/null and b/docs/sphinx/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff differ diff --git a/docs/sphinx/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff2 b/docs/sphinx/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff2 new file mode 100644 index 0000000..7059e23 Binary files /dev/null and b/docs/sphinx/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff2 differ diff --git a/docs/sphinx/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.eot b/docs/sphinx/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.eot new file mode 100644 index 0000000..2f7ca78 Binary files /dev/null and b/docs/sphinx/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.eot differ diff --git a/docs/sphinx/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.ttf b/docs/sphinx/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.ttf new file mode 100644 index 0000000..eb52a79 Binary files /dev/null and b/docs/sphinx/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.ttf differ diff --git a/docs/sphinx/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff b/docs/sphinx/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff new file mode 100644 index 0000000..f815f63 Binary files /dev/null and b/docs/sphinx/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff differ diff --git a/docs/sphinx/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff2 b/docs/sphinx/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff2 new file mode 100644 index 0000000..f2c76e5 Binary files /dev/null and b/docs/sphinx/build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff2 differ diff --git a/docs/sphinx/build/html/_static/jquery.js b/docs/sphinx/build/html/_static/jquery.js new file mode 100644 index 0000000..c4c6022 --- /dev/null +++ b/docs/sphinx/build/html/_static/jquery.js @@ -0,0 +1,2 @@ +/*! jQuery v3.6.0 | (c) OpenJS Foundation and other contributors | jquery.org/license */ +!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],r=Object.getPrototypeOf,s=t.slice,g=t.flat?function(e){return t.flat.call(e)}:function(e){return t.concat.apply([],e)},u=t.push,i=t.indexOf,n={},o=n.toString,v=n.hasOwnProperty,a=v.toString,l=a.call(Object),y={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType&&"function"!=typeof e.item},x=function(e){return null!=e&&e===e.window},E=C.document,c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.6.0",S=function(e,t){return new S.fn.init(e,t)};function p(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&y(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!v||!v.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ye(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace($,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ve(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ye(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e&&e.namespaceURI,n=e&&(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],v=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&v.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||v.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||v.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||v.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||v.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||v.push(".#.+[+~]"),e.querySelectorAll("\\\f"),v.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&v.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&v.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&v.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),v.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),v=v.length&&new RegExp(v.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),y=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},j=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&y(p,e)?-1:t==C||t.ownerDocument==p&&y(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!v||!v.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||D,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,D=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),y.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="",y.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="",y.option=!!ce.lastChild;var ge={thead:[1,"","
"],col:[2,"","
"],tr:[2,"","
"],td:[3,"","
"],_default:[0,"",""]};function ve(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ye(e,t){for(var n=0,r=e.length;n",""]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function je(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function De(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function qe(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Le(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var _t,zt=[],Ut=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=zt.pop()||S.expando+"_"+wt.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Ut.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Ut.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Ut,"$1"+r):!1!==e.jsonp&&(e.url+=(Tt.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,zt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),y.createHTMLDocument=((_t=E.implementation.createHTMLDocument("").body).innerHTML="
",2===_t.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(y.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return $(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=Fe(y.pixelPosition,function(e,t){if(t)return t=We(e,n),Pe.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return $(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 0"),n("table.docutils.footnote").wrap("
"),n("table.docutils.citation").wrap("
"),n(".wy-menu-vertical ul").not(".simple").siblings("a").each((function(){var t=n(this);expand=n(''),expand.on("click",(function(n){return e.toggleCurrent(t),n.stopPropagation(),!1})),t.prepend(expand)}))},reset:function(){var n=encodeURI(window.location.hash)||"#";try{var e=$(".wy-menu-vertical"),t=e.find('[href="'+n+'"]');if(0===t.length){var i=$('.document [id="'+n.substring(1)+'"]').closest("div.section");0===(t=e.find('[href="#'+i.attr("id")+'"]')).length&&(t=e.find('[href="#"]'))}if(t.length>0){$(".wy-menu-vertical .current").removeClass("current").attr("aria-expanded","false"),t.addClass("current").attr("aria-expanded","true"),t.closest("li.toctree-l1").parent().addClass("current").attr("aria-expanded","true");for(let n=1;n<=10;n++)t.closest("li.toctree-l"+n).addClass("current").attr("aria-expanded","true");t[0].scrollIntoView()}}catch(n){console.log("Error expanding nav for anchor",n)}},onScroll:function(){this.winScroll=!1;var n=this.win.scrollTop(),e=n+this.winHeight,t=this.navBar.scrollTop()+(n-this.winPosition);n<0||e>this.docHeight||(this.navBar.scrollTop(t),this.winPosition=n)},onResize:function(){this.winResize=!1,this.winHeight=this.win.height(),this.docHeight=$(document).height()},hashChange:function(){this.linkScroll=!0,this.win.one("hashchange",(function(){this.linkScroll=!1}))},toggleCurrent:function(n){var e=n.closest("li");e.siblings("li.current").removeClass("current").attr("aria-expanded","false"),e.siblings().find("li.current").removeClass("current").attr("aria-expanded","false");var t=e.find("> ul li");t.length&&(t.removeClass("current").attr("aria-expanded","false"),e.toggleClass("current").attr("aria-expanded",(function(n,e){return"true"==e?"false":"true"})))}},"undefined"!=typeof window&&(window.SphinxRtdTheme={Navigation:n.exports.ThemeNav,StickyNav:n.exports.ThemeNav}),function(){for(var n=0,e=["ms","moz","webkit","o"],t=0;t a.language.name.localeCompare(b.language.name)); + + const languagesHTML = ` +
+
Languages
+ ${languages + .map( + (translation) => ` +
+ ${translation.language.code} +
+ `, + ) + .join("\n")} +
+ `; + return languagesHTML; + } + + function renderVersions(config) { + if (!config.versions.active.length) { + return ""; + } + const versionsHTML = ` +
+
Versions
+ ${config.versions.active + .map( + (version) => ` +
+ ${version.slug} +
+ `, + ) + .join("\n")} +
+ `; + return versionsHTML; + } + + function renderDownloads(config) { + if (!Object.keys(config.versions.current.downloads).length) { + return ""; + } + const downloadsNameDisplay = { + pdf: "PDF", + epub: "Epub", + htmlzip: "HTML", + }; + + const downloadsHTML = ` +
+
Downloads
+ ${Object.entries(config.versions.current.downloads) + .map( + ([name, url]) => ` +
+ ${downloadsNameDisplay[name]} +
+ `, + ) + .join("\n")} +
+ `; + return downloadsHTML; + } + + document.addEventListener("readthedocs-addons-data-ready", function (event) { + const config = event.detail.data(); + + const flyout = ` +
+ + Read the Docs + v: ${config.versions.current.slug} + + +
+
+ ${renderLanguages(config)} + ${renderVersions(config)} + ${renderDownloads(config)} +
+
On Read the Docs
+
+ Project Home +
+
+ Builds +
+
+ Downloads +
+
+
+
Search
+
+
+ +
+
+
+
+ + Hosted by Read the Docs + +
+
+ `; + + // Inject the generated flyout into the body HTML element. + document.body.insertAdjacentHTML("beforeend", flyout); + + // Trigger the Read the Docs Addons Search modal when clicking on the "Search docs" input from inside the flyout. + document + .querySelector("#flyout-search-form") + .addEventListener("focusin", () => { + const event = new CustomEvent("readthedocs-search-show"); + document.dispatchEvent(event); + }); + }) +} + +if (themeLanguageSelector || themeVersionSelector) { + function onSelectorSwitch(event) { + const option = event.target.selectedIndex; + const item = event.target.options[option]; + window.location.href = item.dataset.url; + } + + document.addEventListener("readthedocs-addons-data-ready", function (event) { + const config = event.detail.data(); + + const versionSwitch = document.querySelector( + "div.switch-menus > div.version-switch", + ); + if (themeVersionSelector) { + let versions = config.versions.active; + if (config.versions.current.hidden || config.versions.current.type === "external") { + versions.unshift(config.versions.current); + } + const versionSelect = ` + + `; + + versionSwitch.innerHTML = versionSelect; + versionSwitch.firstElementChild.addEventListener("change", onSelectorSwitch); + } + + const languageSwitch = document.querySelector( + "div.switch-menus > div.language-switch", + ); + + if (themeLanguageSelector) { + if (config.projects.translations.length) { + // Add the current language to the options on the selector + let languages = config.projects.translations.concat( + config.projects.current, + ); + languages = languages.sort((a, b) => + a.language.name.localeCompare(b.language.name), + ); + + const languageSelect = ` + + `; + + languageSwitch.innerHTML = languageSelect; + languageSwitch.firstElementChild.addEventListener("change", onSelectorSwitch); + } + else { + languageSwitch.remove(); + } + } + }); +} + +document.addEventListener("readthedocs-addons-data-ready", function (event) { + // Trigger the Read the Docs Addons Search modal when clicking on "Search docs" input from the topnav. + document + .querySelector("[role='search'] input") + .addEventListener("focusin", () => { + const event = new CustomEvent("readthedocs-search-show"); + document.dispatchEvent(event); + }); +}); \ No newline at end of file diff --git a/docs/sphinx/build/html/_static/language_data.js b/docs/sphinx/build/html/_static/language_data.js new file mode 100644 index 0000000..c7fe6c6 --- /dev/null +++ b/docs/sphinx/build/html/_static/language_data.js @@ -0,0 +1,192 @@ +/* + * This script contains the language-specific data used by searchtools.js, + * namely the list of stopwords, stemmer, scorer and splitter. + */ + +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, if available */ + +/** + * Porter Stemmer + */ +var Stemmer = function() { + + var step2list = { + ational: 'ate', + tional: 'tion', + enci: 'ence', + anci: 'ance', + izer: 'ize', + bli: 'ble', + alli: 'al', + entli: 'ent', + eli: 'e', + ousli: 'ous', + ization: 'ize', + ation: 'ate', + ator: 'ate', + alism: 'al', + iveness: 'ive', + fulness: 'ful', + ousness: 'ous', + aliti: 'al', + iviti: 'ive', + biliti: 'ble', + logi: 'log' + }; + + var step3list = { + icate: 'ic', + ative: '', + alize: 'al', + iciti: 'ic', + ical: 'ic', + ful: '', + ness: '' + }; + + var c = "[^aeiou]"; // consonant + var v = "[aeiouy]"; // vowel + var C = c + "[^aeiouy]*"; // consonant sequence + var V = v + "[aeiou]*"; // vowel sequence + + var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0 + 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 s_v = "^(" + C + ")?" + v; // vowel in stem + + this.stemWord = function (w) { + var stem; + var suffix; + var firstch; + var origword = w; + + if (w.length < 3) + return w; + + var re; + var re2; + var re3; + var re4; + + firstch = w.substr(0,1); + if (firstch == "y") + w = firstch.toUpperCase() + w.substr(1); + + // Step 1a + re = /^(.+?)(ss|i)es$/; + re2 = /^(.+?)([^s])s$/; + + if (re.test(w)) + w = w.replace(re,"$1$2"); + else if (re2.test(w)) + w = w.replace(re2,"$1$2"); + + // Step 1b + re = /^(.+?)eed$/; + re2 = /^(.+?)(ed|ing)$/; + if (re.test(w)) { + var fp = re.exec(w); + re = new RegExp(mgr0); + if (re.test(fp[1])) { + re = /.$/; + w = w.replace(re,""); + } + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1]; + re2 = new RegExp(s_v); + if (re2.test(stem)) { + w = stem; + re2 = /(at|bl|iz)$/; + re3 = new RegExp("([^aeiouylsz])\\1$"); + re4 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re2.test(w)) + w = w + "e"; + else if (re3.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + else if (re4.test(w)) + w = w + "e"; + } + } + + // Step 1c + re = /^(.+?)y$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(s_v); + if (re.test(stem)) + w = stem + "i"; + } + + // Step 2 + 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)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step2list[suffix]; + } + + // Step 3 + re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step3list[suffix]; + } + + // Step 4 + re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; + re2 = /^(.+?)(s|t)(ion)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + if (re.test(stem)) + w = stem; + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1] + fp[2]; + re2 = new RegExp(mgr1); + if (re2.test(stem)) + w = stem; + } + + // Step 5 + re = /^(.+?)e$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + re2 = new RegExp(meq1); + re3 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) + w = stem; + } + re = /ll$/; + re2 = new RegExp(mgr1); + if (re.test(w) && re2.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + + // and turn initial Y back to y + if (firstch == "y") + w = firstch.toLowerCase() + w.substr(1); + return w; + } +} + diff --git a/docs/sphinx/build/html/_static/minus.png b/docs/sphinx/build/html/_static/minus.png new file mode 100644 index 0000000..d96755f Binary files /dev/null and b/docs/sphinx/build/html/_static/minus.png differ diff --git a/docs/sphinx/build/html/_static/plus.png b/docs/sphinx/build/html/_static/plus.png new file mode 100644 index 0000000..7107cec Binary files /dev/null and b/docs/sphinx/build/html/_static/plus.png differ diff --git a/docs/sphinx/build/html/_static/pygments.css b/docs/sphinx/build/html/_static/pygments.css new file mode 100644 index 0000000..84ab303 --- /dev/null +++ b/docs/sphinx/build/html/_static/pygments.css @@ -0,0 +1,75 @@ +pre { line-height: 125%; } +td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } +span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } +td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +.highlight .hll { background-color: #ffffcc } +.highlight { background: #f8f8f8; } +.highlight .c { color: #3D7B7B; font-style: italic } /* Comment */ +.highlight .err { border: 1px solid #FF0000 } /* Error */ +.highlight .k { color: #008000; font-weight: bold } /* Keyword */ +.highlight .o { color: #666666 } /* Operator */ +.highlight .ch { color: #3D7B7B; font-style: italic } /* Comment.Hashbang */ +.highlight .cm { color: #3D7B7B; font-style: italic } /* Comment.Multiline */ +.highlight .cp { color: #9C6500 } /* Comment.Preproc */ +.highlight .cpf { color: #3D7B7B; font-style: italic } /* Comment.PreprocFile */ +.highlight .c1 { color: #3D7B7B; font-style: italic } /* Comment.Single */ +.highlight .cs { color: #3D7B7B; font-style: italic } /* Comment.Special */ +.highlight .gd { color: #A00000 } /* Generic.Deleted */ +.highlight .ge { font-style: italic } /* Generic.Emph */ +.highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */ +.highlight .gr { color: #E40000 } /* Generic.Error */ +.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ +.highlight .gi { color: #008400 } /* Generic.Inserted */ +.highlight .go { color: #717171 } /* Generic.Output */ +.highlight .gp { color: #000080; font-weight: bold } /* Generic.Prompt */ +.highlight .gs { font-weight: bold } /* Generic.Strong */ +.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ +.highlight .gt { color: #0044DD } /* Generic.Traceback */ +.highlight .kc { color: #008000; font-weight: bold } /* Keyword.Constant */ +.highlight .kd { color: #008000; font-weight: bold } /* Keyword.Declaration */ +.highlight .kn { color: #008000; font-weight: bold } /* Keyword.Namespace */ +.highlight .kp { color: #008000 } /* Keyword.Pseudo */ +.highlight .kr { color: #008000; font-weight: bold } /* Keyword.Reserved */ +.highlight .kt { color: #B00040 } /* Keyword.Type */ +.highlight .m { color: #666666 } /* Literal.Number */ +.highlight .s { color: #BA2121 } /* Literal.String */ +.highlight .na { color: #687822 } /* Name.Attribute */ +.highlight .nb { color: #008000 } /* Name.Builtin */ +.highlight .nc { color: #0000FF; font-weight: bold } /* Name.Class */ +.highlight .no { color: #880000 } /* Name.Constant */ +.highlight .nd { color: #AA22FF } /* Name.Decorator */ +.highlight .ni { color: #717171; font-weight: bold } /* Name.Entity */ +.highlight .ne { color: #CB3F38; font-weight: bold } /* Name.Exception */ +.highlight .nf { color: #0000FF } /* Name.Function */ +.highlight .nl { color: #767600 } /* Name.Label */ +.highlight .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */ +.highlight .nt { color: #008000; font-weight: bold } /* Name.Tag */ +.highlight .nv { color: #19177C } /* Name.Variable */ +.highlight .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */ +.highlight .w { color: #bbbbbb } /* Text.Whitespace */ +.highlight .mb { color: #666666 } /* Literal.Number.Bin */ +.highlight .mf { color: #666666 } /* Literal.Number.Float */ +.highlight .mh { color: #666666 } /* Literal.Number.Hex */ +.highlight .mi { color: #666666 } /* Literal.Number.Integer */ +.highlight .mo { color: #666666 } /* Literal.Number.Oct */ +.highlight .sa { color: #BA2121 } /* Literal.String.Affix */ +.highlight .sb { color: #BA2121 } /* Literal.String.Backtick */ +.highlight .sc { color: #BA2121 } /* Literal.String.Char */ +.highlight .dl { color: #BA2121 } /* Literal.String.Delimiter */ +.highlight .sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */ +.highlight .s2 { color: #BA2121 } /* Literal.String.Double */ +.highlight .se { color: #AA5D1F; font-weight: bold } /* Literal.String.Escape */ +.highlight .sh { color: #BA2121 } /* Literal.String.Heredoc */ +.highlight .si { color: #A45A77; font-weight: bold } /* Literal.String.Interpol */ +.highlight .sx { color: #008000 } /* Literal.String.Other */ +.highlight .sr { color: #A45A77 } /* Literal.String.Regex */ +.highlight .s1 { color: #BA2121 } /* Literal.String.Single */ +.highlight .ss { color: #19177C } /* Literal.String.Symbol */ +.highlight .bp { color: #008000 } /* Name.Builtin.Pseudo */ +.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 */ \ No newline at end of file diff --git a/docs/sphinx/build/html/_static/searchtools.js b/docs/sphinx/build/html/_static/searchtools.js new file mode 100644 index 0000000..2c774d1 --- /dev/null +++ b/docs/sphinx/build/html/_static/searchtools.js @@ -0,0 +1,632 @@ +/* + * Sphinx JavaScript utilities for the full-text search. + */ +"use strict"; + +/** + * Simple result scoring code. + */ +if (typeof Scorer === "undefined") { + var Scorer = { + // Implement the following function to further tweak the score for each result + // The function takes a result array [docname, title, anchor, descr, score, filename] + // and returns the new score. + /* + score: result => { + const [docname, title, anchor, descr, score, filename, kind] = result + return score + }, + */ + + // query matches the full name of an object + objNameMatch: 11, + // or matches in the last dotted part of the object name + objPartialMatch: 6, + // Additive scores depending on the priority of the object + objPrio: { + 0: 15, // used to be importantResults + 1: 5, // used to be objectResults + 2: -5, // used to be unimportantResults + }, + // Used when the priority is not in the mapping. + objPrioDefault: 0, + + // query found in title + title: 15, + partialTitle: 7, + // query found in terms + term: 5, + partialTerm: 2, + }; +} + +// Global search result kind enum, used by themes to style search results. +class SearchResultKind { + static get index() { return "index"; } + static get object() { return "object"; } + static get text() { return "text"; } + static get title() { return "title"; } +} + +const _removeChildren = (element) => { + while (element && element.lastChild) element.removeChild(element.lastChild); +}; + +/** + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping + */ +const _escapeRegExp = (string) => + string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string + +const _displayItem = (item, searchTerms, highlightTerms) => { + const docBuilder = DOCUMENTATION_OPTIONS.BUILDER; + const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX; + const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX; + const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY; + const contentRoot = document.documentElement.dataset.content_root; + + const [docName, title, anchor, descr, score, _filename, kind] = item; + + let listItem = document.createElement("li"); + // Add a class representing the item's type: + // can be used by a theme's CSS selector for styling + // See SearchResultKind for the class names. + listItem.classList.add(`kind-${kind}`); + let requestUrl; + let linkUrl; + if (docBuilder === "dirhtml") { + // dirhtml builder + let dirname = docName + "/"; + if (dirname.match(/\/index\/$/)) + dirname = dirname.substring(0, dirname.length - 6); + else if (dirname === "index/") dirname = ""; + requestUrl = contentRoot + dirname; + linkUrl = requestUrl; + } else { + // normal html builders + requestUrl = contentRoot + docName + docFileSuffix; + linkUrl = docName + docLinkSuffix; + } + let linkEl = listItem.appendChild(document.createElement("a")); + linkEl.href = linkUrl + anchor; + linkEl.dataset.score = score; + linkEl.innerHTML = title; + if (descr) { + listItem.appendChild(document.createElement("span")).innerHTML = + " (" + descr + ")"; + // highlight search terms in the description + if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js + highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); + } + else if (showSearchSummary) + fetch(requestUrl) + .then((responseData) => responseData.text()) + .then((data) => { + if (data) + listItem.appendChild( + Search.makeSearchSummary(data, searchTerms, anchor) + ); + // highlight search terms in the summary + if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js + highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); + }); + Search.output.appendChild(listItem); +}; +const _finishSearch = (resultCount) => { + Search.stopPulse(); + Search.title.innerText = _("Search Results"); + if (!resultCount) + Search.status.innerText = Documentation.gettext( + "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories." + ); + else + Search.status.innerText = Documentation.ngettext( + "Search finished, found one page matching the search query.", + "Search finished, found ${resultCount} pages matching the search query.", + resultCount, + ).replace('${resultCount}', resultCount); +}; +const _displayNextItem = ( + results, + resultCount, + searchTerms, + highlightTerms, +) => { + // results left, load the summary and display it + // this is intended to be dynamic (don't sub resultsCount) + if (results.length) { + _displayItem(results.pop(), searchTerms, highlightTerms); + setTimeout( + () => _displayNextItem(results, resultCount, searchTerms, highlightTerms), + 5 + ); + } + // search finished, update title and status message + else _finishSearch(resultCount); +}; +// Helper function used by query() to order search results. +// Each input is an array of [docname, title, anchor, descr, score, filename, kind]. +// Order the results by score (in opposite order of appearance, since the +// `_displayNextItem` function uses pop() to retrieve items) and then alphabetically. +const _orderResultsByScoreThenName = (a, b) => { + const leftScore = a[4]; + const rightScore = b[4]; + if (leftScore === rightScore) { + // same score: sort alphabetically + const leftTitle = a[1].toLowerCase(); + const rightTitle = b[1].toLowerCase(); + if (leftTitle === rightTitle) return 0; + return leftTitle > rightTitle ? -1 : 1; // inverted is intentional + } + return leftScore > rightScore ? 1 : -1; +}; + +/** + * Default splitQuery function. Can be overridden in ``sphinx.search`` with a + * custom function per language. + * + * The regular expression works by splitting the string on consecutive characters + * that are not Unicode letters, numbers, underscores, or emoji characters. + * This is the same as ``\W+`` in Python, preserving the surrogate pair area. + */ +if (typeof splitQuery === "undefined") { + var splitQuery = (query) => query + .split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}]+/gu) + .filter(term => term) // remove remaining empty strings +} + +/** + * Search Module + */ +const Search = { + _index: null, + _queued_query: null, + _pulse_status: -1, + + htmlToText: (htmlString, anchor) => { + const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html'); + for (const removalQuery of [".headerlink", "script", "style"]) { + htmlElement.querySelectorAll(removalQuery).forEach((el) => { el.remove() }); + } + if (anchor) { + const anchorContent = htmlElement.querySelector(`[role="main"] ${anchor}`); + if (anchorContent) return anchorContent.textContent; + + console.warn( + `Anchored content block not found. Sphinx search tries to obtain it via DOM query '[role=main] ${anchor}'. Check your theme or template.` + ); + } + + // if anchor not specified or not found, fall back to main content + const docContent = htmlElement.querySelector('[role="main"]'); + if (docContent) return docContent.textContent; + + console.warn( + "Content block not found. Sphinx search tries to obtain it via DOM query '[role=main]'. Check your theme or template." + ); + return ""; + }, + + init: () => { + const query = new URLSearchParams(window.location.search).get("q"); + document + .querySelectorAll('input[name="q"]') + .forEach((el) => (el.value = query)); + if (query) Search.performSearch(query); + }, + + loadIndex: (url) => + (document.body.appendChild(document.createElement("script")).src = url), + + setIndex: (index) => { + Search._index = index; + if (Search._queued_query !== null) { + const query = Search._queued_query; + Search._queued_query = null; + Search.query(query); + } + }, + + hasIndex: () => Search._index !== null, + + deferQuery: (query) => (Search._queued_query = query), + + stopPulse: () => (Search._pulse_status = -1), + + startPulse: () => { + if (Search._pulse_status >= 0) return; + + const pulse = () => { + Search._pulse_status = (Search._pulse_status + 1) % 4; + Search.dots.innerText = ".".repeat(Search._pulse_status); + if (Search._pulse_status >= 0) window.setTimeout(pulse, 500); + }; + pulse(); + }, + + /** + * perform a search for something (or wait until index is loaded) + */ + performSearch: (query) => { + // create the required interface elements + const searchText = document.createElement("h2"); + searchText.textContent = _("Searching"); + const searchSummary = document.createElement("p"); + searchSummary.classList.add("search-summary"); + searchSummary.innerText = ""; + const searchList = document.createElement("ul"); + searchList.setAttribute("role", "list"); + searchList.classList.add("search"); + + const out = document.getElementById("search-results"); + Search.title = out.appendChild(searchText); + Search.dots = Search.title.appendChild(document.createElement("span")); + Search.status = out.appendChild(searchSummary); + Search.output = out.appendChild(searchList); + + const searchProgress = document.getElementById("search-progress"); + // Some themes don't use the search progress node + if (searchProgress) { + searchProgress.innerText = _("Preparing search..."); + } + Search.startPulse(); + + // index already loaded, the browser was quick! + if (Search.hasIndex()) Search.query(query); + else Search.deferQuery(query); + }, + + _parseQuery: (query) => { + // stem the search terms and add them to the correct list + const stemmer = new Stemmer(); + const searchTerms = new Set(); + const excludedTerms = new Set(); + const highlightTerms = new Set(); + const objectTerms = new Set(splitQuery(query.toLowerCase().trim())); + splitQuery(query.trim()).forEach((queryTerm) => { + const queryTermLower = queryTerm.toLowerCase(); + + // maybe skip this "word" + // stopwords array is from language_data.js + if ( + stopwords.indexOf(queryTermLower) !== -1 || + queryTerm.match(/^\d+$/) + ) + return; + + // stem the word + let word = stemmer.stemWord(queryTermLower); + // select the correct list + if (word[0] === "-") excludedTerms.add(word.substr(1)); + else { + searchTerms.add(word); + highlightTerms.add(queryTermLower); + } + }); + + if (SPHINX_HIGHLIGHT_ENABLED) { // set in sphinx_highlight.js + localStorage.setItem("sphinx_highlight_terms", [...highlightTerms].join(" ")) + } + + // console.debug("SEARCH: searching for:"); + // console.info("required: ", [...searchTerms]); + // console.info("excluded: ", [...excludedTerms]); + + return [query, searchTerms, excludedTerms, highlightTerms, objectTerms]; + }, + + /** + * execute search (requires search index to be loaded) + */ + _performSearch: (query, searchTerms, excludedTerms, highlightTerms, objectTerms) => { + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const titles = Search._index.titles; + const allTitles = Search._index.alltitles; + const indexEntries = Search._index.indexentries; + + // Collect multiple result groups to be sorted separately and then ordered. + // Each is an array of [docname, title, anchor, descr, score, filename, kind]. + const normalResults = []; + const nonMainIndexResults = []; + + _removeChildren(document.getElementById("search-progress")); + + const queryLower = query.toLowerCase().trim(); + for (const [title, foundTitles] of Object.entries(allTitles)) { + if (title.toLowerCase().trim().includes(queryLower) && (queryLower.length >= title.length/2)) { + for (const [file, id] of foundTitles) { + const score = Math.round(Scorer.title * queryLower.length / title.length); + const boost = titles[file] === title ? 1 : 0; // add a boost for document titles + normalResults.push([ + docNames[file], + titles[file] !== title ? `${titles[file]} > ${title}` : title, + id !== null ? "#" + id : "", + null, + score + boost, + filenames[file], + SearchResultKind.title, + ]); + } + } + } + + // search for explicit entries in index directives + for (const [entry, foundEntries] of Object.entries(indexEntries)) { + if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) { + for (const [file, id, isMain] of foundEntries) { + const score = Math.round(100 * queryLower.length / entry.length); + const result = [ + docNames[file], + titles[file], + id ? "#" + id : "", + null, + score, + filenames[file], + SearchResultKind.index, + ]; + if (isMain) { + normalResults.push(result); + } else { + nonMainIndexResults.push(result); + } + } + } + } + + // lookup as object + objectTerms.forEach((term) => + normalResults.push(...Search.performObjectSearch(term, objectTerms)) + ); + + // lookup as search terms in fulltext + normalResults.push(...Search.performTermsSearch(searchTerms, excludedTerms)); + + // let the scorer override scores with a custom scoring function + if (Scorer.score) { + normalResults.forEach((item) => (item[4] = Scorer.score(item))); + nonMainIndexResults.forEach((item) => (item[4] = Scorer.score(item))); + } + + // Sort each group of results by score and then alphabetically by name. + normalResults.sort(_orderResultsByScoreThenName); + nonMainIndexResults.sort(_orderResultsByScoreThenName); + + // Combine the result groups in (reverse) order. + // Non-main index entries are typically arbitrary cross-references, + // so display them after other results. + let results = [...nonMainIndexResults, ...normalResults]; + + // remove duplicate search results + // note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept + let seen = new Set(); + results = results.reverse().reduce((acc, result) => { + let resultStr = result.slice(0, 4).concat([result[5]]).map(v => String(v)).join(','); + if (!seen.has(resultStr)) { + acc.push(result); + seen.add(resultStr); + } + return acc; + }, []); + + return results.reverse(); + }, + + query: (query) => { + const [searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms] = Search._parseQuery(query); + const results = Search._performSearch(searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms); + + // for debugging + //Search.lastresults = results.slice(); // a copy + // console.info("search results:", Search.lastresults); + + // print the results + _displayNextItem(results, results.length, searchTerms, highlightTerms); + }, + + /** + * search for object names + */ + performObjectSearch: (object, objectTerms) => { + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const objects = Search._index.objects; + const objNames = Search._index.objnames; + const titles = Search._index.titles; + + const results = []; + + const objectSearchCallback = (prefix, match) => { + const name = match[4] + const fullname = (prefix ? prefix + "." : "") + name; + const fullnameLower = fullname.toLowerCase(); + if (fullnameLower.indexOf(object) < 0) return; + + let score = 0; + const parts = fullnameLower.split("."); + + // check for different match types: exact matches of full name or + // "last name" (i.e. last dotted part) + if (fullnameLower === object || parts.slice(-1)[0] === object) + score += Scorer.objNameMatch; + else if (parts.slice(-1)[0].indexOf(object) > -1) + score += Scorer.objPartialMatch; // matches in last name + + const objName = objNames[match[1]][2]; + const title = titles[match[0]]; + + // If more than one term searched for, we require other words to be + // found in the name/title/description + const otherTerms = new Set(objectTerms); + otherTerms.delete(object); + if (otherTerms.size > 0) { + const haystack = `${prefix} ${name} ${objName} ${title}`.toLowerCase(); + if ( + [...otherTerms].some((otherTerm) => haystack.indexOf(otherTerm) < 0) + ) + return; + } + + let anchor = match[3]; + if (anchor === "") anchor = fullname; + else if (anchor === "-") anchor = objNames[match[1]][1] + "-" + fullname; + + const descr = objName + _(", in ") + title; + + // add custom score for some objects according to scorer + if (Scorer.objPrio.hasOwnProperty(match[2])) + score += Scorer.objPrio[match[2]]; + else score += Scorer.objPrioDefault; + + results.push([ + docNames[match[0]], + fullname, + "#" + anchor, + descr, + score, + filenames[match[0]], + SearchResultKind.object, + ]); + }; + Object.keys(objects).forEach((prefix) => + objects[prefix].forEach((array) => + objectSearchCallback(prefix, array) + ) + ); + return results; + }, + + /** + * search for full-text terms in the index + */ + performTermsSearch: (searchTerms, excludedTerms) => { + // prepare search + const terms = Search._index.terms; + const titleTerms = Search._index.titleterms; + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const titles = Search._index.titles; + + const scoreMap = new Map(); + const fileMap = new Map(); + + // perform the search on the required terms + searchTerms.forEach((word) => { + const files = []; + const arr = [ + { files: terms[word], score: Scorer.term }, + { files: titleTerms[word], score: Scorer.title }, + ]; + // add support for partial matches + if (word.length > 2) { + const escapedWord = _escapeRegExp(word); + if (!terms.hasOwnProperty(word)) { + Object.keys(terms).forEach((term) => { + if (term.match(escapedWord)) + arr.push({ files: terms[term], score: Scorer.partialTerm }); + }); + } + if (!titleTerms.hasOwnProperty(word)) { + Object.keys(titleTerms).forEach((term) => { + if (term.match(escapedWord)) + arr.push({ files: titleTerms[term], score: Scorer.partialTitle }); + }); + } + } + + // no match but word was a required one + if (arr.every((record) => record.files === undefined)) return; + + // found search word in contents + arr.forEach((record) => { + if (record.files === undefined) return; + + let recordFiles = record.files; + if (recordFiles.length === undefined) recordFiles = [recordFiles]; + files.push(...recordFiles); + + // set score for the word in each file + recordFiles.forEach((file) => { + if (!scoreMap.has(file)) scoreMap.set(file, {}); + scoreMap.get(file)[word] = record.score; + }); + }); + + // create the mapping + files.forEach((file) => { + if (!fileMap.has(file)) fileMap.set(file, [word]); + else if (fileMap.get(file).indexOf(word) === -1) fileMap.get(file).push(word); + }); + }); + + // now check if the files don't contain excluded terms + const results = []; + for (const [file, wordList] of fileMap) { + // check if all requirements are matched + + // as search terms with length < 3 are discarded + const filteredTermCount = [...searchTerms].filter( + (term) => term.length > 2 + ).length; + if ( + wordList.length !== searchTerms.size && + wordList.length !== filteredTermCount + ) + continue; + + // ensure that none of the excluded terms is in the search result + if ( + [...excludedTerms].some( + (term) => + terms[term] === file || + titleTerms[term] === file || + (terms[term] || []).includes(file) || + (titleTerms[term] || []).includes(file) + ) + ) + break; + + // select one (max) score for the file. + const score = Math.max(...wordList.map((w) => scoreMap.get(file)[w])); + // add result to the result list + results.push([ + docNames[file], + titles[file], + "", + null, + score, + filenames[file], + SearchResultKind.text, + ]); + } + return results; + }, + + /** + * helper function to return a node containing the + * search summary for a given text. keywords is a list + * of stemmed words. + */ + makeSearchSummary: (htmlText, keywords, anchor) => { + const text = Search.htmlToText(htmlText, anchor); + if (text === "") return null; + + const textLower = text.toLowerCase(); + const actualStartPosition = [...keywords] + .map((k) => textLower.indexOf(k.toLowerCase())) + .filter((i) => i > -1) + .slice(-1)[0]; + const startWithContext = Math.max(actualStartPosition - 120, 0); + + const top = startWithContext === 0 ? "" : "..."; + const tail = startWithContext + 240 < text.length ? "..." : ""; + + let summary = document.createElement("p"); + summary.classList.add("context"); + summary.textContent = top + text.substr(startWithContext, 240).trim() + tail; + + return summary; + }, +}; + +_ready(Search.init); diff --git a/docs/sphinx/build/html/_static/sphinx_highlight.js b/docs/sphinx/build/html/_static/sphinx_highlight.js new file mode 100644 index 0000000..8a96c69 --- /dev/null +++ b/docs/sphinx/build/html/_static/sphinx_highlight.js @@ -0,0 +1,154 @@ +/* Highlighting utilities for Sphinx HTML documentation. */ +"use strict"; + +const SPHINX_HIGHLIGHT_ENABLED = true + +/** + * highlight a given string on a node by wrapping it in + * span elements with the given class name. + */ +const _highlight = (node, addItems, text, className) => { + if (node.nodeType === Node.TEXT_NODE) { + const val = node.nodeValue; + const parent = node.parentNode; + const pos = val.toLowerCase().indexOf(text); + if ( + pos >= 0 && + !parent.classList.contains(className) && + !parent.classList.contains("nohighlight") + ) { + let span; + + const closestNode = parent.closest("body, svg, foreignObject"); + const isInSVG = closestNode && closestNode.matches("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.classList.add(className); + } + + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + const rest = document.createTextNode(val.substr(pos + text.length)); + parent.insertBefore( + span, + parent.insertBefore( + rest, + node.nextSibling + ) + ); + node.nodeValue = val.substr(0, pos); + /* There may be more occurrences of search term in this node. So call this + * function recursively on the remaining fragment. + */ + _highlight(rest, addItems, text, className); + + if (isInSVG) { + const rect = document.createElementNS( + "http://www.w3.org/2000/svg", + "rect" + ); + const bbox = parent.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute("class", className); + addItems.push({ parent: parent, target: rect }); + } + } + } else if (node.matches && !node.matches("button, select, textarea")) { + node.childNodes.forEach((el) => _highlight(el, addItems, text, className)); + } +}; +const _highlightText = (thisNode, text, className) => { + let addItems = []; + _highlight(thisNode, addItems, text, className); + addItems.forEach((obj) => + obj.parent.insertAdjacentElement("beforebegin", obj.target) + ); +}; + +/** + * Small JavaScript module for the documentation. + */ +const SphinxHighlight = { + + /** + * highlight the search words provided in localstorage in the text + */ + highlightSearchWords: () => { + if (!SPHINX_HIGHLIGHT_ENABLED) return; // bail if no highlight + + // get and clear terms from localstorage + const url = new URL(window.location); + const highlight = + localStorage.getItem("sphinx_highlight_terms") + || url.searchParams.get("highlight") + || ""; + localStorage.removeItem("sphinx_highlight_terms") + url.searchParams.delete("highlight"); + window.history.replaceState({}, "", url); + + // get individual terms from highlight string + const terms = highlight.toLowerCase().split(/\s+/).filter(x => x); + if (terms.length === 0) return; // nothing to do + + // There should never be more than one element matching "div.body" + const divBody = document.querySelectorAll("div.body"); + const body = divBody.length ? divBody[0] : document.querySelector("body"); + window.setTimeout(() => { + terms.forEach((term) => _highlightText(body, term, "highlighted")); + }, 10); + + const searchBox = document.getElementById("searchbox"); + if (searchBox === null) return; + searchBox.appendChild( + document + .createRange() + .createContextualFragment( + '" + ) + ); + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords: () => { + document + .querySelectorAll("#searchbox .highlight-link") + .forEach((el) => el.remove()); + document + .querySelectorAll("span.highlighted") + .forEach((el) => el.classList.remove("highlighted")); + localStorage.removeItem("sphinx_highlight_terms") + }, + + initEscapeListener: () => { + // only install a listener if it is really needed + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return; + if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) { + SphinxHighlight.hideSearchWords(); + event.preventDefault(); + } + }); + }, +}; + +_ready(() => { + /* Do not call highlightSearchWords() when we are on the search page. + * It will highlight words from the *previous* search query. + */ + if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords(); + SphinxHighlight.initEscapeListener(); +}); diff --git a/docs/sphinx/build/html/genindex.html b/docs/sphinx/build/html/genindex.html new file mode 100644 index 0000000..d1565b9 --- /dev/null +++ b/docs/sphinx/build/html/genindex.html @@ -0,0 +1,495 @@ + + + + + + + + Index — RP2040-Decoder 0.3, 1.0 documentation + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + +

Index

+ +
+ _ + | A + | B + | C + | D + | E + | F + | G + | I + | L + | M + | P + | R + | S + | T + | U + | V + | W + +
+

_

+ + +
+ +

A

+ + + +
+ +

B

+ + + +
+ +

C

+ + + +
+ +

D

+ + +
+ +

E

+ + + +
+ +

F

+ + + +
+ +

G

+ + + +
+ +

I

+ + + +
+ +

L

+ + + +
+ +

M

+ + + +
+ +

P

+ + + +
+ +

R

+ + + +
+ +

S

+ + + +
+ +

T

+ + + +
+ +

U

+ + +
+ +

V

+ + + +
+ +

W

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

© Copyright 2024, Gabriel Koppenstein.

+
+ + Built with Sphinx using a + theme + provided by Read the Docs. + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/sphinx/build/html/hardware/hw.html b/docs/sphinx/build/html/hardware/hw.html new file mode 100644 index 0000000..c1bc99b --- /dev/null +++ b/docs/sphinx/build/html/hardware/hw.html @@ -0,0 +1,135 @@ + + + + + + + + + Hardware — RP2040-Decoder 0.3, 1.0 documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+ + +
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/sphinx/build/html/hardware/hw_description.html b/docs/sphinx/build/html/hardware/hw_description.html new file mode 100644 index 0000000..e0336ad --- /dev/null +++ b/docs/sphinx/build/html/hardware/hw_description.html @@ -0,0 +1,362 @@ + + + + + + + + + Hardware Description — RP2040-Decoder 0.3, 1.0 documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Hardware Description

+
+

Overview

+Block Diagram +

The above block diagram gives a general overview regarding the operation of components. For better illustration it has been divided into four functional blocks. Furthermore, these functional blocks can be subdivided and will be explained below.

+
    +
  • Input Stage +- DCC Signal Level Shift +- Bridge Rectifier & Voltage Regulator

  • +
  • Motor Driver +- Motor Driver +- Back EMF measurement (ADC)

  • +
  • General Purpose +- GPIO +- Auxiliary output

  • +
  • Microcontroller +- Flash memory +- Crystal oscillator

  • +
+
+
+

Characteristics

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Characteristics table

Parameter

Symbol

Minimum

Maximum

Unit

Absolute max. DCC Input Voltage

VDCC

-25

+25

V

Absolute max. GPIO Voltage(0)

VPIN

-0.5

3.3+0.5

V

Input Voltage High(0)

VIH

2.145

3.6

V

Input Voltage Low(0)

VIL

0

1.155

V

Total GPIO Current(0)

IIOVDD

50

mA

Absolute max. motor output current(1)

IMOTOR

2.8

A

Absolute max. auxiliary output current (2)

IAUX

400

mA

+

(0): According to: RP2040 Datasheet (assuming VDD= 3.3V)

+

(1): According to: BDR6133 Datasheet

+

(2): According to: T2N7002BK Datasheet

+
+
+

Input Stage

+Input Stage +

D1 Rectifies the DCC square-wave into +V, the amplitude is not critical as long as it’s within the 25V limit. The rectified voltage +V is then provided to the 3.3V voltage regulator (U1) and to the motor driver (U2).

+

The MOSFET on the right effectively translates the rather high DCC voltage to a suitable level for the microcontroller to process. When Q1 is turned off GPIO21 is pulled high by the RP2040 internal pull-up resistor, as soon as Q1 gets turned on (V<sub>GS</sub> > V<sub>GS,th</sub>), GPIO21 gets pulled to GND potential. R1 and R2 ensure that V<sub>GS</sub> doesn’t exceed ±20V.

+
+
+

Motor Driver

+Motor Driver +

The Motor Driver is a complete H-Bridge IC specifically made for DC-Motors.

+

In order to control the motor, it is necessary to measure the back-EMF. This is done by the ADC, which measures at Points ADC_EMF_A and ADC_EMF_B respectively. The two resistors are used as a voltage divider.

+
+
+

Auxiliary Output

+Auxiliary Output +

Switching of loads up to a maximum of about ~400mA can be done using four N-Channel MOSFETs. They are switching on the low-side, which means the load effectively gets connected to GND potential as the transistor starts to conduct. GPIO24 - GPIO27 are used.

+
+
+

GPIO

+

To switch lighter loads, six soldering pads on the back side of the PCB are connected to GPIO0 - GPIO5 pins. Although not implemented yet, they could theoretically be used as inputs as well (e.g., Reed switch).

+
+
+

Microcontroller

+Microcontroller +

The Microcontroller needs a crystal oscillator to function properly. External flash memory is also needed as it holds the configuration variables and the program itself. R3 & C14 are used to filter ADC_AVDD (ADC Reference Voltage).

+
+
+

Complete Schematic

+Complete Schematic +
+
+

BOM & Alternative Parts

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
BOM

Ref

Quantity

Value Component Type

Component Name

Footprint

C1, C2, C5, C6, C14

5

10u

Ceramic Capacitor

/

0603_1608Metric

C3, C4, C7, C8, C9, C10, C11, C12, C13, C15

10

100n

Ceramic Capacitor

/

0603_1608Metric

C16, C17

2

33p

Ceramic Capacitor

/

0603_1608Metric

D1

1

VRMS=40V, IF=2A

Bridge Rectifier

KMB24F

MBS (TO-269AA)

Q1, Q2, Q3, Q4, Q5

5

VDS=60V, ID=0.4A

N-Channel MOSFET

T2N7002BK

SOT-23

R1, R2, R5, R6

4

6k8

Resistor

/

0603_1608Metric

R3

1

200

Resistor

/

0603_1608Metric

R7, R8, R9

3

1k

Resistor

/

0603_1608Metric

U1

1

VOUT=3.3V

Low Dropout Voltage Regulator

HT7533S

SOT-23

U2

1

I=2.8A

H-Bridge Driver

BDR6133

SOIC-8

U3

1

64Mb

Flash Memory

W25Q64JVSSIQ

SOIC-8

U4

1

/

Microcontroller

RP2040

QFN-56-1EP_7x7mm_P0.4mm

Y1

1

f=12MHz

Crystal Oscillator

X322512MSB4SI

Crystal_SMD_3225-4Pin_3.2x2.5mm

+

NOTE: Keep capacitor Vmax in mind!

+
+
+

Alternatives for BDR6133:

+ +
+
+

Alternative for HT7533S:

+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/sphinx/build/html/hardware/hw_description_md.html b/docs/sphinx/build/html/hardware/hw_description_md.html new file mode 100644 index 0000000..628b6d3 --- /dev/null +++ b/docs/sphinx/build/html/hardware/hw_description_md.html @@ -0,0 +1,342 @@ + + + + + + + + + Hardware Description — RP2040-Decoder 0.3, 1.0 documentation + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Hardware Description

+
+

Overview

+

Block Diagram

+

The above block diagram gives a general overview regarding the operation of components. For better illustration it has been divided into four functional blocks. Furthermore these functional blocks can be subdivided and will be explained below.

+
    +
  • Input Stage

    +
      +
    • DCC Signal Level Shift

    • +
    • Bridge Rectifier & Voltage Regulator

    • +
    +
  • +
  • Motor Driver

    +
      +
    • Motor Driver

    • +
    • Back EMF measurement (ADC)

    • +
    +
  • +
  • General Purpose

    +
      +
    • GPIO

    • +
    • Auxillary output

    • +
    +
  • +
  • Microcontroller

    +
      +
    • Flash memory

    • +
    • Crystal oscillator

    • +
    +
  • +
+
+
+

Characteristics

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

Parameter

Symbol

Minimum

Maximum

Unit

Absolute max. DCC Input Voltage

VDCC

-25

+25

V

Absolute max. GPIO Voltage(0)

VPIN

-0.5

3.3+0.5

V

Input Voltage High(0)

VIH

2.145

3.6

V

Input Voltage Low(0)

VIL

0

1.155

V

Total GPIO Current(0)

IIOVDD_MAX

50

mA

Absolute max. motor output current(1)

IMOTOR

2.8

A

Absolute max. auxillary output current(2)

IAUX

400

mA

+

(0): According to: RP2040 Datasheet (assuming VDD = 3.3V)

+

(1): According to: BDR6133 Datasheet

+

(2): According to: T2N7002BK Datasheet

+
+
+

Input Stage

+

Input Stage

+

D1 Rectifies the DCC square-wave into +V, the amplitude is not critical as long as its within the 25V limit. The rectified voltage +V is then provided to the 3.3V voltage regulator (U1) and to the motor driver (U2).

+

The MOSFET on the right effectively translates the rather high DCC voltage to a suitable level for the microcontroller to process. When Q1 is turned off GPIO21 is pulled high by the RP2040 internal pull-up resistor, as soon as Q1 gets turned on (VGS > VGS,th), GPIO21 gets pulled to GND potential. R1 and R2 ensure that VGS doesnt exceed ±20V.

+
+
+

Motor Driver

+

Motor Driver

+

The Motor Driver is a complete H-Bridge IC specifically made for DC-Motors.

+

In order to control the motor, it is necessary to measure the back-EMF. This is done by the ADC which measures at Points ADC_EMF_A and ADC_EMF_B respectively. The two resistors are used as a voltage divider.

+
+
+

Auxillary Output

+

Auxillary Output

+

Switching of loads up to a maximum of about ~400mA can be done using four N-Channel MOSFETS. They are switching on the low-side which means the load effectively gets connected to GND potential as the transistor starts to conduct. GPIO24 - GPIO27 are used.

+
+
+

GPIO

+

To switch lighter loads six soldering pads on the back side of the PCB are connected to GPIO0 - GPIO5 pins . Although not implemented yet they could theoretically be used as inputs as well (e.g. Reed switch).

+
+
+

Microcontroller

+

Microcontroller

+

The Microcontroller needs a crystal oscillator to function properly. External flash memory is also needed as it holds the configuration variables and the program itself. R3 & C14 are used to filter ADC_AVDD (ADC Reference Voltage).

+
+
+

Complete Schematic

+

Complete schematic

+
+
+

BOM & Alternative Parts

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

Ref

Quantity

Value

Component Type

Component Name

Footprint

C1, C2, C5, C6, C14

5

10u

Ceramic Capacitor

/

0603_1608Metric

C3, C4, C7, C8, C9, C10, C11, C12, C13, C15

10

100n

Ceramic Capacitor

/

0603_1608Metric

C16, C17

2

33p

Ceramic Capacitor

/

0603_1608Metric

D1

1

VRMS = 40V , IF = 2A

Bridge Rectifier

KMB24F

MBS (TO-269AA)

Q1, Q2, Q3, Q4, Q5

5

VDS = 60V , ID = 0.4A

N-Channel MOSFET

T2N7002BK

SOT-23

R1, R2, R5, R6

4

6k8

Resistor

/

0603_1608Metric

R3

1

200

Resistor

/

0603_1608Metric

R7, R8, R9

3

1k

Resistor

/

0603_1608Metric

U1

1

VOUT = 3.3V

Low Dropout Voltage Regulator

HT7533S

SOT-23

U2

1

I = 2.8A

H-Bridge driver

BDR6133

SOIC-8

U3

1

64Mb

Serial Flash Memory

W25Q64JVSSIQ

SOIC-8

U4

1

/

Raspberry Pi RP2040 Microcontroller

RP2040

QFN-56-1EP_7x7mm_P0.4mm

Y1

1

f = 12MHz

Crystal Oscillator

X322512MSB4SI

Crystal_SMD_3225-4Pin_3.2x2.5mm

+

NOTE: Keep capacitor Vmax in mind!

+

Alternatives for BDR6133:

+

PT5126A-S-TP

+

PT2476

+

Alternative for HT7533S:

+

GS7533-33TR3

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

© Copyright 2024, Gabriel Koppenstein.

+
+ + Built with Sphinx using a + theme + provided by Read the Docs. + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/sphinx/build/html/index.html b/docs/sphinx/build/html/index.html new file mode 100644 index 0000000..53dbf58 --- /dev/null +++ b/docs/sphinx/build/html/index.html @@ -0,0 +1,140 @@ + + + + + + + + + RP2040-Decoder Documentation — RP2040-Decoder 0.3, 1.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+ + +
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/sphinx/build/html/objects.inv b/docs/sphinx/build/html/objects.inv new file mode 100644 index 0000000..5db8f83 Binary files /dev/null and b/docs/sphinx/build/html/objects.inv differ diff --git a/docs/sphinx/build/html/other/CV_list.html b/docs/sphinx/build/html/other/CV_list.html new file mode 100644 index 0000000..696181f --- /dev/null +++ b/docs/sphinx/build/html/other/CV_list.html @@ -0,0 +1,343 @@ + + + + + + + + + Configuration Variables (CV) — RP2040-Decoder 0.3, 1.0 documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Configuration Variables (CV)

+
+

Note

+

CV.h contains default values for every CV. When your board is still “factory new” these values are automatically written into flash. CV_65 == 255 indicates a factory condition and resets all CVs to default. Alternatively to reset all CVs to default a value of 8 can be written to CV8. Also note that index 0 in the CV array corresponds with CV_1, index 1 corresponds with CV_2 and so forth. This list only contains CVs that are in use.

+
+
+

Speed step configuration

+

Speed Table

+
    +
  • V_min = CV_2

  • +
  • V_mid = CV_6 * 16

  • +
  • V_max = CV_5 * 16

  • +
+

The illustration above shows how the speed steps can be configured using the corresponding CVs. The red * represents V_min which is always at speed step 1, the green * shows V_mid at speed step 64 and the blue * shows V_max at speed step 126.

+
+
+

CV List

+
+

CV_1 - Basic address

+

Short DCC address

+
+
+

CV_2 - V_min

+

Min motor voltage/speed

+
+
+

CV_3 - Acceleration rate

+

CV_3*CV_175 = Time for one discrete speed step change in ms

+
+
+

CV_4 - Deceleration rate

+

CV_4*CV_175 = Time for one discrete speed step change in ms

+
+
+

CV_5 - V_max

+

Max motor voltage/speed - V_max = CV_5 * 16

+
+
+

CV_6 - V_mid

+

Mid motor voltage/speed - V_max = CV_6 * 16

+
+
+

CV_7 - Version No. (Read-Only)

+

Rev 0.3 = 1

+

Writing a value of 7 triggers am ADC offset adjustment.

+
+
+

CV_8 - Manufacturer (Read-Only)

+

Default = “13” = Public Domain & Do-It-Yourself Decoders

+

Writing a value of 8 resets all CV values to the default values in CV.h. +This will also happen if CV_65 == “255” == “0xFF”.

+
+
+

CV_9 - Motor PWM Frequency

+

f in Hz = CV_9 * 100 + 10000

+
+
+

CV_11 - Packet timeout

+

If no package is received for x seconds (x = CV_11) the decoder will automatically stop the motor (Emergency Stop).

+
+
+

CV_12 - Permitted operating modes

+

Currently DCC Digital mode is the only supported mode.

+
+
+

CV_17 & CV_18 - 14-Bit extended/long address

+

Address is only used if bit5 has a value of “1” in CV_29.

+

Long Address

+

Bit15 and bit14 which correspond to bit7 and bit6 of CV_17 are always “1”. CV_17 = “192” & CV_18 = “0” is also not a valid address. Otherwise the valid value range of CV_17 ranges from “192” to “231” and “0” to “255” for CV_18 respectively.

+
+
+

CV_29 - Decoder Configuration

+

Bit0 is used to reverse direction i.e. “0” = normal, “1” = reverse. +Bit5 switches between basic and extended addressing modes i.e. “0” = basic address, “1” = extended address. +The other 6 bits are currently not in use and therefore irrelevant.

+
+
+

CV_31 & CV_32 - Extended CV pointer (Read-Only)

+

Not in use.

+
+
+

CV_47 - Feed-forward gain k_ff

+

k_ff defines the correction behavior with regard to the y2 variable. High values for k_ff lead to a faster change in the variable. Values for k_ff that are too high can lead to oscillations. +k_ff = CV_47/10000

+
+
+

CV_48 - Filter time constant (tau) in ms

+

The time constant tau characterizes the low-pass filter which is connected downstream in the D component of the PID controller

+
+
+

CV_49 - PID Control sampling time t in ms

+

Every t seconds the pid_control() function gets called to compute the new control output

+
+
+

CV_50 - PID Control I Factor

+

Integral gain factor of the PID-Controller

+
+
+

CV_51 - PID Control D Factor

+

Derivative gain factor of the PID-Controller

+
+
+

CV_52 & CV_53 - PID Integral Limits

+

Maximum and minimum integral part values

+
+
+

CV_54 & CV_55 - Gain scheduling config k_p @ x0

+

CV_54 - High Byte – CV_55 - Low Byte

+
+
+

CV_56 & CV_57 - Gain scheduling config k_p @ x1

+

CV_56 - High Byte – CV_57 - Low Byte

+
+
+

CV_58 & CV_59 - Gain scheduling config k_p @ x2

+

CV_58 - High Byte – CV_59 - Low Byte

+
+
+

CV_60 - Gain scheduling config x1 shift percentage

+

Determines position of x1 in percent -> x1 shift in % ≙ CV_60/255

+
+
+

CV_61 - Measurement Iterations

+

Total amount of BEMF-Voltage measurement iterations

+
+
+

CV_62 - Measurement Delay

+

BEMF-Voltage measurement delay

+
+
+

CV_63 & CV_64 - Measurement array cutoffs

+

CV_63 determines how many elements from the left side (beginning with index 0) of the array will be discarded while CV_64 determines how many elements from the right side (beginning from highest index) will be discarded.

+
+
+

CV_65 - New flash variable

+

Each Byte of the factory new flash chip should have a inital state of “0xFF”. This will be checked for in the beginning of core0.c (see cv_setup_check()). When CV_65 == “255” == “0xFF” the default config (CV.h) will be written to flash. Alternatively a reset to default can be done by either writing “8” to CV_8 or writing “255” to CV_65 which then triggers a reset on startup.

+
+
+

CV_112, CV_113, CV_114, CV_115 - GPIO PWM Configuration

+

PWM enabled “1” - PWM disabled “0”

+
+
+

CV_116 to CV_171 - PWM Slice configuration

+

GPIO Slices

+

Every slice controls two independent output channels, duty cycle from 0% to 100% inclusive and can be configured with several parameters:

+
    +
  • Wrap (16Bit): Sets the slice time period of x cycles - effectively determining the frequency

  • +
  • Clock Divider: Additional clock divider

  • +
  • Level Channel A / Level Channel B - (16Bit each): Determining how many of the x cycles the signal is at a high level - effectively determining the duty cycle

  • +
+

To see which CVs correspond to which slice and channel, it is advisable to use CV.h as a reference

+

The PWM-frequency is calculated as follows: fPWM = 125 MHz / [ (CVclk_div + 1) * (CVwrap + 1) ]

+

The duty-cycle can be calculated as follows: D = CVLevel / CVwrap + 1

+

Example configuration - (AUX2: PWM-Frequency fPWM = 10kHz; Duty-cycle D = 20%):

+

AUX1 => GPIO25 => Slice 4 / Channel B => Wrap: CV_144 & CV_145; Clock-divider: CV_146; Level(B): CV_149 & CV_150

+

=> fPWM = 10kHz = 125 MHz / [ (0 + 1) * (12499 + 1) ];

+

=> CV_144 = 110000, CV_145 = 11010011, CV_146 = 0; — (Note: “12499dec” = “11000011010011bin”)

+

=> CVLevel = CV_149 & CV_150 = D * (CVwrap + 1) = 0.2 * 12500 = 2500

+

=> CV_149 = 1001, CV_150 = 11000100; — (Note: “2500dec” = “100111000100bin”)

+

Another configuration which also achieves 10kHz and D = 20% would be CVclk_div = 10, CVwrap = 1249, CVLevel = 250.

+

A more detailed explanation regarding PWM can be found in the RP2040-Datasheet - Chapter 4.5.

+
+
+

CV_172 - ADC Offset

+

If CV_172 = “0xFF” = “255” there will be a measurement procedure on startup

+
+
+

CV_173 - ADC offset measurement cycles

+

Determines how many ADC offset measurement iterations are done.

+
+
+

CV_174 - Additional motor-PWM clock divider.

+

Additional Clock Divider - works the same as any GPIO clock divider

+
+
+

CV_175 - speed_helper timer delay

+

This timer delay can be used to change the time between two speed steps. So basically an additional option to adjust the deceleration and acceleration rate.

+
+
+

CV_176, CV_177, CV_178, CV_179 - Base PWM Level used in feed-forward control

+

CV_176 - High Byte forward – CV_177 - Low Byte forward – CV_178 - High Byte reverse – CV_179 - Low Byte reverse

+

These values are equivalent to y1(forward) and y1(reverse) mentioned here. Writing “0” to all four CVs schedules a new calibration on startup.

+
+
+

CV_257 to CV_512 - Function Mapping CVs

+

The switching status of the outputs depends both on the function instruction received and on the current direction of travel. That means you can, for example, use a function to switch two or more outputs or, as is usual with headlights, switch them depending on the direction of travel. For configuration, 32 bits (corresponding to the GPIOs) are available for each function in each direction of travel.

+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/sphinx/build/html/other/getting_started.html b/docs/sphinx/build/html/other/getting_started.html new file mode 100644 index 0000000..172cce9 --- /dev/null +++ b/docs/sphinx/build/html/other/getting_started.html @@ -0,0 +1,212 @@ + + + + + + + + + Getting started — RP2040-Decoder 0.3, 1.0 documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Getting started

+

In order to make use of this project, you will need the following:

+
    +
  • The RP2040-Decoder board itself

  • +
  • Raspberry Pi Pico or another multi-drop SWD debug interfaces might work as well

  • +
  • Micro-USB cable

  • +
+
+

1. Where to get the board?

+

You can of course choose any preferred PCB manufacturer, the PCB is designed to be compliant with JLCPCB.com 2 layer board capabilities (hole diameter/clearence/etc.). Regarding assembly, you can of course assemble the board yourself but I would not recommend it (especially the RP2040 QFN Package is not easy to solder). Alternatively you can order the board fully or partly assembled. All parts are normally available at LCSC.com who supply parts to JLCPCB.com.

+
+
+

2. Production files?

+

In order to generate export the production files (Gerber/BOM/Pick and Place) you need KiCad 6 which is open source. +How to do this?

+
+
+

3. Building and flashing

+

To build the software and run it on the Controller we need to interface the RP2040 using Serial Wire Debug. This can be done using a Raspberry Pi Pico board.

+
+

Windows

+
    +
  1. Connect Raspberry Pi Pico via USB while holding the reset button. Your Pi Pico should now be visible in Windows explorer as a mass storage device.

  2. +
  3. Download the latest prebuilt “picoprobe.uf2” release binary from here or download it from the Raspberry Pi Website.

  4. +
  5. Copy “picoprobe.uf2” to your Pi Pico. The Pi Pico onboard LED should now light up.

  6. +
  7. Connect GND to GND, GPIO2 to SWCLK, GPIO3 to SWDIO, VBUS to +V, as shown in the picture below . +

  8. +
  9. Download and install Pico setup for Windows

  10. +
  11. Download and install MSYS2

  12. +
  13. Open a MSYS2 MINGW64 shell window

  14. +
  15. Update all pacman packages

  16. +
+
pacman -Syu
+
+
+
    +
  1. Install mingw-w64-x86_64-toolchain (choose to install all)

  2. +
+
pacman -S mingw-w64-x86_64-toolchain
+
+
+
    +
  1. Add “C:\msys64\mingw64\bin” to your users PATH environment variable. If you have choosen to not use the default directory for MSYS2 add the one you have choosen. How to do this?

  2. +
  3. Open the Pico - Developer Powershell

  4. +
  5. Navigate to a folder you like and clone the project repository

  6. +
+
git clone https://github.com/gab-k/RP2040-Decoder
+
+
+
    +
  1. Enter cloned repository, create and enter build directory

  2. +
+
cd RP2040-Decoder
+mkdir build
+cd build
+
+
+
    +
  1. Run CMake and the mingw32-make to build

  2. +
+
cmake -G "MinGW Makefiles" -DCMAKE_BUILD_TYPE=Debug ..
+mingw32
+
+
+
    +
  1. Flash the decoders software using openocd

  2. +
+
openocd -f interface/cmsis-dap.cfg -f target/rp2040.cfg -c "adapter speed 5000" -c"program rp2040-decoder.elf verify reset exit"
+
+
+
+
+

Other OS

+

The first four steps are identical to the steps described above for windows users. Regarding building and flashing, please refer to Getting started - Pico. Chapter 3 & 5 and Appendix A are the most relevant but you might also refer to chapter 9.1 if you are using macOS.

+
+
+
+

4. Wiring and initial startup

+ +

The illustration above shows an example wiring configuration, you can connect up to 4 outputs(up to 400mA) and 6 GPIOs for lighter loads or custom applications. A Free-wheeling diode should be used when switching inductive loads!

+

Another important note is that when the decoder is put into operation for the first time, it automatically performs a motor calibration, which is required for feedforward control. The calibration takes about one to two minutes.

+
+
+

5. If it’s not working as expected

+
    +
  1. Follow the Troubleshooting instructions

  2. +
  3. If you still have trouble create a new discussion or issue and describe your question/issue.

  4. +
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/sphinx/build/html/other/troubleshooting.html b/docs/sphinx/build/html/other/troubleshooting.html new file mode 100644 index 0000000..0aa3f4e --- /dev/null +++ b/docs/sphinx/build/html/other/troubleshooting.html @@ -0,0 +1,126 @@ + + + + + + + + + Troubleshooting — RP2040-Decoder 0.3, 1.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Troubleshooting

+

To narrow down the issue when your decoder is not working as expected, you can do the following:

+

Check the power supply of the decoder:

+
    +
  • +3V3 to GND should be 3.3V

  • +
  • +V to GND should be somewhere in the range of around +10V to +20V

  • +
  • If you dont measure the correct voltages, try to measure Track Voltage

  • +
+

Check your motor:

+
    +
  • Desolder your motor and try the motor with a analog power supply 0…+-16V to check if the motor is working or not (desolder the wires because the decoder doesn’t like voltage on these pins!)

  • +
+

Reset:

+
    +
  • Try to reset the decoder by writing a value of 8 to CV8 (beware, this will reset the complete CV memory!)

  • +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/sphinx/build/html/search.html b/docs/sphinx/build/html/search.html new file mode 100644 index 0000000..daf91a3 --- /dev/null +++ b/docs/sphinx/build/html/search.html @@ -0,0 +1,124 @@ + + + + + + + + Search — RP2040-Decoder 0.3, 1.0 documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + + + +
+ +
+ +
+
+
+ +
+ +
+

© Copyright 2024, Gabriel Koppenstein.

+
+ + Built with Sphinx using a + theme + provided by Read the Docs. + + +
+
+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/docs/sphinx/build/html/searchindex.js b/docs/sphinx/build/html/searchindex.js new file mode 100644 index 0000000..3a0db60 --- /dev/null +++ b/docs/sphinx/build/html/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({"alltitles": {"1. Where to get the board?": [[5, "where-to-get-the-board"]], "2. Production files?": [[5, "production-files"]], "3. Building and flashing": [[5, "building-and-flashing"]], "4. Wiring and initial startup": [[5, "wiring-and-initial-startup"]], "5. If it\u2019s not working as expected": [[5, "if-it-s-not-working-as-expected"]], "Alternative for HT7533S:": [[1, "alternative-for-ht7533s"]], "Alternatives for BDR6133:": [[1, "alternatives-for-bdr6133"]], "Auxiliary Output": [[1, "auxiliary-output"]], "Auxillary Output": [[2, "auxillary-output"]], "BOM": [[1, "id2"]], "BOM & Alternative Parts": [[1, "bom-alternative-parts"], [2, "bom-alternative-parts"]], "Back-EMF voltage measurement": [[9, "back-emf-voltage-measurement"]], "CV List": [[4, "cv-list"]], "CV.h": [[7, "cv-h"]], "CV_1 - Basic address": [[4, "cv-1-basic-address"]], "CV_11 - Packet timeout": [[4, "cv-11-packet-timeout"]], "CV_112, CV_113, CV_114, CV_115 - GPIO PWM Configuration": [[4, "cv-112-cv-113-cv-114-cv-115-gpio-pwm-configuration"]], "CV_116 to CV_171 - PWM Slice configuration": [[4, "cv-116-to-cv-171-pwm-slice-configuration"]], "CV_12 - Permitted operating modes": [[4, "cv-12-permitted-operating-modes"]], "CV_17 & CV_18 - 14-Bit extended/long address": [[4, "cv-17-cv-18-14-bit-extended-long-address"]], "CV_172 - ADC Offset": [[4, "cv-172-adc-offset"]], "CV_173 - ADC offset measurement cycles": [[4, "cv-173-adc-offset-measurement-cycles"]], "CV_174 - Additional motor-PWM clock divider.": [[4, "cv-174-additional-motor-pwm-clock-divider"]], "CV_175 - speed_helper timer delay": [[4, "cv-175-speed-helper-timer-delay"]], "CV_176, CV_177, CV_178, CV_179 - Base PWM Level used in feed-forward control": [[4, "cv-176-cv-177-cv-178-cv-179-base-pwm-level-used-in-feed-forward-control"]], "CV_2 - V_min": [[4, "cv-2-v-min"]], "CV_257 to CV_512 - Function Mapping CVs": [[4, "cv-257-to-cv-512-function-mapping-cvs"]], "CV_29 - Decoder Configuration": [[4, "cv-29-decoder-configuration"]], "CV_3 - Acceleration rate": [[4, "cv-3-acceleration-rate"]], "CV_31 & CV_32 - Extended CV pointer (Read-Only)": [[4, "cv-31-cv-32-extended-cv-pointer-read-only"]], "CV_4 - Deceleration rate": [[4, "cv-4-deceleration-rate"]], "CV_47 - Feed-forward gain k_ff": [[4, "cv-47-feed-forward-gain-k-ff"]], "CV_48 - Filter time constant (tau) in ms": [[4, "cv-48-filter-time-constant-tau-in-ms"]], "CV_49 - PID Control sampling time t in ms": [[4, "cv-49-pid-control-sampling-time-t-in-ms"]], "CV_5 - V_max": [[4, "cv-5-v-max"]], "CV_50 - PID Control I Factor": [[4, "cv-50-pid-control-i-factor"]], "CV_51 - PID Control D Factor": [[4, "cv-51-pid-control-d-factor"]], "CV_52 & CV_53 - PID Integral Limits": [[4, "cv-52-cv-53-pid-integral-limits"]], "CV_54 & CV_55 - Gain scheduling config k_p @ x0": [[4, "cv-54-cv-55-gain-scheduling-config-k-p-x0"]], "CV_56 & CV_57 - Gain scheduling config k_p @ x1": [[4, "cv-56-cv-57-gain-scheduling-config-k-p-x1"]], "CV_58 & CV_59 - Gain scheduling config k_p @ x2": [[4, "cv-58-cv-59-gain-scheduling-config-k-p-x2"]], "CV_6 - V_mid": [[4, "cv-6-v-mid"]], "CV_60 - Gain scheduling config x1 shift percentage": [[4, "cv-60-gain-scheduling-config-x1-shift-percentage"]], "CV_61 - Measurement Iterations": [[4, "cv-61-measurement-iterations"]], "CV_62 - Measurement Delay": [[4, "cv-62-measurement-delay"]], "CV_63 & CV_64 - Measurement array cutoffs": [[4, "cv-63-cv-64-measurement-array-cutoffs"]], "CV_65 - New flash variable": [[4, "cv-65-new-flash-variable"]], "CV_7 - Version No. (Read-Only)": [[4, "cv-7-version-no-read-only"]], "CV_8 - Manufacturer (Read-Only)": [[4, "cv-8-manufacturer-read-only"]], "CV_9 - Motor PWM Frequency": [[4, "cv-9-motor-pwm-frequency"]], "Characteristics": [[1, "characteristics"], [2, "characteristics"]], "Characteristics table": [[1, "id1"]], "Complete Schematic": [[1, "complete-schematic"], [2, "complete-schematic"]], "Configuration Variables (CV)": [[4, null]], "Contents:": [[0, null], [3, null], [8, null]], "DCC signal decoding": [[9, "dcc-signal-decoding"]], "Feed-forward": [[9, "feed-forward"]], "GPIO": [[1, "gpio"], [2, "gpio"]], "Gain scheduling": [[9, "gain-scheduling"]], "Getting started": [[5, null]], "Hardware": [[0, null]], "Hardware Description": [[1, null], [2, null]], "Header files": [[7, null]], "Input Stage": [[1, "input-stage"], [2, "input-stage"]], "Microcontroller": [[1, "microcontroller"], [2, "microcontroller"]], "Motor Driver": [[1, "motor-driver"], [2, "motor-driver"]], "Motor control overview": [[9, "motor-control-overview"]], "Note": [[4, "note"]], "Other OS": [[5, "other-os"]], "Overview": [[1, "overview"], [2, "overview"], [9, "overview"]], "PID Controller": [[9, "pid-controller"]], "RP2040-Decoder Documentation": [[3, null]], "Software": [[8, null]], "Software Description": [[9, null]], "Speed step configuration": [[4, "speed-step-configuration"]], "Troubleshooting": [[6, null]], "Windows": [[5, "windows"]], "core0.h": [[7, "core0-h"]], "core1.h": [[7, "core1-h"]], "shared.h": [[7, "shared-h"]]}, "docnames": ["hardware/hw", "hardware/hw_description", "hardware/hw_description_md", "index", "other/CV_list", "other/getting_started", "other/troubleshooting", "software/header_files", "software/sw", "software/sw_description"], "envversion": {"sphinx": 64, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2}, "filenames": ["hardware/hw.rst", "hardware/hw_description.rst", "hardware/hw_description_md.md", "index.rst", "other/CV_list.md", "other/getting_started.md", "other/troubleshooting.md", "software/header_files.rst", "software/sw.rst", "software/sw_description.md"], "indexentries": {"_125m (c macro)": [[7, "c._125M", false]], "acknowledge (c++ function)": [[7, "_CPPv411acknowledgev", false]], "adc_offset_adjustment (c++ function)": [[7, "_CPPv421adc_offset_adjustment8uint32_t", false]], "address_evaluation (c++ function)": [[7, "_CPPv418address_evaluation7uint8_tA_K7uint8_t", false]], "adjust_pwm_level (c++ function)": [[7, "_CPPv416adjust_pwm_level8uint16_t", false]], "base_pwm_arr_len (c macro)": [[7, "c.BASE_PWM_ARR_LEN", false]], "bits_to_byte_array (c++ function)": [[7, "_CPPv418bits_to_byte_array6int8_tA_7uint8_t", false]], "clr_bit_arr (c++ member)": [[7, "_CPPv411clr_bit_arr", false]], "controller_general (c++ function)": [[7, "_CPPv418controller_generalP15repeating_timer", false]], "controller_mode_t (c++ enum)": [[7, "_CPPv417controller_mode_t", false]], "controller_mode_t::pid_mode (c++ enumerator)": [[7, "_CPPv4N17controller_mode_t8PID_MODEE", false]], "controller_mode_t::startup_mode (c++ enumerator)": [[7, "_CPPv4N17controller_mode_t12STARTUP_MODEE", false]], "controller_parameter_t (c++ struct)": [[7, "_CPPv422controller_parameter_t", false]], "controller_parameter_t (c++ type)": [[7, "_CPPv422controller_parameter_t", false]], "controller_parameter_t::adc_offset (c++ member)": [[7, "_CPPv4N22controller_parameter_t10adc_offsetE", false]], "controller_parameter_t::feed_fwd (c++ member)": [[7, "_CPPv4N22controller_parameter_t8feed_fwdE", false]], "controller_parameter_t::l_side_arr_cutoff (c++ member)": [[7, "_CPPv4N22controller_parameter_t17l_side_arr_cutoffE", false]], "controller_parameter_t::measurement (c++ member)": [[7, "_CPPv4N22controller_parameter_t11measurementE", false]], "controller_parameter_t::measurement_corrected (c++ member)": [[7, "_CPPv4N22controller_parameter_t21measurement_correctedE", false]], "controller_parameter_t::measurement_prev (c++ member)": [[7, "_CPPv4N22controller_parameter_t16measurement_prevE", false]], "controller_parameter_t::mode (c++ member)": [[7, "_CPPv4N22controller_parameter_t4modeE", false]], "controller_parameter_t::msr_delay_in_us (c++ member)": [[7, "_CPPv4N22controller_parameter_t15msr_delay_in_usE", false]], "controller_parameter_t::msr_total_iterations (c++ member)": [[7, "_CPPv4N22controller_parameter_t20msr_total_iterationsE", false]], "controller_parameter_t::pid (c++ member)": [[7, "_CPPv4N22controller_parameter_t3pidE", false]], "controller_parameter_t::r_side_arr_cutoff (c++ member)": [[7, "_CPPv4N22controller_parameter_t17r_side_arr_cutoffE", false]], "controller_parameter_t::setpoint (c++ member)": [[7, "_CPPv4N22controller_parameter_t8setpointE", false]], "controller_parameter_t::speed_table (c++ member)": [[7, "_CPPv4N22controller_parameter_t11speed_tableE", false]], "controller_parameter_t::startup (c++ member)": [[7, "_CPPv4N22controller_parameter_t7startupE", false]], "controller_startup_mode (c++ function)": [[7, "_CPPv423controller_startup_modeP22controller_parameter_t", false]], "core1_entry (c++ function)": [[7, "_CPPv411core1_entryv", false]], "cv_array_flash (c++ member)": [[7, "_CPPv414CV_ARRAY_FLASH", false]], "cv_array_size (c macro)": [[7, "c.CV_ARRAY_SIZE", false]], "cv_setup_check (c++ function)": [[7, "_CPPv414cv_setup_checkv", false]], "dcc_input_pin (c macro)": [[7, "c.DCC_INPUT_PIN", false]], "error_detection (c++ function)": [[7, "_CPPv415error_detection6int8_tPK7uint8_t", false]], "evaluate_message (c++ function)": [[7, "_CPPv416evaluate_messagev", false]], "flash_target_offset (c macro)": [[7, "c.FLASH_TARGET_OFFSET", false]], "fwd_v_emf_adc_pin (c macro)": [[7, "c.FWD_V_EMF_ADC_PIN", false]], "get_16bit_cv (c++ function)": [[7, "_CPPv412get_16bit_CV8uint16_t", false]], "get_32bit_cv (c++ function)": [[7, "_CPPv412get_32bit_CV8uint16_t", false]], "get_direction_of_speed_step (c++ function)": [[7, "_CPPv427get_direction_of_speed_step7uint8_t", false]], "get_initial_level (c++ function)": [[7, "_CPPv417get_initial_levelP22controller_parameter_t", false]], "get_kp (c++ function)": [[7, "_CPPv46get_kpPK22controller_parameter_t", false]], "get_speed_step_table_index_of_speed_step (c++ function)": [[7, "_CPPv440get_speed_step_table_index_of_speed_step7uint8_t", false]], "gpio_allowed_outputs (c macro)": [[7, "c.GPIO_ALLOWED_OUTPUTS", false]], "gpio_illegal_mask (c macro)": [[7, "c.GPIO_ILLEGAL_MASK", false]], "gpio_output_pin_mask (c macro)": [[7, "c.GPIO_OUTPUT_PIN_MASK", false]], "init_adc (c++ function)": [[7, "_CPPv48init_adcv", false]], "init_controller (c++ function)": [[7, "_CPPv415init_controllerP22controller_parameter_t", false]], "init_motor_pwm (c++ function)": [[7, "_CPPv414init_motor_pwm7uint8_t", false]], "init_outputs (c++ function)": [[7, "_CPPv412init_outputsv", false]], "instruction_evaluation (c++ function)": [[7, "_CPPv422instruction_evaluation7uint8_tA_K7uint8_t", false]], "is_long_address (c++ function)": [[7, "_CPPv415is_long_address7uint8_tA_K7uint8_t", false]], "log (c macro)": [[7, "c.LOG", false]], "loglevel (c macro)": [[7, "c.LOGLEVEL", false]], "measure (c++ function)": [[7, "_CPPv47measure7uint8_t7uint8_t7uint8_t7uint8_tb", false]], "message_3_bytes (c macro)": [[7, "c.MESSAGE_3_BYTES", false]], "message_4_bytes (c macro)": [[7, "c.MESSAGE_4_BYTES", false]], "message_5_bytes (c macro)": [[7, "c.MESSAGE_5_BYTES", false]], "message_mask_3_bytes (c macro)": [[7, "c.MESSAGE_MASK_3_BYTES", false]], "message_mask_4_bytes (c macro)": [[7, "c.MESSAGE_MASK_4_BYTES", false]], "message_mask_5_bytes (c macro)": [[7, "c.MESSAGE_MASK_5_BYTES", false]], "motor_fwd_pin (c macro)": [[7, "c.MOTOR_FWD_PIN", false]], "motor_rev_pin (c macro)": [[7, "c.MOTOR_REV_PIN", false]], "pid_control_timer (c++ member)": [[7, "_CPPv417pid_control_timer", false]], "pid_parameter_t (c++ type)": [[7, "_CPPv415pid_parameter_t", false]], "pid_parameters_t (c++ struct)": [[7, "_CPPv416pid_parameters_t", false]], "pid_parameters_t::cd_0 (c++ member)": [[7, "_CPPv4N16pid_parameters_t4cd_0E", false]], "pid_parameters_t::cd_1 (c++ member)": [[7, "_CPPv4N16pid_parameters_t4cd_1E", false]], "pid_parameters_t::ci_0 (c++ member)": [[7, "_CPPv4N16pid_parameters_t4ci_0E", false]], "pid_parameters_t::d_prev (c++ member)": [[7, "_CPPv4N16pid_parameters_t6d_prevE", false]], "pid_parameters_t::e (c++ member)": [[7, "_CPPv4N16pid_parameters_t1eE", false]], "pid_parameters_t::e_prev (c++ member)": [[7, "_CPPv4N16pid_parameters_t6e_prevE", false]], "pid_parameters_t::i_prev (c++ member)": [[7, "_CPPv4N16pid_parameters_t6i_prevE", false]], "pid_parameters_t::int_lim_max (c++ member)": [[7, "_CPPv4N16pid_parameters_t11int_lim_maxE", false]], "pid_parameters_t::int_lim_min (c++ member)": [[7, "_CPPv4N16pid_parameters_t11int_lim_minE", false]], "pid_parameters_t::k_d (c++ member)": [[7, "_CPPv4N16pid_parameters_t3k_dE", false]], "pid_parameters_t::k_i (c++ member)": [[7, "_CPPv4N16pid_parameters_t3k_iE", false]], "pid_parameters_t::k_p (c++ member)": [[7, "_CPPv4N16pid_parameters_t3k_pE", false]], "pid_parameters_t::k_p_m_1 (c++ member)": [[7, "_CPPv4N16pid_parameters_t7k_p_m_1E", false]], "pid_parameters_t::k_p_m_2 (c++ member)": [[7, "_CPPv4N16pid_parameters_t7k_p_m_2E", false]], "pid_parameters_t::k_p_x_1 (c++ member)": [[7, "_CPPv4N16pid_parameters_t7k_p_x_1E", false]], "pid_parameters_t::k_p_x_1_shift (c++ member)": [[7, "_CPPv4N16pid_parameters_t13k_p_x_1_shiftE", false]], "pid_parameters_t::k_p_x_2 (c++ member)": [[7, "_CPPv4N16pid_parameters_t7k_p_x_2E", false]], "pid_parameters_t::k_p_y_0 (c++ member)": [[7, "_CPPv4N16pid_parameters_t7k_p_y_0E", false]], "pid_parameters_t::k_p_y_1 (c++ member)": [[7, "_CPPv4N16pid_parameters_t7k_p_y_1E", false]], "pid_parameters_t::k_p_y_2 (c++ member)": [[7, "_CPPv4N16pid_parameters_t7k_p_y_2E", false]], "pid_parameters_t::max_output (c++ member)": [[7, "_CPPv4N16pid_parameters_t10max_outputE", false]], "pid_parameters_t::t (c++ member)": [[7, "_CPPv4N16pid_parameters_t1tE", false]], "pid_parameters_t::tau (c++ member)": [[7, "_CPPv4N16pid_parameters_t3tauE", false]], "program_mode (c++ function)": [[7, "_CPPv412program_mode7uint8_tA_K7uint8_t", false]], "reset_message_check (c++ function)": [[7, "_CPPv419reset_message_check7uint8_tPCK7uint8_t", false]], "rev_v_emf_adc_pin (c macro)": [[7, "c.REV_V_EMF_ADC_PIN", false]], "set_outputs (c++ function)": [[7, "_CPPv411set_outputs8uint32_t", false]], "size_byte_array (c macro)": [[7, "c.SIZE_BYTE_ARRAY", false]], "speed_helper (c++ function)": [[7, "_CPPv412speed_helperP15repeating_timer", false]], "speed_helper_timer (c++ member)": [[7, "_CPPv418speed_helper_timer", false]], "speed_step_target (c++ member)": [[7, "_CPPv417speed_step_target", false]], "speed_step_target_prev (c++ member)": [[7, "_CPPv422speed_step_target_prev", false]], "startup_parameters_t (c++ struct)": [[7, "_CPPv420startup_parameters_t", false]], "startup_parameters_t (c++ type)": [[7, "_CPPv420startup_parameters_t", false]], "startup_parameters_t::base_pwm_arr (c++ member)": [[7, "_CPPv4N20startup_parameters_t12base_pwm_arrE", false]], "startup_parameters_t::base_pwm_arr_i (c++ member)": [[7, "_CPPv4N20startup_parameters_t14base_pwm_arr_iE", false]], "startup_parameters_t::level (c++ member)": [[7, "_CPPv4N20startup_parameters_t5levelE", false]], "track_signal_fall (c++ function)": [[7, "_CPPv417track_signal_falljm", false]], "track_signal_rise (c++ function)": [[7, "_CPPv417track_signal_risejm", false]], "two_std_dev (c++ function)": [[7, "_CPPv411two_std_devA_Kf8uint32_t", false]], "update_active_functions (c++ function)": [[7, "_CPPv423update_active_functions8uint32_t7uint8_tb", false]], "verify_cv_bit (c++ function)": [[7, "_CPPv413verify_cv_bit8uint16_tb7uint8_t", false]], "verify_cv_byte (c++ function)": [[7, "_CPPv414verify_cv_byte8uint16_t7uint8_t", false]], "verify_dcc_message (c++ function)": [[7, "_CPPv418verify_dcc_messagev", false]], "write_cv_byte (c++ function)": [[7, "_CPPv413write_cv_byte8uint16_t7uint8_t", false]], "write_cv_handler (c++ function)": [[7, "_CPPv416write_cv_handler8uint16_t7uint8_t", false]]}, "objects": {"": [[7, 0, 1, "c.BASE_PWM_ARR_LEN", "BASE_PWM_ARR_LEN"], [7, 0, 1, "c.CV_ARRAY_SIZE", "CV_ARRAY_SIZE"], [7, 0, 1, "c.DCC_INPUT_PIN", "DCC_INPUT_PIN"], [7, 0, 1, "c.FLASH_TARGET_OFFSET", "FLASH_TARGET_OFFSET"], [7, 0, 1, "c.FWD_V_EMF_ADC_PIN", "FWD_V_EMF_ADC_PIN"], [7, 0, 1, "c.GPIO_ALLOWED_OUTPUTS", "GPIO_ALLOWED_OUTPUTS"], [7, 0, 1, "c.GPIO_ILLEGAL_MASK", "GPIO_ILLEGAL_MASK"], [7, 0, 1, "c.GPIO_OUTPUT_PIN_MASK", "GPIO_OUTPUT_PIN_MASK"], [7, 0, 1, "c.LOG", "LOG"], [7, 0, 1, "c.LOGLEVEL", "LOGLEVEL"], [7, 0, 1, "c.MESSAGE_3_BYTES", "MESSAGE_3_BYTES"], [7, 0, 1, "c.MESSAGE_4_BYTES", "MESSAGE_4_BYTES"], [7, 0, 1, "c.MESSAGE_5_BYTES", "MESSAGE_5_BYTES"], [7, 0, 1, "c.MESSAGE_MASK_3_BYTES", "MESSAGE_MASK_3_BYTES"], [7, 0, 1, "c.MESSAGE_MASK_4_BYTES", "MESSAGE_MASK_4_BYTES"], [7, 0, 1, "c.MESSAGE_MASK_5_BYTES", "MESSAGE_MASK_5_BYTES"], [7, 0, 1, "c.MOTOR_FWD_PIN", "MOTOR_FWD_PIN"], [7, 0, 1, "c.MOTOR_REV_PIN", "MOTOR_REV_PIN"], [7, 0, 1, "c.REV_V_EMF_ADC_PIN", "REV_V_EMF_ADC_PIN"], [7, 0, 1, "c.SIZE_BYTE_ARRAY", "SIZE_BYTE_ARRAY"], [7, 0, 1, "c._125M", "_125M"], [7, 1, 1, "_CPPv414CV_ARRAY_FLASH", "CV_ARRAY_FLASH"], [7, 2, 1, "_CPPv4N17controller_mode_t8PID_MODEE", "PID_MODE"], [7, 2, 1, "_CPPv4N17controller_mode_t12STARTUP_MODEE", "STARTUP_MODE"], [7, 3, 1, "_CPPv411acknowledgev", "acknowledge"], [7, 3, 1, "_CPPv421adc_offset_adjustment8uint32_t", "adc_offset_adjustment"], [7, 4, 1, "_CPPv421adc_offset_adjustment8uint32_t", "adc_offset_adjustment::n"], [7, 3, 1, "_CPPv418address_evaluation7uint8_tA_K7uint8_t", "address_evaluation"], [7, 4, 1, "_CPPv418address_evaluation7uint8_tA_K7uint8_t", "address_evaluation::byte_array"], [7, 4, 1, "_CPPv418address_evaluation7uint8_tA_K7uint8_t", "address_evaluation::number_of_bytes"], [7, 3, 1, "_CPPv416adjust_pwm_level8uint16_t", "adjust_pwm_level"], [7, 4, 1, "_CPPv416adjust_pwm_level8uint16_t", "adjust_pwm_level::level"], [7, 3, 1, "_CPPv418bits_to_byte_array6int8_tA_7uint8_t", "bits_to_byte_array"], [7, 4, 1, "_CPPv418bits_to_byte_array6int8_tA_7uint8_t", "bits_to_byte_array::byte_array"], [7, 4, 1, "_CPPv418bits_to_byte_array6int8_tA_7uint8_t", "bits_to_byte_array::number_of_bytes"], [7, 1, 1, "_CPPv411clr_bit_arr", "clr_bit_arr"], [7, 3, 1, "_CPPv418controller_generalP15repeating_timer", "controller_general"], [7, 4, 1, "_CPPv418controller_generalP15repeating_timer", "controller_general::t"], [7, 5, 1, "_CPPv417controller_mode_t", "controller_mode_t"], [7, 2, 1, "_CPPv4N17controller_mode_t8PID_MODEE", "controller_mode_t::PID_MODE"], [7, 2, 1, "_CPPv4N17controller_mode_t12STARTUP_MODEE", "controller_mode_t::STARTUP_MODE"], [7, 6, 1, "_CPPv422controller_parameter_t", "controller_parameter_t"], [7, 7, 1, "_CPPv422controller_parameter_t", "controller_parameter_t"], [7, 1, 1, "_CPPv4N22controller_parameter_t10adc_offsetE", "controller_parameter_t::adc_offset"], [7, 1, 1, "_CPPv4N22controller_parameter_t8feed_fwdE", "controller_parameter_t::feed_fwd"], [7, 1, 1, "_CPPv4N22controller_parameter_t17l_side_arr_cutoffE", "controller_parameter_t::l_side_arr_cutoff"], [7, 1, 1, "_CPPv4N22controller_parameter_t11measurementE", "controller_parameter_t::measurement"], [7, 1, 1, "_CPPv4N22controller_parameter_t21measurement_correctedE", "controller_parameter_t::measurement_corrected"], [7, 1, 1, "_CPPv4N22controller_parameter_t16measurement_prevE", "controller_parameter_t::measurement_prev"], [7, 1, 1, "_CPPv4N22controller_parameter_t4modeE", "controller_parameter_t::mode"], [7, 1, 1, "_CPPv4N22controller_parameter_t15msr_delay_in_usE", "controller_parameter_t::msr_delay_in_us"], [7, 1, 1, "_CPPv4N22controller_parameter_t20msr_total_iterationsE", "controller_parameter_t::msr_total_iterations"], [7, 1, 1, "_CPPv4N22controller_parameter_t3pidE", "controller_parameter_t::pid"], [7, 1, 1, "_CPPv4N22controller_parameter_t17r_side_arr_cutoffE", "controller_parameter_t::r_side_arr_cutoff"], [7, 1, 1, "_CPPv4N22controller_parameter_t8setpointE", "controller_parameter_t::setpoint"], [7, 1, 1, "_CPPv4N22controller_parameter_t11speed_tableE", "controller_parameter_t::speed_table"], [7, 1, 1, "_CPPv4N22controller_parameter_t7startupE", "controller_parameter_t::startup"], [7, 3, 1, "_CPPv423controller_startup_modeP22controller_parameter_t", "controller_startup_mode"], [7, 4, 1, "_CPPv423controller_startup_modeP22controller_parameter_t", "controller_startup_mode::ctrl_par"], [7, 3, 1, "_CPPv411core1_entryv", "core1_entry"], [7, 3, 1, "_CPPv414cv_setup_checkv", "cv_setup_check"], [7, 3, 1, "_CPPv415error_detection6int8_tPK7uint8_t", "error_detection"], [7, 4, 1, "_CPPv415error_detection6int8_tPK7uint8_t", "error_detection::byte_array"], [7, 4, 1, "_CPPv415error_detection6int8_tPK7uint8_t", "error_detection::number_of_bytes"], [7, 3, 1, "_CPPv416evaluate_messagev", "evaluate_message"], [7, 3, 1, "_CPPv412get_16bit_CV8uint16_t", "get_16bit_CV"], [7, 4, 1, "_CPPv412get_16bit_CV8uint16_t", "get_16bit_CV::CV_start_index"], [7, 3, 1, "_CPPv412get_32bit_CV8uint16_t", "get_32bit_CV"], [7, 4, 1, "_CPPv412get_32bit_CV8uint16_t", "get_32bit_CV::CV_start_index"], [7, 3, 1, "_CPPv427get_direction_of_speed_step7uint8_t", "get_direction_of_speed_step"], [7, 4, 1, "_CPPv427get_direction_of_speed_step7uint8_t", "get_direction_of_speed_step::speed_step"], [7, 3, 1, "_CPPv417get_initial_levelP22controller_parameter_t", "get_initial_level"], [7, 4, 1, "_CPPv417get_initial_levelP22controller_parameter_t", "get_initial_level::ctrl_par"], [7, 3, 1, "_CPPv46get_kpPK22controller_parameter_t", "get_kp"], [7, 4, 1, "_CPPv46get_kpPK22controller_parameter_t", "get_kp::ctrl_par"], [7, 3, 1, "_CPPv440get_speed_step_table_index_of_speed_step7uint8_t", "get_speed_step_table_index_of_speed_step"], [7, 4, 1, "_CPPv440get_speed_step_table_index_of_speed_step7uint8_t", "get_speed_step_table_index_of_speed_step::speed_step"], [7, 3, 1, "_CPPv48init_adcv", "init_adc"], [7, 3, 1, "_CPPv415init_controllerP22controller_parameter_t", "init_controller"], [7, 4, 1, "_CPPv415init_controllerP22controller_parameter_t", "init_controller::ctrl_par"], [7, 3, 1, "_CPPv414init_motor_pwm7uint8_t", "init_motor_pwm"], [7, 4, 1, "_CPPv414init_motor_pwm7uint8_t", "init_motor_pwm::gpio"], [7, 3, 1, "_CPPv412init_outputsv", "init_outputs"], [7, 3, 1, "_CPPv422instruction_evaluation7uint8_tA_K7uint8_t", "instruction_evaluation"], [7, 4, 1, "_CPPv422instruction_evaluation7uint8_tA_K7uint8_t", "instruction_evaluation::byte_array"], [7, 4, 1, "_CPPv422instruction_evaluation7uint8_tA_K7uint8_t", "instruction_evaluation::number_of_bytes"], [7, 3, 1, "_CPPv415is_long_address7uint8_tA_K7uint8_t", "is_long_address"], [7, 4, 1, "_CPPv415is_long_address7uint8_tA_K7uint8_t", "is_long_address::byte_array"], [7, 4, 1, "_CPPv415is_long_address7uint8_tA_K7uint8_t", "is_long_address::number_of_bytes"], [7, 3, 1, "_CPPv47measure7uint8_t7uint8_t7uint8_t7uint8_tb", "measure"], [7, 4, 1, "_CPPv47measure7uint8_t7uint8_t7uint8_t7uint8_tb", "measure::direction"], [7, 4, 1, "_CPPv47measure7uint8_t7uint8_t7uint8_t7uint8_tb", "measure::l_side_arr_cutoff"], [7, 4, 1, "_CPPv47measure7uint8_t7uint8_t7uint8_t7uint8_tb", "measure::measurement_delay_us"], [7, 4, 1, "_CPPv47measure7uint8_t7uint8_t7uint8_t7uint8_tb", "measure::r_side_arr_cutoff"], [7, 4, 1, "_CPPv47measure7uint8_t7uint8_t7uint8_t7uint8_tb", "measure::total_iterations"], [7, 1, 1, "_CPPv417pid_control_timer", "pid_control_timer"], [7, 7, 1, "_CPPv415pid_parameter_t", "pid_parameter_t"], [7, 6, 1, "_CPPv416pid_parameters_t", "pid_parameters_t"], [7, 1, 1, "_CPPv4N16pid_parameters_t4cd_0E", "pid_parameters_t::cd_0"], [7, 1, 1, "_CPPv4N16pid_parameters_t4cd_1E", "pid_parameters_t::cd_1"], [7, 1, 1, "_CPPv4N16pid_parameters_t4ci_0E", "pid_parameters_t::ci_0"], [7, 1, 1, "_CPPv4N16pid_parameters_t6d_prevE", "pid_parameters_t::d_prev"], [7, 1, 1, "_CPPv4N16pid_parameters_t1eE", "pid_parameters_t::e"], [7, 1, 1, "_CPPv4N16pid_parameters_t6e_prevE", "pid_parameters_t::e_prev"], [7, 1, 1, "_CPPv4N16pid_parameters_t6i_prevE", "pid_parameters_t::i_prev"], [7, 1, 1, "_CPPv4N16pid_parameters_t11int_lim_maxE", "pid_parameters_t::int_lim_max"], [7, 1, 1, "_CPPv4N16pid_parameters_t11int_lim_minE", "pid_parameters_t::int_lim_min"], [7, 1, 1, "_CPPv4N16pid_parameters_t3k_dE", "pid_parameters_t::k_d"], [7, 1, 1, "_CPPv4N16pid_parameters_t3k_iE", "pid_parameters_t::k_i"], [7, 1, 1, "_CPPv4N16pid_parameters_t3k_pE", "pid_parameters_t::k_p"], [7, 1, 1, "_CPPv4N16pid_parameters_t7k_p_m_1E", "pid_parameters_t::k_p_m_1"], [7, 1, 1, "_CPPv4N16pid_parameters_t7k_p_m_2E", "pid_parameters_t::k_p_m_2"], [7, 1, 1, "_CPPv4N16pid_parameters_t7k_p_x_1E", "pid_parameters_t::k_p_x_1"], [7, 1, 1, "_CPPv4N16pid_parameters_t13k_p_x_1_shiftE", "pid_parameters_t::k_p_x_1_shift"], [7, 1, 1, "_CPPv4N16pid_parameters_t7k_p_x_2E", "pid_parameters_t::k_p_x_2"], [7, 1, 1, "_CPPv4N16pid_parameters_t7k_p_y_0E", "pid_parameters_t::k_p_y_0"], [7, 1, 1, "_CPPv4N16pid_parameters_t7k_p_y_1E", "pid_parameters_t::k_p_y_1"], [7, 1, 1, "_CPPv4N16pid_parameters_t7k_p_y_2E", "pid_parameters_t::k_p_y_2"], [7, 1, 1, "_CPPv4N16pid_parameters_t10max_outputE", "pid_parameters_t::max_output"], [7, 1, 1, "_CPPv4N16pid_parameters_t1tE", "pid_parameters_t::t"], [7, 1, 1, "_CPPv4N16pid_parameters_t3tauE", "pid_parameters_t::tau"], [7, 3, 1, "_CPPv412program_mode7uint8_tA_K7uint8_t", "program_mode"], [7, 4, 1, "_CPPv412program_mode7uint8_tA_K7uint8_t", "program_mode::byte_array"], [7, 4, 1, "_CPPv412program_mode7uint8_tA_K7uint8_t", "program_mode::number_of_bytes"], [7, 3, 1, "_CPPv419reset_message_check7uint8_tPCK7uint8_t", "reset_message_check"], [7, 4, 1, "_CPPv419reset_message_check7uint8_tPCK7uint8_t", "reset_message_check::byte_array"], [7, 4, 1, "_CPPv419reset_message_check7uint8_tPCK7uint8_t", "reset_message_check::number_of_bytes"], [7, 3, 1, "_CPPv411set_outputs8uint32_t", "set_outputs"], [7, 4, 1, "_CPPv411set_outputs8uint32_t", "set_outputs::functions_to_set_bitmask"], [7, 3, 1, "_CPPv412speed_helperP15repeating_timer", "speed_helper"], [7, 4, 1, "_CPPv412speed_helperP15repeating_timer", "speed_helper::t"], [7, 1, 1, "_CPPv418speed_helper_timer", "speed_helper_timer"], [7, 1, 1, "_CPPv417speed_step_target", "speed_step_target"], [7, 1, 1, "_CPPv422speed_step_target_prev", "speed_step_target_prev"], [7, 6, 1, "_CPPv420startup_parameters_t", "startup_parameters_t"], [7, 7, 1, "_CPPv420startup_parameters_t", "startup_parameters_t"], [7, 1, 1, "_CPPv4N20startup_parameters_t12base_pwm_arrE", "startup_parameters_t::base_pwm_arr"], [7, 1, 1, "_CPPv4N20startup_parameters_t14base_pwm_arr_iE", "startup_parameters_t::base_pwm_arr_i"], [7, 1, 1, "_CPPv4N20startup_parameters_t5levelE", "startup_parameters_t::level"], [7, 3, 1, "_CPPv417track_signal_falljm", "track_signal_fall"], [7, 4, 1, "_CPPv417track_signal_falljm", "track_signal_fall::events"], [7, 4, 1, "_CPPv417track_signal_falljm", "track_signal_fall::gpio"], [7, 3, 1, "_CPPv417track_signal_risejm", "track_signal_rise"], [7, 4, 1, "_CPPv417track_signal_risejm", "track_signal_rise::events"], [7, 4, 1, "_CPPv417track_signal_risejm", "track_signal_rise::gpio"], [7, 3, 1, "_CPPv411two_std_devA_Kf8uint32_t", "two_std_dev"], [7, 4, 1, "_CPPv411two_std_devA_Kf8uint32_t", "two_std_dev::arr"], [7, 4, 1, "_CPPv411two_std_devA_Kf8uint32_t", "two_std_dev::length"], [7, 3, 1, "_CPPv423update_active_functions8uint32_t7uint8_tb", "update_active_functions"], [7, 4, 1, "_CPPv423update_active_functions8uint32_t7uint8_tb", "update_active_functions::clr_bit_ind"], [7, 4, 1, "_CPPv423update_active_functions8uint32_t7uint8_tb", "update_active_functions::direction_change"], [7, 4, 1, "_CPPv423update_active_functions8uint32_t7uint8_tb", "update_active_functions::new_function_bitmask"], [7, 3, 1, "_CPPv413verify_cv_bit8uint16_tb7uint8_t", "verify_cv_bit"], [7, 4, 1, "_CPPv413verify_cv_bit8uint16_tb7uint8_t", "verify_cv_bit::bit_pos"], [7, 4, 1, "_CPPv413verify_cv_bit8uint16_tb7uint8_t", "verify_cv_bit::bit_val"], [7, 4, 1, "_CPPv413verify_cv_bit8uint16_tb7uint8_t", "verify_cv_bit::cv_address"], [7, 3, 1, "_CPPv414verify_cv_byte8uint16_t7uint8_t", "verify_cv_byte"], [7, 4, 1, "_CPPv414verify_cv_byte8uint16_t7uint8_t", "verify_cv_byte::cv_address"], [7, 4, 1, "_CPPv414verify_cv_byte8uint16_t7uint8_t", "verify_cv_byte::cv_data"], [7, 3, 1, "_CPPv418verify_dcc_messagev", "verify_dcc_message"], [7, 3, 1, "_CPPv413write_cv_byte8uint16_t7uint8_t", "write_cv_byte"], [7, 4, 1, "_CPPv413write_cv_byte8uint16_t7uint8_t", "write_cv_byte::cv_address"], [7, 4, 1, "_CPPv413write_cv_byte8uint16_t7uint8_t", "write_cv_byte::cv_data"], [7, 3, 1, "_CPPv416write_cv_handler8uint16_t7uint8_t", "write_cv_handler"], [7, 4, 1, "_CPPv416write_cv_handler8uint16_t7uint8_t", "write_cv_handler::cv_data"], [7, 4, 1, "_CPPv416write_cv_handler8uint16_t7uint8_t", "write_cv_handler::cv_index"]]}, "objnames": {"0": ["c", "macro", "C macro"], "1": ["cpp", "member", "C++ member"], "2": ["cpp", "enumerator", "C++ enumerator"], "3": ["cpp", "function", "C++ function"], "4": ["cpp", "functionParam", "C++ function parameter"], "5": ["cpp", "enum", "C++ enum"], "6": ["cpp", "class", "C++ class"], "7": ["cpp", "type", "C++ type"]}, "objtypes": {"0": "c:macro", "1": "cpp:member", "2": "cpp:enumerator", "3": "cpp:function", "4": "cpp:functionParam", "5": "cpp:enum", "6": "cpp:class", "7": "cpp:type"}, "terms": {"": [1, 2, 3, 7, 9], "0": [1, 2, 4, 6, 7, 9], "000": 7, "0000": 7, "0001": 7, "001": 7, "0010": 7, "0011": [7, 9], "002": 7, "003": 7, "004": 7, "0100": 7, "0111": 7, "0603_1608metric": [1, 2], "0b00011111111111111111111111111111": 7, "0b11100000000111111111111111111111": 7, "0b11111111111000000001111111111111": 7, "0b11111111111111111110000111111111": 7, "0b11111111111111111111111000011111": 7, "0b11111111111111111111111111100000": 7, "0xff": 4, "1": [1, 2, 3, 4, 7, 9], "10": [1, 2, 4], "100": [4, 9], "1000": 7, "10000": 4, "1001": 4, "100111000100": 4, "100n": [1, 2], "100u": 9, "10khz": 4, "10u": [1, 2], "10v": 6, "10xx": 9, "110000": 4, "11000011010011": 4, "11000100": 4, "11010011": 4, "110x": 9, "1110": 7, "1111": [7, 9], "1249": 4, "12499": 4, "125": [4, 7], "12500": 4, "126": [4, 7], "127": 7, "128": [7, 9], "129": 7, "12mhz": [1, 2], "13": 4, "130": 7, "131": 7, "132": 7, "145": [1, 2], "155": [1, 2], "16": 4, "16bit": 4, "16v": 6, "192": 4, "1ep_7x7mm_p0": [1, 2], "1k": [1, 2], "2": [1, 2, 3, 4, 7, 9], "20": 4, "200": [1, 2], "20v": [1, 2, 6], "210": 7, "212": 7, "216": 7, "23": [1, 2], "231": 4, "25": [1, 2], "250": 4, "2500": 4, "254": 7, "255": [4, 7, 9], "25v": [1, 2], "269aa": [1, 2], "2a": [1, 2], "2k": 9, "2x2": [1, 2], "2\u00b5": 9, "2\u03c4": 9, "3": [1, 2, 3, 4, 6, 7], "32": 4, "33p": [1, 2], "33tr3": [1, 2], "35m": 9, "3m": 9, "3v": [1, 2, 6], "3v3": 6, "4": [1, 2, 3, 4, 7], "400": [1, 2], "400ma": [1, 2, 5], "40v": [1, 2], "4a": [1, 2], "4mm": [1, 2], "4pin_3": [1, 2], "5": [1, 2, 3, 4, 7], "50": [1, 2], "5000": 5, "56": [1, 2], "5i": 9, "5k": 9, "5mm": [1, 2], "6": [1, 2, 4, 5, 7], "60v": [1, 2], "64": [4, 9], "64mb": [1, 2], "6k8": [1, 2], "7": [4, 7], "8": [1, 2, 4, 6], "87u": 7, "87\u03bc": 9, "8a": [1, 2], "9": [5, 7, 9], "93": 9, "94": 9, "A": [1, 2, 4, 5, 9], "For": [1, 2, 4], "If": [3, 4, 6, 9], "In": [1, 2, 5, 9], "It": [4, 7, 9], "Not": 4, "On": 9, "TO": [1, 2], "That": 4, "The": [1, 2, 4, 5, 7, 9], "Then": 9, "These": 4, "To": [1, 2, 4, 5, 6, 9], "_125m": 7, "__in_flash": 7, "about": [1, 2, 5, 9], "abov": [1, 2, 4, 5, 9], "absolut": [1, 2], "abstract": 9, "acceler": 9, "access": 9, "accord": [1, 2, 7, 9], "achiev": [4, 9], "acknowledg": 7, "adapt": 5, "adc": [1, 2, 7, 9], "adc_avdd": [1, 2], "adc_emf_a": [1, 2], "adc_emf_b": [1, 2], "adc_offset": 7, "adc_offset_adjust": 7, "add": [5, 9], "addit": 9, "addition": 9, "address": [7, 9], "address_evalu": 7, "adjust": 4, "adjust_pwm_level": 7, "advis": 4, "after": 9, "afterward": 9, "algorithm": 9, "all": [4, 5, 7, 9], "allow": 7, "also": [1, 2, 4, 5, 7, 9], "altern": [0, 4, 5, 7], "although": [1, 2], "alwai": 4, "am": 4, "amount": [4, 7], "amplitud": [1, 2], "an": [4, 5, 9], "analog": 6, "ani": [4, 5, 9], "anoth": [4, 5, 9], "appendix": 5, "applic": 5, "ar": [1, 2, 4, 5, 7, 9], "around": 6, "arr": 7, "arrai": [7, 9], "aspect": 9, "assembl": 5, "assembli": 5, "assum": [1, 2], "automat": [4, 5, 9], "aux": [1, 2], "aux1": 4, "aux2": 4, "auxiliari": 0, "avail": [4, 5], "averag": [7, 9], "b": 4, "back": [1, 2], "base": [7, 9], "base_pwm_arr": 7, "base_pwm_arr_i": 7, "base_pwm_arr_len": 7, "bdr6133": [0, 2], "becaus": 6, "been": [1, 2], "begin": 4, "behavior": 4, "being": 9, "below": [1, 2, 5, 9], "bemf": 4, "better": [1, 2, 9], "between": [4, 7, 9], "bewar": 6, "bilinear": 9, "bin": [4, 5, 7], "binari": 5, "bit": [7, 9], "bit0": [4, 7], "bit1": 7, "bit14": 4, "bit15": 4, "bit5": 4, "bit6": 4, "bit7": 4, "bit_po": 7, "bit_val": 7, "bitmask": 7, "bits_to_byte_arrai": 7, "block": [1, 2, 7, 9], "blue": 4, "board": [3, 4], "bom": [0, 5], "bool": 7, "both": [4, 7, 9], "bridg": [1, 2], "buffer": 7, "build": 3, "button": 5, "byte": [4, 7, 9], "byte_arrai": 7, "c": [4, 5, 9], "c1": [1, 2], "c10": [1, 2], "c11": [1, 2], "c12": [1, 2], "c13": [1, 2], "c14": [1, 2], "c15": [1, 2], "c16": [1, 2], "c17": [1, 2], "c2": [1, 2], "c3": [1, 2], "c4": [1, 2], "c5": [1, 2], "c6": [1, 2], "c7": [1, 2], "c8": [1, 2], "c9": [1, 2], "cabl": 5, "calcul": [4, 7, 9], "calibr": [4, 5, 7, 9], "call": [4, 9], "callback": 7, "can": [1, 2, 4, 5, 6, 9], "capabl": 5, "capacitor": [1, 2], "cd": 5, "cd_0": 7, "cd_1": 7, "central": 9, "ceram": [1, 2], "certain": 9, "cfg": 5, "chang": [4, 9], "channel": [1, 2, 4], "chapter": [4, 5], "character": 4, "characterist": 0, "check": [4, 6, 7, 9], "chip": 4, "choos": 5, "choosen": 5, "ci_0": 7, "clear": 7, "clearenc": 5, "clk_div": 4, "clock": 7, "clone": 5, "clr_bit_arr": 7, "clr_bit_ind": 7, "cmake": 5, "cmsi": 5, "code": 9, "com": 5, "command": [7, 9], "commun": 9, "compar": 9, "complet": [0, 6, 7, 9], "compliant": 5, "compon": [1, 2, 4, 9], "comput": [4, 9], "condit": [4, 7], "conduct": [1, 2], "configur": [1, 2, 3, 5, 7, 9], "connect": [1, 2, 4, 5], "consid": 9, "const": 7, "consumpt": 7, "contain": [4, 9], "continu": 9, "control": [1, 2, 5, 7, 8], "controller_gener": 7, "controller_mode_t": 7, "controller_parameter_t": 7, "controller_startup_mod": 7, "conveni": 9, "copi": 5, "core": 7, "core0": [4, 8, 9], "core1": [8, 9], "core1_entri": 7, "correct": [4, 6, 9], "correspond": [4, 7, 9], "could": [1, 2], "counter": 7, "cours": 5, "creat": [5, 7], "critic": [1, 2], "crystal": [1, 2], "crystal_smd_3225": [1, 2], "ctrl_par": 7, "current": [1, 2, 4, 7, 9], "custom": 5, "cv": [3, 6, 8, 9], "cv112": 7, "cv115": 7, "cv257": 7, "cv512": 7, "cv8": [4, 6], "cv_112": 7, "cv_115": 7, "cv_116": 7, "cv_144": 4, "cv_145": 4, "cv_146": 4, "cv_149": 4, "cv_150": 4, "cv_171": 7, "cv_176": 9, "cv_179": 9, "cv_47": 9, "cv_54": 9, "cv_55": 9, "cv_56": 9, "cv_57": 9, "cv_58": 9, "cv_59": 9, "cv_60": 9, "cv_62": 9, "cv_63": 9, "cv_64": 9, "cv_7": 7, "cv_address": 7, "cv_array_default": 7, "cv_array_flash": 7, "cv_array_s": 7, "cv_data": 7, "cv_index": 7, "cv_setup_check": [4, 7], "cv_start_index": 7, "cycl": 9, "d": [1, 2, 7, 9], "d1": [1, 2], "d_prev": 7, "dap": 5, "datasheet": [1, 2, 4], "dc": [1, 2], "dcc": [1, 2, 4, 8], "dcc_input_pin": 7, "dcmake_build_typ": 5, "dd": [1, 2], "debug": 5, "dec": [4, 7], "deceler": 9, "decod": [5, 6, 8], "default": [4, 5, 7, 9], "default_cv_valu": 7, "defin": [4, 7], "definit": 7, "delai": 9, "depend": [4, 9], "deriv": [4, 9], "describ": [5, 9], "descript": [0, 3, 8], "design": 5, "desold": 6, "detail": [4, 9], "detect": [7, 9], "determin": 4, "develop": 5, "deviat": 7, "devic": 5, "diagram": [1, 2, 9], "diamet": 5, "differ": [7, 9], "digit": [4, 9], "diod": 5, "direct": [4, 7, 9], "direction_chang": 7, "directli": 9, "directori": 5, "disabl": [4, 7], "discard": 4, "discret": [4, 9], "discuss": 5, "dismiss": 9, "divid": [1, 2, 7], "do": [4, 5, 6], "document": 9, "doesn": [1, 6], "doesnt": 2, "domain": [4, 9], "done": [1, 2, 4, 5, 7, 9], "dont": 6, "down": 6, "download": 5, "downstream": 4, "driver": 0, "drop": 5, "dropout": [1, 2], "duti": [4, 9], "e": [1, 2, 4, 7, 9], "e_prev": 7, "each": 4, "easi": 5, "easier": 9, "edg": [7, 9], "effect": [1, 2, 4, 9], "either": 4, "element": [4, 7, 9], "elf": 5, "els": 9, "emerg": [4, 7], "emf": [1, 2], "enabl": [4, 7], "ensur": [1, 2], "enter": [5, 7], "enum": 7, "enumer": 7, "environ": 5, "equat": 9, "equival": [4, 9], "error": 9, "error_detect": 7, "especi": 5, "essenc": 9, "establish": 9, "etc": 5, "evalu": 7, "evaluate_messag": 7, "event": [7, 9], "everi": [4, 9], "everyth": 9, "exampl": [4, 5], "exce": [1, 2], "exclus": 7, "exist": 7, "exit": 5, "expans": 9, "expect": [3, 6], "explain": [1, 2, 9], "explan": [4, 9], "explor": 5, "export": 5, "extern": [1, 2], "f": [1, 2, 4, 5], "f0": [7, 9], "f1": 7, "f12": [7, 9], "f13": [7, 9], "f20": 7, "f21": 7, "f28": 7, "f29": 7, "f31": [7, 9], "f4": 7, "f5": 7, "f8": 7, "f9": 7, "factori": [4, 7], "fall": [7, 9], "fals": 7, "faster": 4, "favor": 9, "fed": 9, "feed_fwd": 7, "feedback": 9, "feedforward": 5, "few": 9, "fifo": 7, "file": [3, 8], "filter": [1, 2, 9], "first": 5, "flash": [1, 2, 3, 7], "flash_target_offset": 7, "float": 7, "folder": 5, "follow": [4, 5, 6, 7, 9], "footprint": [1, 2], "forth": 4, "forward": 7, "found": [4, 7, 9], "foundat": 9, "four": [1, 2, 4, 5], "free": 5, "frequenc": [7, 9], "from": [4, 5, 7, 9], "fulli": 5, "function": [1, 2, 7, 9], "functions_to_set_bitmask": 7, "furthermor": [1, 2], "fwd_v_emf_adc_pin": 7, "g": [1, 2, 5], "gab": 5, "gener": [1, 2, 5, 7], "gerber": 5, "get": [1, 2, 3, 4, 9], "get_16bit_cv": 7, "get_32bit_cv": 7, "get_absolute_tim": 7, "get_direction_of_speed_step": 7, "get_initial_level": 7, "get_kp": 7, "get_speed_step_table_index_of_speed_step": 7, "git": 5, "github": 5, "give": [1, 2], "gnd": [1, 2, 5, 6], "gpio": [0, 5, 7], "gpio0": [1, 2], "gpio2": 5, "gpio21": [1, 2], "gpio24": [1, 2], "gpio25": 4, "gpio27": [1, 2], "gpio3": 5, "gpio5": [1, 2], "gpio_allowed_output": 7, "gpio_illegal_mask": 7, "gpio_output_pin_mask": 7, "greater": [7, 9], "green": 4, "group": 9, "gs7533": [1, 2], "h": [1, 2, 4, 8, 9], "ha": [1, 2, 4, 9], "happen": 4, "hardwar": 3, "have": [4, 5, 9], "header": [3, 8], "headlight": 4, "helper": 9, "here": [4, 5], "high": [1, 2, 4, 9], "higher": 9, "highest": [4, 9], "hold": [1, 2, 5], "hole": 5, "hopefulli": 9, "how": [4, 5, 9], "ht7533": [0, 2], "http": 5, "hz": 4, "i": [1, 2, 5, 6, 7, 9], "i_prev": 7, "ic": [1, 2], "ident": 5, "ih": [1, 2], "il": [1, 2], "illustr": [1, 2, 4, 5, 9], "impact": 9, "implement": [1, 2, 9], "import": 5, "includ": 9, "inclus": 4, "increas": 7, "independ": 4, "index": 4, "indic": 4, "induct": 5, "init": 4, "init_adc": 7, "init_control": 7, "init_motor_pwm": 7, "init_output": 7, "initi": [3, 7], "input": [0, 7], "insert": 9, "instal": 5, "instead": 9, "instruct": [4, 5, 7, 9], "instruction_evalu": 7, "int": 7, "int8_t": 7, "int_lim_max": 7, "int_lim_min": 7, "interfac": 5, "intern": [1, 2], "interpret": 7, "interrupt": 7, "iovdd": 1, "iovdd_max": 2, "irq": 7, "irrelev": 4, "is_long_address": 7, "issu": [5, 6], "its": 2, "itself": [1, 2, 5], "jlcpcb": 5, "k": [5, 9], "k_d": 7, "k_i": 7, "k_p": 7, "k_p_m_1": 7, "k_p_m_2": 7, "k_p_x_1": 7, "k_p_x_1_shift": 7, "k_p_x_2": 7, "k_p_y_0": 7, "k_p_y_1": 7, "k_p_y_2": 7, "keep": [1, 2], "kicad": 5, "kmb24f": [1, 2], "l_side_arr_cutoff": 7, "larg": 9, "latest": [5, 7], "launch": 7, "layer": 5, "lcsc": 5, "lead": 4, "led": 5, "left": [4, 9], "leftmost": 9, "length": [7, 9], "less": 7, "level": [1, 2, 7, 9], "light": 5, "lighter": [1, 2, 5], "like": [5, 6], "limit": [1, 2], "list": 3, "load": [1, 2, 5, 9], "log": 7, "logic": 7, "loglevel": 7, "long": [1, 2, 7], "look": 9, "loop": 9, "low": [1, 2, 4, 9], "lowest": 9, "ma": [1, 2], "maco": 5, "made": [1, 2], "make": 5, "makefil": 5, "mani": 4, "manufactur": 5, "map": 7, "mass": 5, "match": 9, "max": [1, 2, 4, 9], "max_output": 7, "maximum": [1, 2, 4, 9], "mb": [1, 2], "mean": [1, 2, 4], "measur": [1, 2, 6, 7], "measurement_correct": 7, "measurement_delay_u": 7, "measurement_prev": 7, "member": 7, "memori": [1, 2, 6, 7], "mention": 4, "message_3_byt": 7, "message_4_byt": 7, "message_5_byt": 7, "message_mask_3_byt": 7, "message_mask_4_byt": 7, "message_mask_5_byt": 7, "mhz": 4, "micro": 5, "microcontrol": 0, "mid": 4, "might": 5, "min": [4, 9], "mind": [1, 2], "mingw": 5, "mingw32": 5, "mingw64": 5, "minimum": [1, 2, 4], "minut": 5, "mitig": 9, "mkdir": 5, "mode": [7, 9], "modifi": 9, "more": [4, 9], "mosfet": [1, 2], "most": 5, "motor": [0, 5, 6, 7, 8], "motor_fwd_pin": 7, "motor_rev_pin": 7, "movement": 7, "msr_delay_in_u": 7, "msr_total_iter": 7, "msys2": 5, "msys64": 5, "multi": 5, "n": [1, 2, 7, 9], "name": [1, 2], "narrow": 6, "navig": 5, "necessari": [1, 2], "need": [1, 2, 5, 9], "new": 5, "new_function_bitmask": 7, "nmra": [7, 9], "nois": 9, "none": 7, "normal": [4, 5, 7], "note": [1, 2, 3, 5, 9], "now": [5, 9], "number": 7, "number_of_byt": 7, "off": [1, 2], "offset": [7, 9], "often": 9, "onboard": 5, "one": [4, 5], "onli": [7, 9], "open": 5, "openocd": 5, "oper": [1, 2, 5], "option": 4, "order": [1, 2, 5, 7], "origin": 7, "oscil": [1, 2, 4], "other": 4, "otherwis": 4, "out": [1, 2, 9], "outlier": 9, "outlin": 7, "output": [0, 4, 5, 7, 9], "overview": [0, 8], "p": 9, "packag": [4, 5, 9], "pacman": 5, "pad": [1, 2], "paramet": [1, 2, 4, 7], "part": [0, 4, 5, 9], "partli": 5, "pass": [4, 9], "path": 5, "pcb": [1, 2, 5], "pend": 7, "percent": 4, "perform": 5, "period": 4, "persist": 7, "pi": [2, 5, 9], "pick": 5, "pico": 5, "picoprob": 5, "pictur": 5, "pid": [7, 8], "pid_control": 4, "pid_control_tim": 7, "pid_mod": 7, "pid_parameter_t": 7, "pid_parameters_t": 7, "pin": [1, 2, 6, 7], "place": 5, "pleas": 5, "point": [1, 2, 9], "pointer": 7, "posit": [4, 7], "possibl": 9, "potenti": [1, 2, 9], "power": 6, "powershel": 5, "prebuilt": 5, "prefer": 5, "prevent": 9, "procedur": [4, 7], "process": [1, 2], "product": 3, "program": [1, 2, 5, 7, 9], "program_mod": 7, "project": 5, "properli": [1, 2], "proport": 9, "provid": [1, 2, 9], "pt2476": [1, 2], "pt5126a": [1, 2], "public": [4, 7], "pull": [1, 2], "purpos": [1, 2], "put": [5, 7], "pwm": [7, 9], "q1": [1, 2], "q2": [1, 2], "q3": [1, 2], "q4": [1, 2], "q5": [1, 2], "qfn": [1, 2, 5], "quantiti": [1, 2], "question": 5, "r1": [1, 2], "r2": [1, 2], "r3": [1, 2], "r5": [1, 2], "r6": [1, 2], "r7": [1, 2], "r8": [1, 2], "r9": [1, 2], "r_side_arr_cutoff": 7, "rang": [4, 6], "raspberri": [2, 5, 9], "rate": 9, "rather": [1, 2], "rcn": 7, "reach": 9, "read": [7, 9], "realiz": 7, "receiv": [4, 9], "recommend": 5, "rectifi": [1, 2], "red": 4, "reduc": 9, "reed": [1, 2], "ref": [1, 2], "refer": [1, 2, 4, 5, 7], "regard": [1, 2, 4, 5, 9], "regist": 9, "regul": [1, 2], "releas": 5, "relev": 5, "remain": 9, "repeating_tim": 7, "repeating_timer_t": 7, "repositori": 5, "repres": 4, "represent": 9, "requir": 5, "reset": [4, 5, 6, 7], "reset_message_check": 7, "resistor": [1, 2], "respect": [1, 2, 4], "restor": 7, "result": 9, "return": 7, "rev": 4, "rev_v_emf_adc_pin": 7, "revers": [4, 7], "right": [1, 2, 4, 9], "rightmost": 9, "rise": [7, 9], "rm": [1, 2], "rp2040": [1, 2, 4, 5, 9], "run": [5, 7, 9], "same": 4, "sampl": 9, "save": 7, "schemat": 0, "sdk": 9, "second": 4, "section": [7, 9], "see": [4, 7], "sensit": 9, "serial": [2, 5], "servic": 7, "set": [4, 7, 9], "set_output": 7, "setpoint": [7, 9], "setup": [5, 7], "sever": 4, "share": 8, "shell": 5, "shift": [1, 2, 9], "short": 4, "should": [4, 5, 6], "show": [4, 5, 9], "shown": 5, "side": [1, 2, 4], "signal": [1, 2, 4, 7, 8], "singl": 7, "six": [1, 2], "size_byte_arrai": 7, "slow": 9, "so": [4, 9], "softwar": [3, 5], "soic": [1, 2], "solder": [1, 2, 5], "somewher": 6, "soon": [1, 2], "sort": 9, "sot": [1, 2], "sourc": 5, "specif": [1, 2, 7], "specifi": 7, "speed": [3, 5, 7, 9], "speed_help": [7, 9], "speed_helper_tim": 7, "speed_step": 7, "speed_step_target": 7, "speed_step_target_prev": 7, "speed_tabl": 7, "spike": 7, "squar": [1, 2], "stage": 0, "standard": [7, 9], "standard_dev": 7, "start": [1, 2, 3, 9], "startup": [3, 4, 7, 9], "startup_mod": 7, "startup_parameters_t": 7, "state": 4, "station": 7, "statu": 4, "step": [3, 5, 7, 9], "still": [4, 5], "stop": [4, 7], "storag": 5, "store": 9, "struct": 7, "structur": 9, "sub": 1, "subdivid": [1, 2], "suitabl": [1, 2], "suppli": [5, 6], "support": [4, 9], "swclk": 5, "swd": 5, "swdio": 5, "switch": [1, 2, 4, 5], "symbol": [1, 2], "system": 9, "syu": 5, "s\u03c4": 9, "t": [1, 6, 7, 9], "t2n7002bk": [1, 2], "take": [5, 9], "target": 5, "tau": 7, "th": [1, 2], "than": [7, 9], "thei": [1, 2], "them": [4, 9], "theoret": [1, 2], "therefor": [4, 9], "thi": [1, 2, 4, 5, 6, 7, 9], "threshold": 9, "time": [5, 7, 9], "timer": 7, "too": 4, "toolchain": 5, "total": [1, 2, 4], "total_iter": 7, "tp": [1, 2], "track": [6, 7, 9], "track_signal_fal": 7, "track_signal_ris": 7, "transform": 9, "transistor": [1, 2], "translat": [1, 2], "travel": 4, "trigger": [4, 7], "troubl": 5, "troubleshoot": [3, 5], "true": 7, "try": 6, "turn": [1, 2], "twice": 7, "two": [1, 2, 4, 5], "two_std_dev": 7, "type": [1, 2, 7], "typedef": 7, "u1": [1, 2], "u2": [1, 2], "u3": [1, 2], "u4": [1, 2], "uf2": 5, "uint16_t": 7, "uint32_t": 7, "uint8_t": 7, "understand": 9, "unit": [1, 2], "unsign": 7, "unus": 7, "up": [1, 2, 5], "updat": 5, "update_active_funct": 7, "us": [1, 2, 5, 7, 9], "usb": 5, "user": 5, "usual": 4, "v": [1, 2, 5, 6], "valid": [4, 7], "valu": [1, 2, 4, 6, 7, 9], "vari": 9, "variabl": [1, 2, 3, 5, 7, 9], "variou": 7, "vbu": 5, "verifi": [5, 7], "verify_cv_bit": 7, "verify_cv_byt": 7, "verify_dcc_messag": 7, "via": 5, "visibl": 5, "void": 7, "voltag": [1, 2, 4, 6], "w25q64jvssiq": [1, 2], "w64": 5, "wait": 9, "wave": [1, 2], "we": 5, "websit": 5, "well": [1, 2, 5, 9], "wheel": 5, "when": [1, 2, 4, 5, 6, 7, 9], "where": 3, "which": [1, 2, 4, 5, 9], "while": [4, 5, 9], "who": 5, "wire": [3, 6], "within": [1, 2], "work": [3, 4, 6, 7, 9], "would": [4, 5], "wrap": 4, "write": [4, 6, 7], "write_cv_byt": 7, "write_cv_handl": 7, "written": [4, 9], "x": [4, 9], "x322512msb4si": [1, 2], "x86_64": 5, "xxxx": 9, "y": 9, "y1": [1, 2, 4], "y2": 4, "yet": [1, 2], "you": [4, 5, 6], "your": [4, 5, 6], "yourself": [4, 5], "z": 9}, "titles": ["Hardware", "Hardware Description", "Hardware Description", "RP2040-Decoder Documentation", "Configuration Variables (CV)", "Getting started", "Troubleshooting", "Header files", "Software", "Software Description"], "titleterms": {"": 5, "1": 5, "14": 4, "2": 5, "3": 5, "4": 5, "5": 5, "If": 5, "No": 4, "acceler": 4, "adc": 4, "addit": 4, "address": 4, "altern": [1, 2], "arrai": 4, "auxiliari": 1, "auxillari": 2, "back": 9, "base": 4, "basic": 4, "bdr6133": 1, "bit": 4, "board": 5, "bom": [1, 2], "build": 5, "characterist": [1, 2], "clock": 4, "complet": [1, 2], "config": 4, "configur": 4, "constant": 4, "content": [0, 3, 8], "control": [4, 9], "core0": 7, "core1": 7, "cutoff": 4, "cv": [4, 7], "cv_1": 4, "cv_11": 4, "cv_112": 4, "cv_113": 4, "cv_114": 4, "cv_115": 4, "cv_116": 4, "cv_12": 4, "cv_17": 4, "cv_171": 4, "cv_172": 4, "cv_173": 4, "cv_174": 4, "cv_175": 4, "cv_176": 4, "cv_177": 4, "cv_178": 4, "cv_179": 4, "cv_18": 4, "cv_2": 4, "cv_257": 4, "cv_29": 4, "cv_3": 4, "cv_31": 4, "cv_32": 4, "cv_4": 4, "cv_47": 4, "cv_48": 4, "cv_49": 4, "cv_5": 4, "cv_50": 4, "cv_51": 4, "cv_512": 4, "cv_52": 4, "cv_53": 4, "cv_54": 4, "cv_55": 4, "cv_56": 4, "cv_57": 4, "cv_58": 4, "cv_59": 4, "cv_6": 4, "cv_60": 4, "cv_61": 4, "cv_62": 4, "cv_63": 4, "cv_64": 4, "cv_65": 4, "cv_7": 4, "cv_8": 4, "cv_9": 4, "cycl": 4, "d": 4, "dcc": 9, "deceler": 4, "decod": [3, 4, 9], "delai": 4, "descript": [1, 2, 9], "divid": 4, "document": 3, "driver": [1, 2], "emf": 9, "expect": 5, "extend": 4, "factor": 4, "feed": [4, 9], "file": [5, 7], "filter": 4, "flash": [4, 5], "forward": [4, 9], "frequenc": 4, "function": 4, "gain": [4, 9], "get": 5, "gpio": [1, 2, 4], "h": 7, "hardwar": [0, 1, 2], "header": 7, "ht7533": 1, "i": 4, "initi": 5, "input": [1, 2], "integr": 4, "iter": 4, "k_ff": 4, "k_p": 4, "level": 4, "limit": 4, "list": 4, "long": 4, "m": 4, "manufactur": 4, "map": 4, "measur": [4, 9], "microcontrol": [1, 2], "mode": 4, "motor": [1, 2, 4, 9], "new": 4, "note": 4, "o": 5, "offset": 4, "onli": 4, "oper": 4, "other": 5, "output": [1, 2], "overview": [1, 2, 9], "packet": 4, "part": [1, 2], "percentag": 4, "permit": 4, "pid": [4, 9], "pointer": 4, "product": 5, "pwm": 4, "rate": 4, "read": 4, "rp2040": 3, "sampl": 4, "schedul": [4, 9], "schemat": [1, 2], "share": 7, "shift": 4, "signal": 9, "slice": 4, "softwar": [8, 9], "speed": 4, "speed_help": 4, "stage": [1, 2], "start": 5, "startup": 5, "step": 4, "t": 4, "tabl": 1, "tau": 4, "time": 4, "timeout": 4, "timer": 4, "troubleshoot": 6, "us": 4, "v_max": 4, "v_mid": 4, "v_min": 4, "variabl": 4, "version": 4, "voltag": 9, "where": 5, "window": 5, "wire": 5, "work": 5, "x0": 4, "x1": 4, "x2": 4}}) \ No newline at end of file diff --git a/docs/sphinx/build/html/software/header_files.html b/docs/sphinx/build/html/software/header_files.html new file mode 100644 index 0000000..ecf059f --- /dev/null +++ b/docs/sphinx/build/html/software/header_files.html @@ -0,0 +1,1052 @@ + + + + + + + + + Header files — RP2040-Decoder 0.3, 1.0 documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Header files

+
+

core0.h

+

Used exclusively by core0

+
+

Defines

+
+
+SIZE_BYTE_ARRAY
+
+ +
+
+MESSAGE_3_BYTES
+
+ +
+
+MESSAGE_MASK_3_BYTES
+
+ +
+
+MESSAGE_4_BYTES
+
+ +
+
+MESSAGE_MASK_4_BYTES
+
+ +
+
+MESSAGE_5_BYTES
+
+ +
+
+MESSAGE_MASK_5_BYTES
+
+ +
+
+

Functions

+
+
+float two_std_dev(const float arr[], uint32_t length)
+

Function returns average of values deviating less than twice the standard deviation from original average.

+
+
Parameters:
+
    +
  • arr – input array

  • +
  • length – amount of elements in input array

  • +
+
+
Returns:
+

average value of values deviating less than 2*standard_dev.

+
+
+
+ +
+
+void adc_offset_adjustment(uint32_t n)
+

Measures ADC offset and saves the offset value to flash memory.

+
+
Parameters:
+

n – Amount of measurements to be done

+
+
+
+ +
+
+void acknowledge()
+

Function for acknowledging a CV write or CV verify instruction.

+

Acknowledgement works by creating a spike in current consumption, normally realized by running the motor in alternating directions. This current increase is detected by the command station. Refers to NMRA S-9.2.3 Section D and RCN-216 Section 3

+
+ +
+
+void verify_cv_bit(uint16_t cv_address, bool bit_val, uint8_t bit_pos)
+

Function for verifying a single bit of a CV.

+
+
Parameters:
+
    +
  • cv_address – CV Address

  • +
  • bit_val – Value of bit to be verified

  • +
  • bit_pos – Position of bit to be verified

  • +
+
+
+
+ +
+
+void verify_cv_byte(uint16_t cv_address, uint8_t cv_data)
+

Function for verifying a CV byte.

+
+
Parameters:
+
    +
  • cv_address – CV Address

  • +
  • cv_data – Byte to be verified

  • +
+
+
+
+ +
+
+void write_cv_byte(uint16_t cv_address, uint8_t cv_data)
+

Function for writing a CV byte.

+
+
Parameters:
+
    +
  • cv_address –

  • +
  • cv_data –

  • +
+
+
+
+ +
+
+void program_mode(uint8_t number_of_bytes, const uint8_t byte_array[])
+

CV Programming mode function Used on entering programming mode in order to write CV values to persistent flash memory or verify/read bits/bytes from flash.

+

Refers to NMRA Standard 9.2.3 (“Service Mode Programming”) or RCN-216

+

+

Procedure:

    +
  1. Checks for valid programming command

  2. +
  3. Disables core1 timers

  4. +
  5. Resets core1

  6. +
  7. Saves interrupts

  8. +
  9. Evaluates the type of programming instruction Write byte / Verify byte / Verify bit and runs corresponding function

  10. +
  11. Restores interrupts

  12. +
  13. Launch core1

  14. +
+

+
+
Parameters:
+
    +
  • number_of_bytes – Number of bytes in byte_array[]

  • +
  • byte_array – Pointer to byte_array[]

  • +
+
+
+
+ +
+
+void set_outputs(uint32_t functions_to_set_bitmask)
+

Set outputs according to function mapping in CV257 to CV512.

+

This function maps the functions and direction to the mapped outputs configured in CV257 to CV512. Also enables PWM when enabled according to CV112 to CV115.

+
+
Parameters:
+

functions_to_set_bitmask – Function bitmask F0 is bit0, F1 is bit1, …

+
+
+
+ +
+
+void update_active_functions(uint32_t new_function_bitmask, uint8_t clr_bit_ind, bool direction_change)
+
+ +
+
+bool error_detection(int8_t number_of_bytes, const uint8_t *byte_array)
+
+ +
+
+bool is_long_address(uint8_t number_of_bytes, const uint8_t byte_array[])
+
+ +
+
+bool address_evaluation(uint8_t number_of_bytes, const uint8_t byte_array[])
+
+ +
+
+void instruction_evaluation(uint8_t number_of_bytes, const uint8_t byte_array[])
+
+ +
+
+bool reset_message_check(uint8_t number_of_bytes, const uint8_t *const byte_array)
+
+ +
+
+int8_t verify_dcc_message()
+
+ +
+
+void bits_to_byte_array(int8_t number_of_bytes, uint8_t byte_array[])
+
+ +
+
+void evaluate_message()
+
+ +
+
+void track_signal_rise(unsigned int gpio, long unsigned int events)
+

Track signal rising edge interrupt callback function.

+

Saves timer counter value using get_absolute_time(), then disables rising edge IRQ and enables falling edge IRQ. Parameters are unused.

+
+
Parameters:
+
    +
  • gpio – Unused parameter

  • +
  • events – Unused parameter

  • +
+
+
+
+ +
+
+void track_signal_fall(unsigned int gpio, long unsigned int events)
+

Track signal falling edge interrupt callback function.

+

Saves timer counter value using get_absolute_time(), then calculates time difference between rising and falling edge. When the time difference is greater than 87us, this bit is interpreted as a logical 0. Refers to NMRA S-9.1 and RCN-210 standards Puts the latest bit value into buffer, then evaluates complete buffer using evaluate_message(). Parameters are unused.

+
+
Parameters:
+
    +
  • gpio – Unused parameter

  • +
  • events – Unused parameter

  • +
+
+
+
+ +
+
+void init_outputs()
+

Output initialization function.

+

Initializes all allowed GPIO outputs as outputs

+

Sets PWM functionality for GPIOs configured as PWM pins CV_112 - CV_115 (see

+CV.h

for reference)

+

PWM frequency and clock divider are configured according to CV_116 - CV_171 (see

+CV.h for reference)

+
+ +
+
+void cv_setup_check()
+

Checks various CV values in order to detect factory condition or pending calibrations.

+

Procedure:

    +
  1. Check for flash memory factory condition when found write default values specified in CV.h to flash memory

  2. +
  3. Check for existing ADC offset setup when not found write 7 to read-only CV_7 in order to trigger a ADC offset measurement/calibration

  4. +
  5. Check for base PWM configuration/calibration, run calibration when none is found

  6. +
+

+
+ +
+
+void init_motor_pwm(uint8_t gpio)
+

Function initializes motor PWM for pin specified.

+
+
Parameters:
+

gpio – GPIO pin

+
+
+
+ +
+
+void init_adc()
+

Initializes ADC.

+

Function initializes ADC, corresponding GPIO pins and ADC FIFO

+
+ +
+
+

Variables

+
+
+const uint32_t clr_bit_arr[6] = {0b11111111111111111111111111100000, 0b11111111111111111111111000011111, 0b11111111111111111110000111111111, 0b11111111111000000001111111111111, 0b11100000000111111111111111111111, 0b00011111111111111111111111111111,}
+

Bitmasks used for clearing bits corresponding to function blocks.

+

[0] = F0-F4 [1] = F5-F8 [2] = F9-F12 [3] = F13-F20 [4] = F21-F28 [5] = F29-F31

+
+ +
+
+
+

core1.h

+

Used exclusively by core1

+
+

Defines

+
+
+BASE_PWM_ARR_LEN
+
+ +
+
+

Typedefs

+
+
+typedef struct startup_parameters_t startup_parameters_t
+
+ +
+
+typedef struct pid_parameters_t pid_parameter_t
+
+ +
+
+typedef struct controller_parameter_t controller_parameter_t
+
+ +
+
+

Enums

+
+
+enum controller_mode_t
+

Values:

+
+
+enumerator STARTUP_MODE
+
+ +
+
+enumerator PID_MODE
+
+ +
+ +
+
+

Functions

+
+
+uint8_t get_speed_step_table_index_of_speed_step(uint8_t speed_step)
+
+ +
+
+bool speed_helper(struct repeating_timer *t)
+
+ +
+
+void adjust_pwm_level(uint16_t level)
+
+ +
+
+float get_kp(const controller_parameter_t *ctrl_par)
+
+ +
+
+uint16_t get_initial_level(controller_parameter_t *ctrl_par)
+
+ +
+
+void controller_startup_mode(controller_parameter_t *ctrl_par)
+
+ +
+
+bool controller_general(struct repeating_timer *t)
+
+ +
+
+void init_controller(controller_parameter_t *ctrl_par)
+
+ +
+
+
+struct startup_parameters_t
+
+

Public Members

+
+
+uint16_t level
+
+ +
+
+uint16_t base_pwm_arr[BASE_PWM_ARR_LEN]
+
+ +
+
+uint16_t base_pwm_arr_i
+
+ +
+
+ +
+
+struct pid_parameters_t
+
+

Public Members

+
+
+float k_i
+
+ +
+
+float k_d
+
+ +
+
+float t
+
+ +
+
+float tau
+
+ +
+
+float ci_0
+
+ +
+
+float cd_0
+
+ +
+
+float cd_1
+
+ +
+
+float int_lim_max
+
+ +
+
+float int_lim_min
+
+ +
+
+float max_output
+
+ +
+
+float k_p
+
+ +
+
+float e
+
+ +
+
+float e_prev
+
+ +
+
+float i_prev
+
+ +
+
+float d_prev
+
+ +
+
+float k_p_x_1_shift
+
+ +
+
+float k_p_x_1
+
+ +
+
+float k_p_x_2
+
+ +
+
+float k_p_y_0
+
+ +
+
+float k_p_y_1
+
+ +
+
+float k_p_y_2
+
+ +
+
+float k_p_m_1
+
+ +
+
+float k_p_m_2
+
+ +
+
+ +
+
+struct controller_parameter_t
+
+

Public Members

+
+
+controller_mode_t mode
+

General Variables

+
+ +
+
+float feed_fwd
+
+ +
+
+uint32_t setpoint
+
+ +
+
+uint16_t speed_table[127]
+
+ +
+
+startup_parameters_t startup
+

Startup controller mode specific variables

+
+ +
+
+pid_parameter_t pid
+

PID Controller variables

+
+ +
+
+float measurement
+

Measurement Variables

+
+ +
+
+float measurement_prev
+
+ +
+
+float measurement_corrected
+
+ +
+
+float adc_offset
+
+ +
+
+uint8_t msr_delay_in_us
+
+ +
+
+uint8_t msr_total_iterations
+
+ +
+
+uint8_t l_side_arr_cutoff
+
+ +
+
+uint8_t r_side_arr_cutoff
+
+ +
+
+ +
+
+

shared.h

+

Used by both cores

+
+

Defines

+
+
+LOGLEVEL
+
+ +
+
+LOG(level, ...)
+
+ +
+
+_125M
+
+ +
+
+DCC_INPUT_PIN
+
+ +
+
+MOTOR_FWD_PIN
+
+ +
+
+MOTOR_REV_PIN
+
+ +
+
+FWD_V_EMF_ADC_PIN
+
+ +
+
+REV_V_EMF_ADC_PIN
+
+ +
+
+GPIO_OUTPUT_PIN_MASK
+
+ +
+
+GPIO_ILLEGAL_MASK
+
+ +
+
+GPIO_ALLOWED_OUTPUTS
+
+ +
+
+FLASH_TARGET_OFFSET
+
+ +
+
+

Functions

+
+
+void core1_entry()
+
+ +
+
+void write_cv_handler(uint16_t cv_index, uint8_t cv_data)
+
+ +
+
+float measure(uint8_t total_iterations, uint8_t measurement_delay_us, uint8_t l_side_arr_cutoff, uint8_t r_side_arr_cutoff, bool direction)
+
+ +
+
+uint32_t get_32bit_CV(uint16_t CV_start_index)
+
+ +
+
+uint16_t get_16bit_CV(uint16_t CV_start_index)
+
+ +
+
+bool get_direction_of_speed_step(uint8_t speed_step)
+

Calculates the direction based on a speed step byte.

+

This function calculates the direction of movement based on the value of the speed_step byte. It refers to the “128 Speed Control” standard as outlined in NMRA Standard 9.2.1 section 2.3.2.1 or RCN-212 section 2.2.2.

+

The following speed steps are defined:

+

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

DEC

BIN

DIRECTION

DEFINITION

000

0000 0000

Reverse

STOP

001

0000 0001

Reverse

EMERGENCY STOP

002

0000 0010

Reverse

Speed step 001

003

0000 0011

Reverse

Speed step 002

004

0000 0100

Reverse

Speed step 003

…

…. ….

Reverse

…

126

0111 1110

Reverse

Speed step 125

127

0111 1111

Reverse

Speed step 126

128

1000 0000

Forward

STOP

129

1000 0001

Forward

EMERGENCY STOP

130

1000 0010

Forward

Speed step 001

131

1000 0011

Forward

Speed step 002

132

1000 0100

Forward

Speed step 003

…

…. ….

Forward

…

254

1111 1110

Forward

Speed step 125

255

1111 1111

Forward

Speed step 126

+

+
+
Parameters:
+

speed_step – The speed step byte.

+
+
Returns:
+

true for forward direction, false for reverse direction.

+
+
+
+ +
+
+

Variables

+
+
+repeating_timer_t pid_control_timer
+
+ +
+
+repeating_timer_t speed_helper_timer
+
+ +
+
+const uint8_t *CV_ARRAY_FLASH
+
+ +
+
+uint8_t speed_step_target
+
+ +
+
+uint8_t speed_step_target_prev
+
+ +
+
+
+

CV.h

+
+

Defines

+
+
+CV_ARRAY_SIZE
+
+ +
+
+

Functions

+
+
+uint8_t __in_flash ("Default_CV_values") CV_ARRAY_DEFAULT[CV_ARRAY_SIZE]
+
+ +
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/sphinx/build/html/software/sw.html b/docs/sphinx/build/html/software/sw.html new file mode 100644 index 0000000..b474d00 --- /dev/null +++ b/docs/sphinx/build/html/software/sw.html @@ -0,0 +1,136 @@ + + + + + + + + + Software — RP2040-Decoder 0.3, 1.0 documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+ + +
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/sphinx/build/html/software/sw_description.html b/docs/sphinx/build/html/software/sw_description.html new file mode 100644 index 0000000..3b5a69d --- /dev/null +++ b/docs/sphinx/build/html/software/sw_description.html @@ -0,0 +1,208 @@ + + + + + + + + + Software Description — RP2040-Decoder 0.3, 1.0 documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Software Description

+
+

Overview

+

The Software is structured as follows:

+
    +
  • Core0.c

    +
      +
    • DCC package detection & decoding

    • +
    • Programming mode (Modify and read CVs on programming track)

    • +
    • ADC-Offset measurement

    • +
    • Feed-forward base PWM measurement

    • +
    +
  • +
  • Core1.c

    +
      +
    • PID motor controller

    • +
    +
  • +
  • CV.h

    +
      +
    • Default configuration variables

    • +
    +
  • +
+

Conveniently The Raspberry Pi Foundation provides a well documented SDK for the RP2040. The SDK provides abstraction to a higher level and therefore there is no need to access any registers directly. Everything is written using the SDK so hopefully the code is easier to understand. In the following, the motor control and the decoding of the DCC signals will be explained.

+
+
+

Motor control overview

+

Block Diagram

+
+

Block diagram - Motor control

+

The above block diagram in essence describes the functionality of the control loop. While the central component is the PID controller, there is an additional block called Feed-forward that has an impact on the control output variable. The Feed-forward block adds an additional offset to the output depending on the setpoint, this is done to achieve better control. A more detailed explanation regarding Feed-forward can be found below. The speed helper block is corresponding to the speed_helper() function which delays changing the setpoint according to the configured deceleration/acceleration rates.

+
+
+

PID Controller

+

PID Controller

+

The block diagram above shows the PID controller in the s-domain. The derivative part contains an additional digital low pass filter used to filter out high-frequency noise.

+

Output = E * (KP + KI/s + (KD*s)/(sτ+1)) = P + I + D

+
    +
  • P = E * KP

  • +
  • I = E * KI/s

  • +
  • D = E * (KD*s)/(sτ+1)

  • +
+

The continuous-time system representation can now be transformed into a discrete-time representation using bilinear transform [ s = 2*(z-1) / Ts*(z+1) ].

+

This results in the following difference equations which are then implemented in software:

+
    +
  • pn = KP * en

  • +
  • in = 0.5KI * (en + en-1) + in-1

  • +
  • dn = [ 2KD * (en - en-1) + (2τ - Ts) * dn-1 ] / [ 2τ + Ts]

  • +
+

=> outputn = pn + in + dn

+

Also note that instead of using derivative of error, derivative on measurement is used. This is done to prevent a high derivative part in the event of a large change in setpoint.

+
+

Gain scheduling

+

K_P

+

Another aspect to consider is the implementation of gain scheduling. KP is a function of the current setpoint. Often it is favorable to have a higher proportional gain KP for slow speeds, achieving better control results. The illustration above shows the default setting for KP. CV_54 & CV_55 are used to set KP @ x0, CV_56 & CV_57 for KP @ x1 and CV_58 & CV_59 for KP @ x2. Additionally CV_60 is used to shift x1 from the leftmost point (0% = 0/255) to the rightmost point (100% = 255/255).

+
+
+

Feed-forward

+

Feed-forward +To achieve better control Feed-forward is used. On startup the decoder will check for a configuration regarding Feed-forward control - when no configuration is found the decoder automatically runs a calibration to establish a base pwm level (y1) for both directions. The base pwm level (y1) will vary depending on load, motor and voltage on the tracks and can be configured with CV_176 - CV_179. If the setpoint is greater than the threshold, y2 is corrected automatically when in reaches 0.5imin or 0.5imax. CV_47 can be used to set how sensitive this correction is.

+
+
+

Back-EMF voltage measurement

+

To provide a feedback signal which is proportional to the motor speed the ADC is used to measure the Back-EMF voltage. The measurement works by setting the PWM duty cycle to 0%, waiting for a certain delay time (CV_62) and then measuring x times (x = CV_63). While measuring the array with measurement values are being sorted using insertion sort. Afterwards y elements (y = CV_63) from the left (lowest values) and z elements (z = CV_64) from the right (highest values) will be dismissed to mitigate the impact of potential outliers in measurement. The average value of the remaining values will be computed and fed back into the control algorithm. Considering default settings (100us delay, 100 samples, ~2µs sampling time) the complete measurement run including averaging takes about 0.3ms to 0.35ms which effectively reduces the maximum possible duty cycle to about 93% to 94%.

+
+
+
+

DCC signal decoding

+

The detection of the DCC signal works by looking at every rising and falling edge and calculating the time between them. When the time between rising and falling edge is greater than 87μs then this is equivalent to “0”, else “1” - This value then gets shifted into a 64-Bit variable.

+

Decoding is done after every falling edge. It starts with an error detection which when not passed will dismiss the received command. Then the address will be decoded and compared to the address stored in the configuration. If the address matches the command/instruction will be decoded.

+

Only a few instructions are currently implemented, only 128 speed step instructions are supported.

+

Implemented instructions:

+
    +
  • 0011-1111 - (128 Speed Step Control) - 2 Byte length

  • +
  • 10XX-XXXX - (Function Group Instruction) (F0 - F12)

  • +
  • 110X-XXXX - Expansion Instruction (F13 - F31)

  • +
+

All DCC instructions can be found in Section 9.2, 9.2.1 and 9.2.1.1 of the NMRA Communications Standard

+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file