kopia lustrzana https://github.com/Yakifo/amqtt
update to amqtt logo. revisions to amqtt docs
Andrew Mirsky
rodzic
b8ac2b3b9a
commit
0ad46ef783
46
README.md
46
README.md
|
|
@ -1,6 +1,6 @@
|
|||
[](https://amqtt.readthedocs.io/en/latest/)
|
||||
[](https://github.com/Yakifo/amqtt/actions/workflows/python-package.yml)
|
||||
[](https://coveralls.io/github/Yakifo/amqtt?branch=master)
|
||||
[](https://github.com/Yakifo/amqtt/actions/workflows/ci.yml)
|
||||
[](https://github.com/Yakifo/amqtt/actions/workflows/codeql-analysis.yml)
|
||||
[](https://amqtt.readthedocs.io/en/latest/)
|
||||
[](https://gitter.im/amqtt/community)
|
||||
|
||||
|
|
@ -9,41 +9,22 @@
|
|||
|
||||
|
||||
|
||||
# aMQTT
|
||||
|
||||
`aMQTT` is an open source [MQTT](http://www.mqtt.org) client and broker implementation.
|
||||
|
||||
Built on top of [asyncio](https://docs.python.org/3/library/asyncio.html), Python's standard asynchronous I/O framework, aMQTT provides a straightforward API based on coroutines, making it easy to write highly concurrent applications.
|
||||
|
||||
It was forked from [HBMQTT](https://github.com/beerfactory/hbmqtt) after it was deprecated by the original author.
|
||||
`aMQTT` is an open source [MQTT](http://www.mqtt.org) broker[^1], natively implemented with Python's [asyncio](https://docs.python.org/3/library/asyncio.html).
|
||||
|
||||
## Features
|
||||
|
||||
aMQTT implements the full set of [MQTT 3.1.1](http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html) protocol specifications and provides the following features:
|
||||
|
||||
- Full set of [MQTT 3.1.1](http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html) protocol specifications
|
||||
- Communication over TCP and/or websocket, including support for SSL/TLS
|
||||
- Support QoS 0, QoS 1 and QoS 2 messages flow
|
||||
- Client auto-reconnection on network lost
|
||||
- Authentication through password file (more methods can be added through a plugin system)
|
||||
- Functionality expansion; plugins included:
|
||||
- Authentication through password file
|
||||
- Basic `$SYS` topics
|
||||
- TCP and websocket support
|
||||
- SSL support over TCP and websocket
|
||||
- Plugin system
|
||||
|
||||
## Project Status and Roadmap
|
||||
|
||||
The current focus is to build setup the project infrastructure for the new fork.
|
||||
From there the goal is to fix outstanding known issues and clean up the code.
|
||||
|
||||
| Version | hbmqtt compatibility | Supported Python Versions | PyPi Release |
|
||||
|---------|---------------------|-------------------------|--------------|
|
||||
| 0.10.x | YES - Drop-in Replacement | 3.7* | 0.10.1 |
|
||||
| 0.11.x | NO - Module renamed and small API differences | 3.7 - 3.10 | No release yet |
|
||||
|
||||
\* Due to a change in Python 3.8 where the semantics of asyncio.CancelledError was changed to be a subclass of BaseException instead of Exception, old versions of hbmqtt and aMQTT will break, see https://github.com/Yakifo/amqtt/issues/133. Therefore only 3.7 is mentioned as supported version for 0.10.x.
|
||||
|
||||
## Getting started
|
||||
|
||||
`amqtt` is available on [PyPI](https://pypi.python.org/pypi/amqtt) and can be installed simply using `pip`:
|
||||
`amqtt` is available on [PyPI](https://pypi.python.org/pypi/amqtt)
|
||||
|
||||
```bash
|
||||
$ pip install amqtt
|
||||
|
|
@ -54,5 +35,16 @@ Documentation is available on [Read the Docs](http://amqtt.readthedocs.org/).
|
|||
Bug reports, patches and suggestions welcome! Just [open an issue](https://github.com/Yakifo/amqtt/issues/new) or join the [gitter community](https://gitter.im/amqtt/community).
|
||||
|
||||
|
||||
## Project Status and Roadmap
|
||||
|
||||
| Version | hbmqtt compatibility | Supported Python Versions | PyPi Release |
|
||||
|---------|----------------------|---------------------------|--------------|
|
||||
| 0.10.x | yes [^2] | 3.7 - 3.9 | 0.10.1 |
|
||||
| 0.11.x | no [^3] | 3.10 - 3.13 | 0.11.0 |
|
||||
|
||||
|
||||
[^1]: Forked from [HBMQTT](https://github.com/beerfactory/hbmqtt) after it was deprecated by the original author.
|
||||
[^2]: drop-in replacement
|
||||
[^3]: module renamed and small API differences
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -15,14 +15,12 @@ viewBox="0 0 17484.57 3960.9"
|
|||
</defs>
|
||||
<g id="Layer_x0020_1">
|
||||
<metadata id="CorelCorpID_0Corel-Layer"/>
|
||||
<g id="_105553311024800">
|
||||
<path class="fil0" d="M15857.77 3758.63l0 -3088.45c0,-69.46 -56.65,-126.11 -126.11,-126.11l-857.7 0c-69.46,0 -126.11,-56.65 -126.11,-126.11l0 -215.69c0,-69.46 56.64,-126.11 126.11,-126.11l2484.5 0c69.46,0 126.11,56.65 126.11,126.11l0 215.69c0,69.46 -56.65,126.11 -126.11,126.11l-857.7 0c-69.46,0 -126.11,56.65 -126.11,126.11l0 3088.45c0,69.46 -56.64,126.11 -126.11,126.11l-264.67 0c-69.46,0 -126.11,-56.65 -126.11,-126.11z"/>
|
||||
<path class="fil0" d="M12957.82 3758.63l0 -3088.45c0,-69.46 -56.64,-126.11 -126.11,-126.11l-857.7 0c-69.46,0 -126.11,-56.65 -126.11,-126.11l0 -215.69c0,-69.46 56.65,-126.11 126.11,-126.11l2484.5 0c69.46,0 126.11,56.65 126.11,126.11l0 215.69c0,69.46 -56.65,126.11 -126.11,126.11l-857.7 0c-69.46,0 -126.11,56.65 -126.11,126.11l0 3088.45c0,69.46 -56.65,126.11 -126.11,126.11l-264.66 0c-69.46,0 -126.11,-56.65 -126.11,-126.11z"/>
|
||||
<path class="fil0" d="M9802.16 3960.9c-362.72,0 -685.53,-81.61 -968.46,-243.93 -282.92,-162.31 -505.09,-391.73 -666.5,-688.25 -161.41,-296.52 -242.12,-645.65 -242.12,-1048.26 0,-402.62 80.71,-752.65 242.12,-1049.16 161.41,-296.53 383.58,-525.95 666.5,-688.27 282.93,-162.31 605.74,-243.02 968.46,-243.02 362.73,0 685.55,80.71 968.47,243.02 282.92,162.33 505.09,391.74 666.5,688.27 161.4,296.51 242.11,646.54 242.11,1049.16 0,402.62 -80.71,751.74 -242.11,1048.26 -161.41,296.52 -383.58,525.95 -666.5,688.25 -282.92,162.33 -605.74,243.93 -968.47,243.93zm0 -500.55c292,0 535.93,-66.19 731.79,-197.68 195.87,-131.48 343.67,-309.22 442.51,-533.19 98.85,-223.98 147.81,-473.36 147.81,-749.03 0,-275.66 -48.96,-525.94 -147.81,-749.92 -98.84,-223.98 -246.65,-401.71 -442.51,-533.2 -195.87,-131.49 -439.8,-196.78 -731.79,-196.78 -291.99,0 -535.91,65.29 -731.79,196.78 -195.87,131.48 -342.77,309.21 -441.62,533.2 -98.84,223.98 -148.71,474.26 -148.71,749.92 0,275.66 49.88,525.04 148.71,749.03 98.85,223.97 245.75,401.7 441.62,533.19 195.87,131.49 439.8,197.68 731.79,197.68z"/>
|
||||
<path class="fil0" d="M10195.2 2695.71l117.11 -119.29c48.66,-49.56 128.77,-50.3 178.33,-1.64l1017.01 998.52c49.57,48.67 50.29,128.77 1.63,178.34l-117.11 119.27c-48.65,49.56 -128.77,50.3 -178.32,1.64l-1017.02 -998.5c-49.57,-48.67 -50.3,-128.77 -1.63,-178.34z"/>
|
||||
<path class="fil0" d="M3597.08 3741.84l477.57 -3556.34c8.46,-62.99 61.44,-109.33 124.99,-109.33l254.52 0c47.9,0 88.97,24.72 111.41,67.03l853.55 1609.69c22.48,42.39 63.7,67.13 111.69,67.02 48,-0.11 89.12,-25.02 111.41,-67.53l843.74 -1608.66c22.34,-42.6 63.58,-67.54 111.68,-67.54l259.42 0c63.6,0 116.63,46.43 125,109.5l472.49 3556.34c4.96,37.32 -5.33,71.38 -30.15,99.7 -24.8,28.33 -57.21,43.02 -94.86,43.02l-288.7 0c-63.99,0 -117.25,-47.04 -125.15,-110.55l-372.56 -2996.15 136.03 21.77 -1031.91 1970.44c-22.24,42.48 -63.27,67.41 -111.22,67.61 -47.95,0.19 -89.17,-24.43 -111.74,-66.73l-1052.04 -1971.32 136.02 -21.77 -372.55 2996.15c-7.89,63.51 -61.16,110.55 -125.15,110.55l-288.5 0c-37.69,0 -70.12,-14.73 -94.92,-43.08 -24.8,-28.36 -35.08,-62.46 -30.06,-99.81z"/>
|
||||
<g>
|
||||
<g>
|
||||
<g id="_105553308281216">
|
||||
<path class="fil0" d="M1957.06 947c352.33,76.52 651.85,286.65 843.59,591.4 191.78,304.81 251.46,665.75 168.03,1016.44 -10.41,43.56 -1.77,87.36 20.16,122.22 21.94,34.86 56.06,60.32 98.27,70.42 85.73,20.44 172.16,-32.79 192.59,-118.52 103.37,-434.94 29.47,-882.64 -208.46,-1260.81 -237.88,-378.08 -609.7,-638.82 -1046.38,-733.6 -86.12,-18.68 -171.43,36.15 -190.2,122.32 -18.68,86.12 36.15,171.43 122.32,190.19l0.07 -0.07z"/>
|
||||
<path class="fil0" d="M1765.12 2135.2c159.79,137.95 -47.11,377.6 -206.9,239.65 -159.79,-137.95 47.11,-377.6 206.9,-239.65z"/>
|
||||
<path class="fil0" d="M324.48 2355.38c-29.95,-359.29 83.33,-707.2 318.62,-979.73 235.34,-272.59 563.02,-435.29 922.76,-458.15 44.71,-2.79 84.05,-23.88 110.97,-55.06 26.91,-31.17 41.27,-71.26 38.58,-114.57 -5.55,-87.96 -81.74,-155.02 -169.69,-149.48 -446.15,28.44 -852.62,230.13 -1144.6,568.32 -291.91,338.12 -432.4,769.97 -395.24,1215.27 7.34,87.82 84.73,153.35 172.63,146.07 87.82,-7.34 153.35,-84.73 146.07,-172.63l-0.09 -0.04z"/>
|
||||
|
|
@ -31,8 +29,6 @@ viewBox="0 0 17484.57 3960.9"
|
|||
<path class="fil0" d="M1750.82 1872.33c25.7,-29.77 40.54,-68.92 38.62,-111.19 -3.77,-88.23 -78.19,-156.6 -166.57,-153.09 -175.23,7.18 -341.42,87.66 -455.97,220.35 -114.55,132.68 -169.66,308.52 -151.46,483.24 9.14,87.82 87.99,151.52 175.76,142.45 87.82,-9.13 151.52,-87.99 142.45,-175.75 -9.23,-88.17 17.36,-173.79 75.27,-240.86 57.9,-67.07 138.5,-106.06 227.29,-109.6 45.89,-1.77 86.41,-22.88 114.47,-55.38l0.15 -0.17z"/>
|
||||
<path class="fil0" d="M1714.29 1378.19c26.15,-30.29 41.11,-70.61 38.58,-113.69 -5.14,-88.12 -80.75,-155.58 -168.87,-150.43 -308.84,17.67 -590.11,156.49 -791.96,390.29 -201.85,233.81 -298.15,532.33 -270.57,840.43 7.76,87.94 85.52,152.87 173.45,145.12 87.93,-7.77 152.87,-85.53 145.11,-173.46 -19.88,-221.14 49.25,-435.33 194.02,-603.03 144.84,-167.76 346.8,-267.13 568.27,-279.92 44.99,-2.54 84.63,-23.64 111.8,-55.12l0.17 -0.2z"/>
|
||||
</g>
|
||||
<rect class="fil1" x="3027.2" y="632.27" width="305.9" height="3268.63" rx="151.33" ry="554.94"/>
|
||||
</g>
|
||||
</g>
|
||||
<path class="fil1" d="M3181.77 632.27l-3.25 0c-83.23,0 -151.32,68.1 -151.32,151.32l0 2966c0,83.22 68.09,151.31 151.32,151.31l3.25 0c83.23,0 151.32,-68.09 151.32,-151.31l0 -2966c0,-83.22 -68.09,-151.32 -151.32,-151.32z"/>
|
||||
</g>
|
||||
</svg>
|
||||
|
|
|
|||
|
Przed Szerokość: | Wysokość: | Rozmiar: 6.5 KiB Po Szerokość: | Wysokość: | Rozmiar: 6.6 KiB |
|
|
@ -15,14 +15,12 @@ viewBox="0 0 16459.16 3728.61"
|
|||
</defs>
|
||||
<g id="Layer_x0020_1">
|
||||
<metadata id="CorelCorpID_0Corel-Layer"/>
|
||||
<g id="_105553308213696">
|
||||
<path class="fil0" d="M14927.77 3538.19l0 -2907.31c0,-65.38 -53.33,-118.71 -118.71,-118.71l-807.4 0c-65.38,0 -118.71,-53.33 -118.71,-118.71l0 -203.04c0,-65.38 53.33,-118.71 118.71,-118.71l2338.8 0c65.38,0 118.71,53.33 118.71,118.71l0 203.04c0,65.38 -53.33,118.71 -118.71,118.71l-807.4 0c-65.38,0 -118.71,53.33 -118.71,118.71l0 2907.31c0,65.38 -53.33,118.71 -118.71,118.71l-249.14 0c-65.38,0 -118.71,-53.33 -118.71,-118.71z"/>
|
||||
<path class="fil0" d="M12197.9 3538.19l0 -2907.31c0,-65.38 -53.33,-118.71 -118.71,-118.71l-807.4 0c-65.38,0 -118.71,-53.33 -118.71,-118.71l0 -203.04c0,-65.38 53.33,-118.71 118.71,-118.71l2338.8 0c65.38,0 118.71,53.33 118.71,118.71l0 203.04c0,65.38 -53.33,118.71 -118.71,118.71l-807.4 0c-65.38,0 -118.71,53.33 -118.71,118.71l0 2907.31c0,65.38 -53.33,118.71 -118.71,118.71l-249.14 0c-65.38,0 -118.71,-53.33 -118.71,-118.71z"/>
|
||||
<path class="fil0" d="M9227.3 3728.61c-341.45,0 -645.33,-76.83 -911.66,-229.63 -266.32,-152.79 -475.46,-368.76 -627.41,-647.89 -151.94,-279.13 -227.92,-607.78 -227.92,-986.79 0,-379.01 75.98,-708.5 227.92,-987.63 151.95,-279.14 361.09,-495.1 627.41,-647.9 266.33,-152.79 570.22,-228.77 911.66,-228.77 341.45,0 645.34,75.98 911.66,228.77 266.33,152.8 475.47,368.76 627.41,647.9 151.94,279.13 227.92,608.62 227.92,987.63 0,379.01 -75.98,707.66 -227.92,986.79 -151.94,279.13 -361.08,495.1 -627.41,647.89 -266.32,152.8 -570.22,229.63 -911.66,229.63zm0 -471.2c274.87,0 504.49,-62.31 688.87,-186.09 184.39,-123.78 323.52,-291.09 416.56,-501.92 93.05,-210.85 139.14,-445.6 139.14,-705.1 0,-259.49 -46.09,-495.09 -139.14,-705.94 -93.04,-210.85 -232.18,-378.16 -416.56,-501.92 -184.38,-123.78 -414,-185.24 -688.87,-185.24 -274.87,0 -504.49,61.46 -688.87,185.24 -184.38,123.77 -322.67,291.08 -415.71,501.92 -93.04,210.85 -140,446.45 -140,705.94 0,259.5 46.95,494.25 140,705.1 93.04,210.84 231.34,378.15 415.71,501.92 184.39,123.78 414,186.09 688.87,186.09z"/>
|
||||
<path class="fil0" d="M9597.29 2537.62l110.24 -112.29c45.8,-46.65 121.22,-47.34 167.87,-1.54l957.36 939.96c46.66,45.81 47.34,121.22 1.53,167.88l-110.23 112.28c-45.8,46.65 -121.22,47.34 -167.87,1.54l-957.37 -939.95c-46.66,-45.81 -47.34,-121.22 -1.53,-167.88z"/>
|
||||
<path class="fil0" d="M3386.12 3522.4l449.56 -3347.78c7.96,-59.3 57.83,-102.91 117.65,-102.91l239.6 0c45.09,0 83.75,23.27 104.88,63.09l803.49 1515.28c21.16,39.91 59.96,63.19 105.14,63.09 45.19,-0.1 83.88,-23.56 104.87,-63.57l794.26 -1514.33c21.03,-40.1 59.85,-63.57 105.13,-63.57l244.21 0c59.88,0 109.78,43.71 117.67,103.07l444.77 3347.78c4.66,35.14 -5.02,67.2 -28.38,93.86 -23.35,26.66 -53.85,40.49 -89.3,40.49l-271.77 0c-60.23,0 -110.37,-44.29 -117.8,-104.06l-350.71 -2820.44 128.05 20.49 -971.39 1854.89c-20.94,39.99 -59.56,63.46 -104.7,63.64 -45.14,0.18 -83.94,-22.99 -105.19,-62.81l-990.33 -1855.71 128.04 -20.49 -350.7 2820.44c-7.43,59.78 -57.57,104.06 -117.8,104.06l-271.59 0c-35.47,0 -66,-13.86 -89.35,-40.56 -23.35,-26.7 -33.02,-58.79 -28.3,-93.95z"/>
|
||||
<g>
|
||||
<g>
|
||||
<g id="_105553311083264">
|
||||
<path class="fil0" d="M1842.29 891.46c331.66,72.03 613.62,269.84 794.11,556.72 180.53,286.94 236.71,626.71 158.19,956.83 -9.81,41.01 -1.66,82.24 18.98,115.05 20.64,32.82 52.77,56.79 92.5,66.3 80.7,19.23 162.06,-30.87 181.3,-111.57 97.32,-409.43 27.74,-830.88 -196.24,-1186.87 -223.93,-355.91 -573.95,-601.34 -985.01,-690.58 -81.08,-17.58 -161.38,34.03 -179.05,115.15 -17.59,81.08 34.02,161.38 115.15,179.05l0.07 -0.07z"/>
|
||||
<path class="fil0" d="M1661.6 2009.98c150.42,129.86 -44.34,355.46 -194.76,225.6 -150.42,-129.86 44.34,-355.46 194.76,-225.6z"/>
|
||||
<path class="fil0" d="M305.45 2217.25c-28.19,-338.22 78.43,-665.73 299.93,-922.27 221.54,-256.6 530,-409.76 868.65,-431.28 42.08,-2.63 79.13,-22.48 104.46,-51.83 25.34,-29.34 38.86,-67.08 36.32,-107.86 -5.23,-82.79 -76.96,-145.93 -159.75,-140.71 -419.99,26.77 -802.62,216.63 -1077.47,535 -274.79,318.29 -407.05,724.81 -372.07,1143.99 6.91,82.67 79.76,144.35 162.5,137.51 82.68,-6.91 144.36,-79.77 137.51,-162.51l-0.08 -0.04z"/>
|
||||
|
|
@ -31,8 +29,6 @@ viewBox="0 0 16459.16 3728.61"
|
|||
<path class="fil0" d="M1648.14 1762.52c24.19,-28.01 38.17,-64.87 36.35,-104.67 -3.55,-83.04 -73.6,-147.41 -156.8,-144.11 -164.95,6.76 -321.39,82.53 -429.23,207.43 -107.83,124.9 -159.71,290.43 -142.58,454.9 8.6,82.68 82.83,142.63 165.45,134.1 82.68,-8.6 142.63,-82.83 134.1,-165.45 -8.68,-82.99 16.35,-163.59 70.85,-226.73 54.51,-63.13 130.39,-99.84 213.97,-103.17 43.19,-1.66 81.34,-21.54 107.76,-52.13l0.14 -0.17z"/>
|
||||
<path class="fil0" d="M1613.76 1297.36c24.61,-28.51 38.7,-66.47 36.31,-107.02 -4.85,-82.96 -76.01,-146.45 -158.97,-141.6 -290.73,16.63 -555.5,147.31 -745.52,367.4 -190.01,220.09 -280.66,501.11 -254.71,791.14 7.31,82.78 80.52,143.91 163.29,136.61 82.78,-7.31 143.91,-80.52 136.6,-163.29 -18.71,-208.17 46.36,-409.81 182.65,-567.66 136.34,-157.92 326.46,-251.46 534.94,-263.5 42.35,-2.39 79.66,-22.26 105.23,-51.89l0.17 -0.19z"/>
|
||||
</g>
|
||||
<rect class="fil1" x="2849.67" y="595.19" width="287.96" height="3076.94" rx="142.45" ry="522.4"/>
|
||||
</g>
|
||||
</g>
|
||||
<path class="fil1" d="M2995.18 595.19l-3.07 0c-78.35,0 -142.44,64.09 -142.44,142.43l0 2792.06c0,78.35 64.09,142.43 142.44,142.43l3.07 0c78.35,0 142.44,-64.09 142.44,-142.43l0 -2792.06c0,-78.35 -64.09,-142.43 -142.44,-142.43z"/>
|
||||
</g>
|
||||
</svg>
|
||||
|
|
|
|||
|
Przed Szerokość: | Wysokość: | Rozmiar: 6.4 KiB Po Szerokość: | Wysokość: | Rozmiar: 6.5 KiB |
|
|
@ -15,14 +15,12 @@ viewBox="0 0 17484.57 3960.9"
|
|||
</defs>
|
||||
<g id="Layer_x0020_1">
|
||||
<metadata id="CorelCorpID_0Corel-Layer"/>
|
||||
<g id="_105553311024800">
|
||||
<path class="fil0" d="M15857.77 3758.63l0 -3088.45c0,-69.46 -56.65,-126.11 -126.11,-126.11l-857.7 0c-69.46,0 -126.11,-56.65 -126.11,-126.11l0 -215.69c0,-69.46 56.64,-126.11 126.11,-126.11l2484.5 0c69.46,0 126.11,56.65 126.11,126.11l0 215.69c0,69.46 -56.65,126.11 -126.11,126.11l-857.7 0c-69.46,0 -126.11,56.65 -126.11,126.11l0 3088.45c0,69.46 -56.64,126.11 -126.11,126.11l-264.67 0c-69.46,0 -126.11,-56.65 -126.11,-126.11z"/>
|
||||
<path class="fil0" d="M12957.82 3758.63l0 -3088.45c0,-69.46 -56.64,-126.11 -126.11,-126.11l-857.7 0c-69.46,0 -126.11,-56.65 -126.11,-126.11l0 -215.69c0,-69.46 56.65,-126.11 126.11,-126.11l2484.5 0c69.46,0 126.11,56.65 126.11,126.11l0 215.69c0,69.46 -56.65,126.11 -126.11,126.11l-857.7 0c-69.46,0 -126.11,56.65 -126.11,126.11l0 3088.45c0,69.46 -56.65,126.11 -126.11,126.11l-264.66 0c-69.46,0 -126.11,-56.65 -126.11,-126.11z"/>
|
||||
<path class="fil0" d="M9802.16 3960.9c-362.72,0 -685.53,-81.61 -968.46,-243.93 -282.92,-162.31 -505.09,-391.73 -666.5,-688.25 -161.41,-296.52 -242.12,-645.65 -242.12,-1048.26 0,-402.62 80.71,-752.65 242.12,-1049.16 161.41,-296.53 383.58,-525.95 666.5,-688.27 282.93,-162.31 605.74,-243.02 968.46,-243.02 362.73,0 685.55,80.71 968.47,243.02 282.92,162.33 505.09,391.74 666.5,688.27 161.4,296.51 242.11,646.54 242.11,1049.16 0,402.62 -80.71,751.74 -242.11,1048.26 -161.41,296.52 -383.58,525.95 -666.5,688.25 -282.92,162.33 -605.74,243.93 -968.47,243.93zm0 -500.55c292,0 535.93,-66.19 731.79,-197.68 195.87,-131.48 343.67,-309.22 442.51,-533.19 98.85,-223.98 147.81,-473.36 147.81,-749.03 0,-275.66 -48.96,-525.94 -147.81,-749.92 -98.84,-223.98 -246.65,-401.71 -442.51,-533.2 -195.87,-131.49 -439.8,-196.78 -731.79,-196.78 -291.99,0 -535.91,65.29 -731.79,196.78 -195.87,131.48 -342.77,309.21 -441.62,533.2 -98.84,223.98 -148.71,474.26 -148.71,749.92 0,275.66 49.88,525.04 148.71,749.03 98.85,223.97 245.75,401.7 441.62,533.19 195.87,131.49 439.8,197.68 731.79,197.68z"/>
|
||||
<path class="fil0" d="M10195.2 2695.71l117.11 -119.29c48.66,-49.56 128.77,-50.3 178.33,-1.64l1017.01 998.52c49.57,48.67 50.29,128.77 1.63,178.34l-117.11 119.27c-48.65,49.56 -128.77,50.3 -178.32,1.64l-1017.02 -998.5c-49.57,-48.67 -50.3,-128.77 -1.63,-178.34z"/>
|
||||
<path class="fil0" d="M3597.08 3741.84l477.57 -3556.34c8.46,-62.99 61.44,-109.33 124.99,-109.33l254.52 0c47.9,0 88.97,24.72 111.41,67.03l853.55 1609.69c22.48,42.39 63.7,67.13 111.69,67.02 48,-0.11 89.12,-25.02 111.41,-67.53l843.74 -1608.66c22.34,-42.6 63.58,-67.54 111.68,-67.54l259.42 0c63.6,0 116.63,46.43 125,109.5l472.49 3556.34c4.96,37.32 -5.33,71.38 -30.15,99.7 -24.8,28.33 -57.21,43.02 -94.86,43.02l-288.7 0c-63.99,0 -117.25,-47.04 -125.15,-110.55l-372.56 -2996.15 136.03 21.77 -1031.91 1970.44c-22.24,42.48 -63.27,67.41 -111.22,67.61 -47.95,0.19 -89.17,-24.43 -111.74,-66.73l-1052.04 -1971.32 136.02 -21.77 -372.55 2996.15c-7.89,63.51 -61.16,110.55 -125.15,110.55l-288.5 0c-37.69,0 -70.12,-14.73 -94.92,-43.08 -24.8,-28.36 -35.08,-62.46 -30.06,-99.81z"/>
|
||||
<g>
|
||||
<g>
|
||||
<g id="_105553308281216">
|
||||
<path class="fil0" d="M1957.06 947c352.33,76.52 651.85,286.65 843.59,591.4 191.78,304.81 251.46,665.75 168.03,1016.44 -10.41,43.56 -1.77,87.36 20.16,122.22 21.94,34.86 56.06,60.32 98.27,70.42 85.73,20.44 172.16,-32.79 192.59,-118.52 103.37,-434.94 29.47,-882.64 -208.46,-1260.81 -237.88,-378.08 -609.7,-638.82 -1046.38,-733.6 -86.12,-18.68 -171.43,36.15 -190.2,122.32 -18.68,86.12 36.15,171.43 122.32,190.19l0.07 -0.07z"/>
|
||||
<path class="fil0" d="M1765.12 2135.2c159.79,137.95 -47.11,377.6 -206.9,239.65 -159.79,-137.95 47.11,-377.6 206.9,-239.65z"/>
|
||||
<path class="fil0" d="M324.48 2355.38c-29.95,-359.29 83.33,-707.2 318.62,-979.73 235.34,-272.59 563.02,-435.29 922.76,-458.15 44.71,-2.79 84.05,-23.88 110.97,-55.06 26.91,-31.17 41.27,-71.26 38.58,-114.57 -5.55,-87.96 -81.74,-155.02 -169.69,-149.48 -446.15,28.44 -852.62,230.13 -1144.6,568.32 -291.91,338.12 -432.4,769.97 -395.24,1215.27 7.34,87.82 84.73,153.35 172.63,146.07 87.82,-7.34 153.35,-84.73 146.07,-172.63l-0.09 -0.04z"/>
|
||||
|
|
@ -31,8 +29,6 @@ viewBox="0 0 17484.57 3960.9"
|
|||
<path class="fil0" d="M1750.82 1872.33c25.7,-29.77 40.54,-68.92 38.62,-111.19 -3.77,-88.23 -78.19,-156.6 -166.57,-153.09 -175.23,7.18 -341.42,87.66 -455.97,220.35 -114.55,132.68 -169.66,308.52 -151.46,483.24 9.14,87.82 87.99,151.52 175.76,142.45 87.82,-9.13 151.52,-87.99 142.45,-175.75 -9.23,-88.17 17.36,-173.79 75.27,-240.86 57.9,-67.07 138.5,-106.06 227.29,-109.6 45.89,-1.77 86.41,-22.88 114.47,-55.38l0.15 -0.17z"/>
|
||||
<path class="fil0" d="M1714.29 1378.19c26.15,-30.29 41.11,-70.61 38.58,-113.69 -5.14,-88.12 -80.75,-155.58 -168.87,-150.43 -308.84,17.67 -590.11,156.49 -791.96,390.29 -201.85,233.81 -298.15,532.33 -270.57,840.43 7.76,87.94 85.52,152.87 173.45,145.12 87.93,-7.77 152.87,-85.53 145.11,-173.46 -19.88,-221.14 49.25,-435.33 194.02,-603.03 144.84,-167.76 346.8,-267.13 568.27,-279.92 44.99,-2.54 84.63,-23.64 111.8,-55.12l0.17 -0.2z"/>
|
||||
</g>
|
||||
<rect class="fil1" x="3027.2" y="632.27" width="305.9" height="3268.63" rx="151.33" ry="554.94"/>
|
||||
</g>
|
||||
</g>
|
||||
<path class="fil1" d="M3181.77 632.27l-3.25 0c-83.23,0 -151.32,68.1 -151.32,151.32l0 2966c0,83.22 68.09,151.31 151.32,151.31l3.25 0c83.23,0 151.32,-68.09 151.32,-151.31l0 -2966c0,-83.22 -68.09,-151.32 -151.32,-151.32z"/>
|
||||
</g>
|
||||
</svg>
|
||||
|
|
|
|||
|
Przed Szerokość: | Wysokość: | Rozmiar: 6.5 KiB Po Szerokość: | Wysokość: | Rozmiar: 6.6 KiB |
|
|
@ -39,47 +39,49 @@ Using the `-c` argument allows for configuration with a YAML structured file. Th
|
|||
|
||||
## Field Descriptions
|
||||
|
||||
### listeners (mapping)
|
||||
### `listeners`
|
||||
|
||||
Defines network listeners for the MQTT server.
|
||||
Defines network listeners for the MQTT server (list).
|
||||
|
||||
#### <interface name> (mapping)
|
||||
`default` for parameters to be used across all specified interfaces or user-specified name for the specific interface.
|
||||
The listener configuration.
|
||||
#### `<interface name>`
|
||||
`default` for parameters used across all interfaces _or_ name for the specific interface (mapping).
|
||||
|
||||
- **bind** (*string*, required)
|
||||
Each entry supports these parameters:
|
||||
|
||||
- `bind` (string, *required*)
|
||||
Address and port to bind to, in the form `host:port` (e.g., `0.0.0.0:1883`).
|
||||
|
||||
- **type** (*string*, optional)
|
||||
- `type` (string, *required*)
|
||||
Protocol type. Typically `"tcp"` or `"ws"`.
|
||||
|
||||
- **max-connections** (*integer*, optional)
|
||||
- `max-connections` (integer, *required*)
|
||||
Maximum number of clients that can connect to this interface
|
||||
|
||||
- **ssl** (*string*, default: `off`)
|
||||
Enable (on) or disable (off) SSL. One of `cafile`, `capath`, `cadata` or `certfile`/`keyfile`.
|
||||
- `ssl` (string, *optional, default: `off`*)
|
||||
Disable (`off`) SSL/TLS or enable (`on`) with one of `cafile`, `capath`, `cadata` or `certfile`/`keyfile`.
|
||||
|
||||
- **cafile** (*string*, optional)
|
||||
- `cafile` (string, *optional*)
|
||||
Path to a file of concatenated CA certificates in PEM format. See [Certificates](https://docs.python.org/3/library/ssl.html#ssl-certificates) for more info.
|
||||
|
||||
- **capath** (*string*, optional)
|
||||
- `capath` (string, *optional*)
|
||||
Path to a directory containing several CA certificates in PEM format, following an [OpenSSL specific layout](https://docs.openssl.org/master/man3/SSL_CTX_load_verify_locations/).
|
||||
|
||||
- **cadata** (*string*, optional)
|
||||
- `cadata` (string, *optional*)
|
||||
Either an ASCII string of one or more PEM-encoded certificates or a bytes-like object of DER-encoded certificates
|
||||
|
||||
- **certfile** (*string*, optional)
|
||||
- `certfile` (string, *optional*)
|
||||
Path to a single file in PEM format containing the certificate as well as any number of CA certificates needed to establish the certificate's authenticity
|
||||
|
||||
- **keyfile** (*string*, optional)
|
||||
- `keyfile` (string, *optional*)
|
||||
A file containing the private key. Otherwise the private key will be taken from certfile as well
|
||||
|
||||
### timeout-disconnect-delay (*integer*, optional)
|
||||
### timeout-disconnect-delay
|
||||
|
||||
Client disconnect timeout without a keep-alive
|
||||
Client disconnect timeout without a keep-alive (integer, *optional*)
|
||||
|
||||
### plugins (*list of strings*)
|
||||
A list of plugin names to load. Common values include:
|
||||
### plugins
|
||||
|
||||
Entry points for optional functionality (*list of strings*); included plugins are:
|
||||
|
||||
- `auth_file` – Enables file-based authentication
|
||||
- `auth_anonymous` – Enables anonymous access
|
||||
|
|
@ -89,15 +91,15 @@ A list of plugin names to load. Common values include:
|
|||
- `topic_acl`
|
||||
- `broker_sys`
|
||||
|
||||
### auth (mapping)
|
||||
### auth
|
||||
|
||||
Authentication and authorization settings.
|
||||
Authentication and authorization settings (mapping).
|
||||
|
||||
- **allow-anonymous** (*boolean*)
|
||||
Whether to allow anonymous clients to connect (`true` or `false`).
|
||||
- `allow-anonymous` (boolean, *optional for `auth_anonymous` plugin*)
|
||||
Allow (`true`) or prevent (`false`) anonymous client to connections.
|
||||
|
||||
- **password-file** (*string*, required for `auth_file` plugin)
|
||||
Lines of `username:password` combination where the password is sha-512 encoded using `mkpasswd -m sha-512` or:
|
||||
- `password-file` (string, *required for `auth_file` plugin*)
|
||||
Path to file which includes `username:password` pair, one per line. The password should be encoded using sha-512 with `mkpasswd -m sha-512` or:
|
||||
|
||||
```python
|
||||
import sys
|
||||
|
|
@ -108,9 +110,9 @@ passwd = input() if not sys.stdin.isatty() else getpass()
|
|||
print(sha512_crypt.hash(passwd))
|
||||
```
|
||||
|
||||
### sys-interval (*integer*, optional for `broker_sys` plugin, defaults to TBD)
|
||||
### sys-interval
|
||||
|
||||
Interval in seconds to publish system statistics to `$SYS` topics.
|
||||
Interval in seconds to publish system statistics to `$SYS` topics (integer, *optional for `broker_sys` plugin, defaults to TBD*).
|
||||
|
||||
## Configuration example
|
||||
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
site_name: ""
|
||||
site_description: "Automatic documentation from sources, for MkDocs."
|
||||
site_url: http://github.com
|
||||
repo_url: http://github.com/abc/amqtt
|
||||
repo_name: abc/amqtt
|
||||
repo_url: https://github.com/Yakifo/amqtt
|
||||
repo_name: Yakifo/amqtt
|
||||
site_dir: "site"
|
||||
watch: [mkdocs.yml, README.md, CONTRIBUTING.md, docs, amqtt]
|
||||
copyright: TBD
|
||||
|
|
@ -17,11 +17,11 @@ nav:
|
|||
- Home:
|
||||
- Overview: index.md
|
||||
- Quickstart: quickstart.md
|
||||
- Usage:
|
||||
- CLI Usage:
|
||||
- Broker: references/amqtt.md
|
||||
- Publisher: references/amqtt_pub.md
|
||||
- Subscriber: references/amqtt_sub.md
|
||||
- API:
|
||||
- API Usage:
|
||||
- Broker: references/broker.md
|
||||
- Client: references/client.md
|
||||
# - Changelog: changelog.md
|
||||
|
|
|
|||
Ładowanie…
Reference in New Issue