├── .github ├── dependabot.yaml └── workflows │ ├── linter.yaml │ ├── pr-check.yaml │ └── publish.yaml ├── .gitignore ├── CODEOWNERS ├── LICENSE ├── MANIFEST.in ├── README.md ├── docs ├── architecture.dot └── architecture.png ├── requirements.txt ├── respondd.py ├── setup.py ├── unifi_respondd.init.d.example ├── unifi_respondd.service.example ├── unifi_respondd.yaml.example └── unifi_respondd ├── config.py ├── logger.py ├── respondd_client.py └── unifi_client.py /.github/dependabot.yaml: -------------------------------------------------------------------------------- 1 | # To get started with Dependabot version updates, you'll need to specify which 2 | # package ecosystems to update and where the package manifests are located. 3 | # Please see the documentation for all configuration options: 4 | # https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file 5 | 6 | version: 2 7 | updates: 8 | - package-ecosystem: "pip" # See documentation for possible values 9 | directory: "/" # Location of package manifests 10 | schedule: 11 | interval: "monthly" 12 | - package-ecosystem: "github-actions" 13 | directory: / 14 | schedule: 15 | interval: "monthly" 16 | -------------------------------------------------------------------------------- /.github/workflows/linter.yaml: -------------------------------------------------------------------------------- 1 | name: Lint 2 | 3 | on: [push, pull_request] 4 | 5 | permissions: 6 | contents: read 7 | 8 | jobs: 9 | black: 10 | runs-on: ubuntu-latest 11 | steps: 12 | - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 13 | - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0 14 | - uses: psf/black@8a737e727ac5ab2f1d4cf5876720ed276dc8dc4b # v25.1.0 15 | -------------------------------------------------------------------------------- /.github/workflows/pr-check.yaml: -------------------------------------------------------------------------------- 1 | name: Test Pull Requests 2 | 3 | on: 4 | pull_request: 5 | permissions: 6 | contents: read 7 | 8 | jobs: 9 | test: 10 | name: Test Pull Requests 11 | runs-on: ubuntu-latest 12 | strategy: 13 | matrix: 14 | python-version: ["3.12", "3.13"] 15 | steps: 16 | - name: Checkout repository 17 | uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 18 | 19 | - name: Set up Python ${{ matrix.python-version }} 20 | uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0 21 | with: 22 | python-version: ${{ matrix.python-version }} 23 | 24 | - name: Display Python version 25 | run: python -c "import sys; print(sys.version)" 26 | 27 | - name: Install dependencies 28 | run: | 29 | python -m pip install --upgrade pip setuptools wheel build 30 | 31 | - name: Build distributions 32 | run: python -m build --sdist --wheel --outdir dist/ 33 | 34 | - name: Test build 35 | run: | 36 | python -m pip install dist/*.whl 37 | # Optional: Add commands to test the package functionality 38 | -------------------------------------------------------------------------------- /.github/workflows/publish.yaml: -------------------------------------------------------------------------------- 1 | name: Publish Tag Releases to PyPI 2 | 3 | on: 4 | push: 5 | tags: 6 | - "v*" 7 | permissions: 8 | contents: read 9 | packages: write 10 | 11 | jobs: 12 | publish: 13 | name: Build and Publish to PyPI 14 | runs-on: ubuntu-latest 15 | steps: 16 | - name: Checkout repository 17 | uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 18 | 19 | - name: Set up Python 3.13 20 | uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0 21 | with: 22 | python-version: "3.13" 23 | 24 | - name: Display Python version 25 | run: python -c "import sys; print(sys.version)" 26 | 27 | - name: Install dependencies 28 | run: | 29 | python -m pip install --upgrade pip setuptools wheel build 30 | 31 | - name: Get version from git tag 32 | run: sed -i s/VERSION/$(git describe --tags --always)/g setup.py 33 | 34 | - name: Build distributions 35 | run: python -m build --sdist --wheel --outdir dist/ 36 | 37 | - name: Publish package distributions to TestPyPI 38 | uses: pypa/gh-action-pypi-publish@76f52bc884231f62b9a034ebfe128415bbaabdfc # v1.12.4 39 | with: 40 | repository-url: https://test.pypi.org/legacy/ 41 | password: ${{ secrets.TEST_PYPI_API_TOKEN }} 42 | 43 | - name: Publish package distributions to PyPI 44 | uses: pypa/gh-action-pypi-publish@76f52bc884231f62b9a034ebfe128415bbaabdfc # v1.12.4 45 | with: 46 | password: ${{ secrets.PYPI_API_TOKEN }} 47 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | pip-wheel-metadata/ 24 | share/python-wheels/ 25 | *.egg-info/ 26 | .installed.cfg 27 | *.egg 28 | MANIFEST 29 | 30 | # PyInstaller 31 | # Usually these files are written by a python script from a template 32 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 33 | *.manifest 34 | *.spec 35 | 36 | # Installer logs 37 | pip-log.txt 38 | pip-delete-this-directory.txt 39 | 40 | # Unit test / coverage reports 41 | htmlcov/ 42 | .tox/ 43 | .nox/ 44 | .coverage 45 | .coverage.* 46 | .cache 47 | nosetests.xml 48 | coverage.xml 49 | *.cover 50 | *.py,cover 51 | .hypothesis/ 52 | .pytest_cache/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | target/ 76 | 77 | # Jupyter Notebook 78 | .ipynb_checkpoints 79 | 80 | # IPython 81 | profile_default/ 82 | ipython_config.py 83 | 84 | # pyenv 85 | .python-version 86 | 87 | # pipenv 88 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 89 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 90 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 91 | # install all needed dependencies. 92 | #Pipfile.lock 93 | 94 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow 95 | __pypackages__/ 96 | 97 | # Celery stuff 98 | celerybeat-schedule 99 | celerybeat.pid 100 | 101 | # SageMath parsed files 102 | *.sage.py 103 | 104 | # Environments 105 | .env 106 | .venv 107 | env/ 108 | venv/ 109 | ENV/ 110 | env.bak/ 111 | venv.bak/ 112 | 113 | # Spyder project settings 114 | .spyderproject 115 | .spyproject 116 | 117 | # Rope project settings 118 | .ropeproject 119 | 120 | # mkdocs documentation 121 | /site 122 | 123 | # mypy 124 | .mypy_cache/ 125 | .dmypy.json 126 | dmypy.json 127 | 128 | # Pyre type checker 129 | .pyre/ 130 | unifi_respondd.yaml 131 | -------------------------------------------------------------------------------- /CODEOWNERS: -------------------------------------------------------------------------------- 1 | * @freifunkMUC/firmware 2 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include README.md 2 | include docs/* 3 | include respondd.py 4 | include *.example -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # unifi_respondd 2 | 3 | This queries the API of a UniFi controller to get the current status of the Accesspoints and sends the information via the respondd protocol. Thus it can be picked up by `yanic` and other respondd queriers. 4 | 5 | ## Overview 6 | 7 | ```mermaid 8 | graph TD; 9 | A{"*respondd_main*"} -->| | B("*unifi_client*") 10 | A -->| | C("*respondd_client*") 11 | B -->|"RestFul API"| D("unifi_controller") 12 | C -->|"Subscribe"| E("multicast") 13 | C -->|"Send per interval / On multicast request"| F("unicast") 14 | G{"yanic"} -->|"Request metrics"| E 15 | F -->|"Receive"| G 16 | ``` 17 | 18 | ## Config File: 19 | ```yaml 20 | controller_url: unifi.lan 21 | controller_port: 8443 22 | username: ubnt 23 | password: ubnt 24 | ssid_regex: .*freifunk.* 25 | offloader_mac: 26 | SiteName: 00:00:00:00:00:00 27 | SiteName2: 00:00:00:00:00:00 28 | nodelist: https://MAPURL/data/meshviewer.json 29 | version: v5 30 | ssl_verify: True 31 | multicast_enabled: false 32 | multicast_address: ff05::2:1001 33 | multicast_port: 1001 34 | unicast_address: fe80::68ff:94ff:fe00:1504 35 | unicast_port: 10001 36 | interface: eth0 37 | verbose: true 38 | logging_config: 39 | formatters: 40 | standard: 41 | format: '%(asctime)s,%(msecs)d %(levelname)-8s [%(filename)s:%(lineno)d] %(message)s' 42 | handlers: 43 | console: 44 | class: logging.StreamHandler 45 | formatter: standard 46 | root: 47 | handlers: 48 | - console 49 | level: DEBUG 50 | version: 1 51 | fallback_domain: "unifi_respondd_fallback" # optional 52 | ``` 53 | -------------------------------------------------------------------------------- /docs/architecture.dot: -------------------------------------------------------------------------------- 1 | # http://www.graphviz.org/content/cluster 2 | 3 | digraph G { 4 | graph [fontname = "Handlee"]; 5 | node [fontname = "Handlee"]; 6 | edge [fontname = "Handlee"]; 7 | 8 | bgcolor=transparent; 9 | 10 | subgraph unifi_client { 11 | style=filled; 12 | color=lightgrey; 13 | style="dotted" 14 | node [style=filled,color="#d8b365"]; 15 | unifi_client [label="*unifi_client*"]; 16 | fontsize = 20; 17 | } 18 | 19 | subgraph respondd { 20 | node [style=filled,color="#f5f5f5"]; 21 | style="dotted" 22 | respondd [label="*respondd_main*"]; 23 | fontsize = 20; 24 | color=blue 25 | } 26 | subgraph respondd_client { 27 | node [style=filled,color="#5ab4ac"]; 28 | style="dotted" 29 | color=blue; 30 | label = "*respondd_client*"; 31 | fontsize = 20; 32 | color=blue 33 | multicast -> respondd_client -> multicast[style=invis]; 34 | respondd_client [label="*respondd_client*"]; 35 | } 36 | 37 | yanic [shape=Mdiamond]; 38 | respondd [shape=Mdiamond] 39 | 40 | unifi_client -> unifi_controller [label="RESTFul API"]; 41 | respondd_client -> multicast [label="Subscribe"]; 42 | respondd_client -> unicast [label="Send per interval / On multicast request"]; 43 | unicast -> yanic [label="Receive"] 44 | yanic -> multicast [label="Request metrics"] 45 | respondd -> respondd_client 46 | respondd -> unifi_client 47 | {rank=same unifi_controller multicast unicast} 48 | {rank=same unifi_client respondd_client} 49 | } 50 | -------------------------------------------------------------------------------- /docs/architecture.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/freifunkMUC/unifi_respondd/d0069971555c55e354ac385b02deed50ee11a1a2/docs/architecture.png -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | pyunifi==2.21 2 | geopy==2.4.1 3 | pyyaml==6.0.2 4 | dataclasses_json==0.6.7 5 | -------------------------------------------------------------------------------- /respondd.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | import unifi_respondd.config as config 4 | from unifi_respondd.respondd_client import ResponddClient 5 | 6 | 7 | def main(): 8 | cfg = config.Config.from_dict(config.load_config()) 9 | extResponddClient = ResponddClient(cfg) 10 | extResponddClient.start() 11 | 12 | 13 | if __name__ == "__main__": 14 | main() 15 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | import os 2 | from setuptools import setup 3 | 4 | 5 | def read(fname): 6 | return open(os.path.join(os.path.dirname(__file__), fname)).read() 7 | 8 | 9 | setup( 10 | name="unifi_respondd", 11 | version="VERSION", 12 | author="Annika Wickert", 13 | author_email="aw@awlnx.space", 14 | description=("A tool to display Unifi APs on Freifunk maps."), 15 | license="GPLv3", 16 | keywords="Unifi Freifunk", 17 | url="http://packages.python.org/unifi_respondd", 18 | packages=["unifi_respondd"], 19 | long_description=read("README.md"), 20 | long_description_content_type="text/markdown", 21 | include_package_data=True, 22 | install_requires=[ 23 | "pyunifi==2.21", 24 | "geopy==2.4.1", 25 | "pyyaml==6.0.2", 26 | "dataclasses_json==0.6.7", 27 | ], 28 | ) 29 | -------------------------------------------------------------------------------- /unifi_respondd.init.d.example: -------------------------------------------------------------------------------- 1 | #!/bin/sh /etc/rc.common 2 | USE_PROCD=1 3 | START=95 4 | STOP=01 5 | start_service() { 6 | procd_open_instance 7 | procd_set_param command /usr/bin/python3 /tmp/unifi_respondd/respond.py 8 | procd_set_param stdout 1 9 | procd_set_param stderr 1 10 | procd_set_param env UNIFI_RESPONDD_CONFIG_FILE=/tmp/unifi_respondd/unifi_respondd.yaml 11 | procd_close_instance 12 | } -------------------------------------------------------------------------------- /unifi_respondd.service.example: -------------------------------------------------------------------------------- 1 | [Unit] 2 | Description=unifi_respondd 3 | After=syslog.target network-online.target 4 | 5 | [Service] 6 | Type=simple 7 | DynamicUser=yes 8 | WorkingDirectory=/opt/unifi_respondd 9 | ExecStart=/opt/unifi_respondd/respondd.py 10 | Restart=always 11 | 12 | CapabilityBoundingSet=CAP_NET_BIND_SERVICE CAP_NET_RAW 13 | AmbientCapabilities=CAP_NET_BIND_SERVICE CAP_NET_RAW 14 | 15 | [Install] 16 | WantedBy=multi-user.target 17 | -------------------------------------------------------------------------------- /unifi_respondd.yaml.example: -------------------------------------------------------------------------------- 1 | controller_url: unifi.lan 2 | controller_port: 8443 3 | username: ubnt 4 | password: ubnt 5 | ssid_regex: .*freifunk.* 6 | offloader_mac: 7 | SiteName: 00:00:00:00:00:00 8 | SiteName2: 00:00:00:00:00:00 9 | nodelist: https://MAPURL/data/meshviewer.json 10 | version: v5 11 | ssl_verify: True 12 | multicast_enabled: false 13 | multicast_address: ff05::2:1001 14 | multicast_port: 1001 15 | unicast_address: fe80::68ff:94ff:fe00:1504 16 | unicast_port: 10001 17 | interface: eth0 18 | verbose: true 19 | logging_config: 20 | formatters: 21 | standard: 22 | format: '%(asctime)s,%(msecs)d %(levelname)-8s [%(filename)s:%(lineno)d] %(message)s' 23 | handlers: 24 | console: 25 | class: logging.StreamHandler 26 | formatter: standard 27 | root: 28 | handlers: 29 | - console 30 | level: DEBUG 31 | version: 1 32 | fallback_domain: "unifi_respondd_fallback" # optional 33 | -------------------------------------------------------------------------------- /unifi_respondd/config.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | from functools import lru_cache 3 | import yaml 4 | import os 5 | from typing import List, Dict, Any, Union, Optional 6 | import dataclasses 7 | import sys 8 | 9 | UNIFI_RESPONDD_CONFIG_OS_ENV = "UNIFI_RESPONDD_CONFIG_FILE" 10 | UNIFI_RESPONDD_CONFIG_DEFAULT_LOCATION = "./unifi_respondd.yaml" 11 | 12 | 13 | class Error(Exception): 14 | """Base Exception handling class.""" 15 | 16 | 17 | class ConfigFileNotFoundError(Error): 18 | """File could not be found on disk.""" 19 | 20 | 21 | @dataclasses.dataclass 22 | class Config: 23 | """A representation of the configuration file. 24 | Attributes: 25 | controller_url: The unifi controller URL. 26 | controller_port: The unifi Controller port. 27 | username: The username for unifi controller. 28 | password: The password for unifi controller. 29 | """ 30 | 31 | controller_url: str 32 | controller_port: int 33 | username: str 34 | password: str 35 | ssid_regex: str 36 | offloader_mac: Dict[str, str] 37 | nodelist: str 38 | fallback_domain: str 39 | 40 | multicast_address: str 41 | multicast_port: int 42 | unicast_address: str 43 | unicast_port: int 44 | interface: str 45 | verbose: bool = False 46 | multicast_enabled: bool = True 47 | 48 | version: str = "v5" 49 | ssl_verify: bool = True 50 | 51 | @classmethod 52 | def from_dict(cls, cfg: Dict[str, str]) -> "Config": 53 | """Creates a Config object from a configuration file. 54 | Arguments: 55 | cfg: The configuration file as a dict. 56 | Returns: 57 | A Config object. 58 | """ 59 | 60 | return cls( 61 | controller_url=cfg["controller_url"], 62 | controller_port=cfg["controller_port"], 63 | username=cfg["username"], 64 | password=cfg["password"], 65 | ssid_regex=cfg["ssid_regex"], 66 | offloader_mac=cfg["offloader_mac"], 67 | nodelist=cfg["nodelist"], 68 | fallback_domain=cfg.get("fallback_domain", "unifi_respondd_fallback"), 69 | version=cfg["version"], 70 | ssl_verify=cfg["ssl_verify"], 71 | multicast_enabled=cfg["multicast_enabled"], 72 | multicast_address=cfg["multicast_address"], 73 | multicast_port=cfg["multicast_port"], 74 | unicast_address=cfg["unicast_address"], 75 | unicast_port=cfg["unicast_port"], 76 | interface=cfg["interface"], 77 | verbose=cfg["verbose"], 78 | ) 79 | 80 | 81 | @lru_cache(maxsize=10) 82 | def fetch_from_config(key: str) -> Optional[Union[Dict[str, Any], List[str]]]: 83 | """Fetches a specific key from configuration. 84 | Arguments: 85 | key: The named key to fetch. 86 | Returns: 87 | The config value associated with the key 88 | """ 89 | return load_config().get(key) 90 | 91 | 92 | def load_config() -> Dict[str, str]: 93 | """Fetches and validates configuration file from disk. 94 | Returns: 95 | Linted configuration file. 96 | """ 97 | cfg_contents = fetch_config_from_disk() 98 | try: 99 | config = yaml.safe_load(cfg_contents) 100 | except yaml.YAMLError as e: 101 | print("Failed to load YAML file: %s", e) 102 | sys.exit(1) 103 | try: 104 | _ = Config.from_dict(config) 105 | return config 106 | except (KeyError, TypeError) as e: 107 | print("Failed to lint file: %s", e) 108 | sys.exit(2) 109 | 110 | 111 | def fetch_config_from_disk() -> str: 112 | """Fetches config file from disk and returns as string. 113 | Raises: 114 | ConfigFileNotFoundError: If we could not find the configuration file on disk. 115 | Returns: 116 | The file contents as string. 117 | """ 118 | config_file = os.environ.get( 119 | UNIFI_RESPONDD_CONFIG_OS_ENV, UNIFI_RESPONDD_CONFIG_DEFAULT_LOCATION 120 | ) 121 | try: 122 | with open(config_file, "r") as stream: 123 | return stream.read() 124 | except FileNotFoundError as e: 125 | raise ConfigFileNotFoundError( 126 | f"Could not locate configuration file in {config_file}" 127 | ) from e 128 | -------------------------------------------------------------------------------- /unifi_respondd/logger.py: -------------------------------------------------------------------------------- 1 | from logging import basicConfig 2 | from logging import DEBUG 3 | from logging import info as info 4 | from logging import warning as warning 5 | from logging import error as error 6 | from logging import critical as critical 7 | from logging import debug as debug 8 | from logging import config 9 | import yaml 10 | import os.path 11 | from unifi_respondd.config import UNIFI_RESPONDD_CONFIG_DEFAULT_LOCATION 12 | 13 | _LOGGING_DEFAULT_CONFIG = { 14 | "version": 1, 15 | "handlers": { 16 | "console": { 17 | "class": "logging.StreamHandler", 18 | "formatter": "standard", 19 | } 20 | }, 21 | "formatters": { 22 | "standard": { 23 | "format": "%(asctime)s,%(msecs)d %(levelname)-8s [%(filename)s:%(lineno)d] %(message)s" 24 | }, 25 | }, 26 | "root": {"level": "DEBUG", "handlers": ["console"]}, 27 | } 28 | 29 | 30 | def fetch_logging_configuration(): 31 | """Fetches logging configuration from disk, if exists. 32 | 33 | If the config exists, then we check to see if the key 'logging_config' is set. If it is, we return this configuration. 34 | Otherwise, we return the default configuration (_LOGGING_DEFAULT_CONFIG). 35 | 36 | Returns: 37 | Logging configuration. 38 | """ 39 | logging_cfg = dict() 40 | if os.path.isfile(UNIFI_RESPONDD_CONFIG_DEFAULT_LOCATION): 41 | with open(UNIFI_RESPONDD_CONFIG_DEFAULT_LOCATION) as cfg_file: 42 | logging_cfg = yaml.load(cfg_file, Loader=yaml.FullLoader) 43 | if logging_cfg.get("logging_config"): 44 | return logging_cfg.get("logging_config") 45 | return _LOGGING_DEFAULT_CONFIG 46 | 47 | 48 | cfg = fetch_logging_configuration() 49 | config.dictConfig(cfg) 50 | info("Initialised logger, using configuration: %s", cfg) 51 | -------------------------------------------------------------------------------- /unifi_respondd/respondd_client.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | import socket 4 | import struct 5 | import json 6 | import zlib 7 | import time 8 | 9 | import dataclasses 10 | from dataclasses_json import dataclass_json 11 | from unifi_respondd import unifi_client 12 | from unifi_respondd import logger 13 | from typing import List, Dict 14 | 15 | 16 | @dataclasses.dataclass 17 | class FirmwareInfo: 18 | """This class contains the firmware information of an AP. 19 | Attributes: 20 | base: The base version of the firmware. 21 | release: The release version of the firmware.""" 22 | 23 | base: str 24 | release: str 25 | 26 | 27 | @dataclasses.dataclass 28 | class LocationInfo: 29 | """This class contains the location information of an AP. 30 | Attributes: 31 | latitude: The latitude of the AP. 32 | longitude: The longitude of the AP.""" 33 | 34 | latitude: float 35 | longitude: float 36 | 37 | 38 | @dataclasses.dataclass 39 | class HardwareInfo: 40 | """This class contains the hardware information of an AP. 41 | Attributes: 42 | model: The hardware model of the AP.""" 43 | 44 | model: str 45 | nproc: int = 1 46 | 47 | 48 | @dataclasses.dataclass 49 | class OwnerInfo: 50 | """This class contains the owner information of an AP. 51 | Attributes: 52 | contact: The contact of the AP for example an email address.""" 53 | 54 | contact: str 55 | 56 | 57 | @dataclasses.dataclass 58 | class SoftwareInfo: 59 | """This class contains the software information of an AP. 60 | Attributes: 61 | firmware: The firmware information of the AP.""" 62 | 63 | firmware: FirmwareInfo 64 | 65 | 66 | @dataclasses.dataclass 67 | class InterfacesInfo: 68 | other: List[str] 69 | 70 | 71 | @dataclasses.dataclass 72 | class IntInfo: 73 | interfaces: InterfacesInfo 74 | 75 | 76 | @dataclasses.dataclass 77 | class NetworkInfo: 78 | """This class contains the network information of an AP. 79 | Attributes: 80 | mac: The MAC address of the AP.""" 81 | 82 | mac: str 83 | mesh: Dict[str, IntInfo] 84 | 85 | 86 | @dataclasses.dataclass 87 | class SystemInfo: 88 | domain_code: str 89 | 90 | 91 | @dataclass_json 92 | @dataclasses.dataclass 93 | class NodeInfo: 94 | """This class contains the node information of an AP. 95 | Attributes: 96 | software: The software information of the AP. 97 | hostname: The hostname of the AP. 98 | node_id: The node id of the AP. This is the same as the MAC address (without :). 99 | location: The location information of the AP. 100 | hardware: The hardware information of the AP. 101 | owner: The owner information of the AP. 102 | network: The network information of the AP.""" 103 | 104 | software: SoftwareInfo 105 | hostname: str 106 | node_id: str 107 | location: LocationInfo 108 | hardware: HardwareInfo 109 | owner: OwnerInfo 110 | network: NetworkInfo 111 | system: SystemInfo 112 | 113 | 114 | @dataclasses.dataclass 115 | class ClientInfo: 116 | """This class contains the client information of an AP. 117 | Attributes: 118 | total: The total number of clients. 119 | wifi: The number of clients connected via WiFi. 120 | wifi24: The number of clients connected via 2,4ghz WiFi. 121 | wifi5: The number of clients connected via 5ghz WiFi.""" 122 | 123 | total: int 124 | wifi: int 125 | wifi24: int 126 | wifi5: int 127 | 128 | 129 | @dataclasses.dataclass 130 | class WirelessInfo: 131 | """This class contains the Wireless information of an AP. 132 | Attributes: 133 | frequency: 134 | noise: 135 | active: 136 | busy: 137 | rx: 138 | tx:""" 139 | 140 | frequency: int 141 | # noise: int 142 | # active: int 143 | # busy: int 144 | rx: int 145 | tx: int 146 | 147 | 148 | @dataclasses.dataclass 149 | class MemoryInfo: 150 | """This class contains the memory information of an AP. 151 | Attributes: 152 | total: The total memory of the AP. 153 | free: The free memory of the AP. 154 | buffers: The buffer memory of the AP.""" 155 | 156 | total: int 157 | free: int 158 | buffers: int 159 | 160 | 161 | @dataclasses.dataclass 162 | class txInfo: 163 | """This class contains the tx information of an AP. 164 | Attributes: 165 | bytes: The number of bytes transmitted.""" 166 | 167 | bytes: int 168 | 169 | 170 | @dataclasses.dataclass 171 | class rxInfo: 172 | """This class contains the rx information of an AP. 173 | Attributes: 174 | bytes: The number of bytes received.""" 175 | 176 | bytes: int 177 | 178 | 179 | @dataclasses.dataclass 180 | class TrafficInfo: 181 | """This class contains the traffic information of an AP. 182 | Attributes: 183 | tx: The tx information of the AP. 184 | rx: The rx information of the AP.""" 185 | 186 | tx: txInfo 187 | rx: rxInfo 188 | 189 | 190 | @dataclass_json 191 | @dataclasses.dataclass 192 | class StatisticsInfo: 193 | """This class contains the statistics information of an AP. 194 | Attributes: 195 | clients: The client information of the AP. 196 | uptime: The uptime of the AP. 197 | node_id: The node id of the AP. This is the same as the MAC address (without :). 198 | loadavg: The load average of the AP. 199 | memory: The memory information of the AP. 200 | traffic: The traffic information of the AP. 201 | gateway: The MAC of the IPv4 Gateway 202 | gateway6: The MAC of the IPv6 Gateway 203 | gateway_nexthop: The MAC of the nexthop Gateway 204 | wireless: The WirelessInfos of the AP""" 205 | 206 | clients: ClientInfo 207 | uptime: int 208 | node_id: str 209 | loadavg: float 210 | memory: MemoryInfo 211 | traffic: TrafficInfo 212 | gateway: str 213 | gateway6: str 214 | gateway_nexthop: str 215 | wireless: List[WirelessInfo] 216 | 217 | 218 | @dataclasses.dataclass 219 | class NeighbourDetails: 220 | tq: int 221 | lastseen: float 222 | 223 | 224 | @dataclasses.dataclass 225 | class Neighbours: 226 | neighbours: Dict[str, NeighbourDetails] 227 | 228 | 229 | @dataclass_json 230 | @dataclasses.dataclass 231 | class NeighboursInfo: 232 | node_id: str 233 | batadv: Dict[str, Neighbours] 234 | 235 | 236 | class ResponddClient: 237 | """This class receives a request from the respondd server and returns the response.""" 238 | 239 | def __init__(self, config): 240 | self._config = config 241 | self._aps = None 242 | self._timeStart = time.time() 243 | self._timeStop = time.time() 244 | self._sock = socket.socket(socket.AF_INET6, socket.SOCK_DGRAM) 245 | 246 | @property 247 | def _nodeinfos(self): 248 | return self.getNodeInfos() 249 | 250 | @property 251 | def _statistics(self): 252 | return self.getStatistics() 253 | 254 | @property 255 | def _neighbours(self): 256 | return self.getNeighbours() 257 | 258 | @staticmethod 259 | def joinMCAST(sock, addr, ifname): 260 | """Joins a multicast group on a socket.""" 261 | group = socket.inet_pton(socket.AF_INET6, addr) 262 | if_idx = socket.if_nametoindex(ifname) 263 | sock.setsockopt( 264 | socket.IPPROTO_IPV6, 265 | socket.IPV6_JOIN_GROUP, 266 | group + struct.pack("I", if_idx), 267 | ) 268 | 269 | def getNodeInfos(self): 270 | """This method returns the node information of all APs.""" 271 | aps = self._aps 272 | nodes = [] 273 | for ap in aps.accesspoints: 274 | nodes.append( 275 | NodeInfo( 276 | software=SoftwareInfo( 277 | firmware=FirmwareInfo(base="UniFi", release=ap.firmware) 278 | ), 279 | hostname=ap.name, 280 | node_id=ap.mac.replace(":", ""), 281 | location=LocationInfo(latitude=ap.latitude, longitude=ap.longitude), 282 | hardware=HardwareInfo(model=ap.model), 283 | owner=OwnerInfo(contact=ap.contact), 284 | network=NetworkInfo( 285 | mac=ap.mac, 286 | mesh={ 287 | "bat0": IntInfo(interfaces=InterfacesInfo(other=[ap.mac])) 288 | }, 289 | ), 290 | system=SystemInfo(domain_code=ap.domain_code), 291 | ) 292 | ) 293 | return nodes 294 | 295 | @staticmethod 296 | def frequency_from_channel(channel): 297 | if channel >= 36: 298 | return 5000 + (channel) * 5 299 | else: 300 | if channel == 14: 301 | return 2484 302 | elif channel < 14: 303 | return 2407 + (channel) * 5 304 | 305 | def getStatistics(self): 306 | """This method returns the statistics information of all APs.""" 307 | aps = self._aps 308 | statistics = [] 309 | for ap in aps.accesspoints: 310 | wirelessinfos = [] 311 | 312 | if ap.channel5: 313 | frequency5 = self.frequency_from_channel(ap.channel5) 314 | wirelessinfos.append( 315 | WirelessInfo( 316 | frequency=frequency5, 317 | rx=ap.rx_bytes5, 318 | tx=ap.tx_bytes5, 319 | ) 320 | ) 321 | 322 | if ap.channel24: 323 | frequency24 = self.frequency_from_channel(ap.channel24) 324 | wirelessinfos.append( 325 | WirelessInfo( 326 | frequency=frequency24, 327 | rx=ap.rx_bytes5, 328 | tx=ap.tx_bytes5, 329 | ) 330 | ) 331 | 332 | statistics.append( 333 | StatisticsInfo( 334 | clients=ClientInfo( 335 | total=ap.client_count, 336 | wifi=ap.client_count, 337 | wifi24=ap.client_count24, 338 | wifi5=ap.client_count5, 339 | ), 340 | uptime=ap.uptime, 341 | node_id=ap.mac.replace(":", ""), 342 | loadavg=ap.load_avg, 343 | memory=MemoryInfo( 344 | total=int(ap.mem_total / 1024), 345 | free=int((ap.mem_total - ap.mem_used) / 1024), 346 | buffers=int(ap.mem_buffer / 1024), 347 | ), 348 | traffic=TrafficInfo( 349 | tx=txInfo(bytes=int(ap.tx_bytes)), 350 | rx=rxInfo(bytes=int(ap.rx_bytes)), 351 | ), 352 | gateway=ap.gateway, 353 | gateway6=ap.gateway6, 354 | gateway_nexthop=ap.gateway_nexthop, 355 | wireless=wirelessinfos, 356 | ) 357 | ) 358 | return statistics 359 | 360 | def getNeighbours(self): 361 | """This method returns the neighbour information of all APs.""" 362 | aps = self._aps 363 | neighbours = [] 364 | for ap in aps.accesspoints: 365 | nbs = {} 366 | for neighbour_mac in ap.neighbour_macs: 367 | if neighbour_mac is not None: 368 | nbs[neighbour_mac] = NeighbourDetails(tq=255, lastseen=0.45) 369 | neighbours.append( 370 | NeighboursInfo( 371 | node_id=ap.mac.replace(":", ""), 372 | batadv={ap.mac: Neighbours(neighbours=nbs)}, 373 | ) 374 | ) 375 | return neighbours 376 | 377 | def listenMulticast(self): 378 | msg, sourceAddress = self._sock.recvfrom(2048) 379 | logger.info("Using multicast method") 380 | msgSplit = str(msg, "UTF-8").split(" ") 381 | 382 | return msgSplit, sourceAddress 383 | 384 | def sendUnicast(self): 385 | logger.info("Using unicast method") 386 | 387 | timeSleep = int(60 - (self._timeStop - self._timeStart) % 60) 388 | if self._config.verbose: 389 | logger.debug("will now sleep " + str(timeSleep) + " seconds") 390 | time.sleep(timeSleep) 391 | 392 | def start(self): 393 | """This method starts the respondd client.""" 394 | self._sock.setsockopt( 395 | socket.SOL_SOCKET, 396 | socket.SO_BINDTODEVICE, 397 | bytes(self._config.interface.encode()), 398 | ) 399 | if self._config.multicast_enabled: 400 | self._sock.bind(("::", self._config.multicast_port)) 401 | 402 | self.joinMCAST( 403 | self._sock, self._config.multicast_address, self._config.interface 404 | ) 405 | 406 | while True: 407 | responseStruct = {} 408 | sourceAddress = (self._config.unicast_address, self._config.unicast_port) 409 | msgSplit = ["GET", "nodeinfo", "statistics", "neighbours"] 410 | 411 | if self._config.multicast_enabled: 412 | msgSplit, sourceAddress = self.listenMulticast() 413 | else: 414 | self.sendUnicast() 415 | self._timeStart = time.time() 416 | self._aps = unifi_client.get_infos() 417 | if self._aps is None: 418 | continue 419 | if msgSplit[0] == "GET": # multi_request 420 | for request in msgSplit[1:]: 421 | responseStruct[request] = self.buildStruct(request) 422 | self.sendStruct(sourceAddress, responseStruct, True) 423 | else: # single_request 424 | responseStruct = self.buildStruct(msgSplit[0]) 425 | self.sendStruct(sourceAddress, responseStruct, False) 426 | self._timeStop = time.time() 427 | 428 | def merge_node(self, responseStruct): 429 | """This method merges the node information of all APs to their corresponding node_id.""" 430 | merged = {} 431 | for key in responseStruct.keys(): 432 | if responseStruct[key]: 433 | for info in responseStruct[key]: 434 | if info.node_id not in merged: 435 | merged[info.node_id] = {key: info} 436 | else: 437 | merged[info.node_id].update({key: info}) 438 | return merged 439 | 440 | def buildStruct(self, responseType): 441 | """This method builds the response structure.""" 442 | 443 | responseClass = None 444 | if responseType == "statistics": 445 | responseClass = self._statistics 446 | elif responseType == "nodeinfo": 447 | responseClass = self._nodeinfos 448 | elif responseType == "neighbours": 449 | responseClass = self._neighbours 450 | else: 451 | logger.warning("unknown command: " + responseType) 452 | return 453 | 454 | return responseClass 455 | 456 | def sendStruct(self, destAddress, responseStruct, withCompression): 457 | """This method sends the response structure to the respondd server.""" 458 | logger.debug( 459 | str(destAddress[0]) + " " + str(destAddress[1]) + " " + str(responseStruct) 460 | ) 461 | 462 | merged = self.merge_node(responseStruct) 463 | for infos in merged.values(): 464 | node = {} 465 | for key, info in infos.items(): 466 | node.update({key: info.to_dict()}) 467 | responseData = bytes(json.dumps(node), "UTF-8") 468 | logger.info(str(responseData)) 469 | 470 | if withCompression: 471 | encoder = zlib.compressobj( 472 | zlib.Z_DEFAULT_COMPRESSION, zlib.DEFLATED, -15 473 | ) 474 | responseData = encoder.compress(responseData) 475 | responseData += encoder.flush() 476 | 477 | self._sock.sendto(responseData, destAddress) 478 | -------------------------------------------------------------------------------- /unifi_respondd/unifi_client.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | from geopy.point import Point 4 | from pyunifi.controller import Controller 5 | from typing import List 6 | from geopy.geocoders import Nominatim 7 | from unifi_respondd import config 8 | from requests import get as rget 9 | from unifi_respondd import logger 10 | import time 11 | import dataclasses 12 | import re 13 | 14 | 15 | ffnodes = None 16 | 17 | 18 | @dataclasses.dataclass 19 | class Accesspoint: 20 | """This class contains the information of an AP. 21 | Attributes: 22 | name: The name of the AP (alias in the unifi controller). 23 | mac: The MAC address of the AP. 24 | snmp_location: The location of the AP (SNMP location in the unifi controller). 25 | client_count: The number of clients connected to the AP. 26 | client_count24: The number of clients connected to the AP via 2,4 GHz. 27 | client_count5: The number of clients connected to the AP via 5 GHz. 28 | latitude: The latitude of the AP. 29 | longitude: The longitude of the AP. 30 | model: The hardware model of the AP. 31 | firmware: The firmware information of the AP. 32 | uptime: The uptime of the AP. 33 | contact: The contact of the AP for example an email address. 34 | load_avg: The load average of the AP. 35 | mem_used: The used memory of the AP. 36 | mem_total: The total memory of the AP. 37 | mem_buffer: The buffer memory of the AP. 38 | tx_bytes: The transmitted bytes of the AP. 39 | rx_bytes: The received bytes of the AP.""" 40 | 41 | name: str 42 | mac: str 43 | snmp_location: str 44 | client_count: int 45 | client_count24: int 46 | client_count5: int 47 | channel5: int 48 | rx_bytes5: bytes 49 | tx_bytes5: bytes 50 | channel24: int 51 | rx_bytes24: bytes 52 | tx_bytes24: bytes 53 | latitude: float 54 | longitude: float 55 | model: str 56 | firmware: str 57 | uptime: int 58 | contact: str 59 | load_avg: float 60 | mem_used: int 61 | mem_total: int 62 | mem_buffer: int 63 | tx_bytes: int 64 | rx_bytes: int 65 | gateway: str 66 | gateway6: str 67 | gateway_nexthop: str 68 | neighbour_macs: List[str] 69 | domain_code: str 70 | 71 | 72 | @dataclasses.dataclass 73 | class Accesspoints: 74 | """This class contains the information of all APs. 75 | Attributes: 76 | accesspoints: A list of Accesspoint objects.""" 77 | 78 | accesspoints: List[Accesspoint] 79 | 80 | 81 | def get_client_count_for_ap(ap_mac, clients, cfg): 82 | """This function returns the number total clients, 2,4Ghz clients and 5Ghz clients connected to an AP.""" 83 | client5_count = 0 84 | client24_count = 0 85 | for client in clients: 86 | if re.search(cfg.ssid_regex, client.get("essid", ""), re.IGNORECASE): 87 | if client.get("ap_mac", "No mac") == ap_mac: 88 | if client.get("channel", 0) > 14: 89 | client5_count += 1 90 | else: 91 | client24_count += 1 92 | return client24_count + client5_count, client24_count, client5_count 93 | 94 | 95 | def get_ap_channel_usage(ssids, cfg): 96 | """This function returns the channels used for the Freifunk SSIDs""" 97 | channel5 = None 98 | rx_bytes5 = None 99 | tx_bytes5 = None 100 | channel24 = None 101 | rx_bytes24 = None 102 | tx_bytes24 = None 103 | for ssid in ssids: 104 | if re.search(cfg.ssid_regex, ssid.get("essid", ""), re.IGNORECASE): 105 | channel = ssid.get("channel", 0) 106 | rx_bytes = ssid.get("rx_bytes", 0) 107 | tx_bytes = ssid.get("tx_bytes", 0) 108 | if channel > 14: 109 | channel5 = channel 110 | rx_bytes5 = rx_bytes 111 | tx_bytes5 = tx_bytes 112 | else: 113 | channel24 = channel 114 | rx_bytes24 = tx_bytes 115 | tx_bytes24 = tx_bytes 116 | 117 | return channel5, rx_bytes5, tx_bytes5, channel24, rx_bytes24, tx_bytes24 118 | 119 | 120 | def get_location_by_address(address, app): 121 | """This function returns latitude and longitude of a given address.""" 122 | try: 123 | point = Point().from_string(address) 124 | return point.latitude, point.longitude 125 | except: 126 | try: 127 | time.sleep(1) 128 | geocode = app.geocode(address) 129 | return geocode.raw["lat"], geocode.raw["lon"] 130 | except: 131 | return get_location_by_address(address) 132 | 133 | 134 | def scrape(url): 135 | """returns remote json""" 136 | try: 137 | return rget(url).json() 138 | except Exception as ex: 139 | logger.error("Error: %s" % (ex)) 140 | 141 | 142 | def get_infos(): 143 | """This function gathers all the information and returns a list of Accesspoint objects.""" 144 | cfg = config.Config.from_dict(config.load_config()) 145 | ffnodes = scrape(cfg.nodelist) 146 | try: 147 | c = Controller( 148 | host=cfg.controller_url, 149 | username=cfg.username, 150 | password=cfg.password, 151 | port=cfg.controller_port, 152 | version=cfg.version, 153 | ssl_verify=cfg.ssl_verify, 154 | ) 155 | except Exception as ex: 156 | logger.error("Error: %s" % (ex)) 157 | return 158 | geolookup = Nominatim(user_agent="ffmuc_respondd") 159 | aps = Accesspoints(accesspoints=[]) 160 | for site in c.get_sites(): 161 | if cfg.version == "UDMP-unifiOS": 162 | c = Controller( 163 | host=cfg.controller_url, 164 | username=cfg.username, 165 | password=cfg.password, 166 | port=cfg.controller_port, 167 | version=cfg.version, 168 | site_id=site["name"], 169 | ssl_verify=cfg.ssl_verify, 170 | ) 171 | else: 172 | try: 173 | c.switch_site(site["desc"]) 174 | except Exception as ex: 175 | logger.error("Error: %s" % (ex)) 176 | continue 177 | 178 | aps_for_site = c.get_aps() 179 | clients = c.get_clients() 180 | for ap in aps_for_site: 181 | if ( 182 | ap.get("name", None) is not None 183 | and ap.get("state", 0) != 0 184 | and ap.get("type", "na") == "uap" 185 | ): 186 | ssids = ap.get("vap_table", None) 187 | containsSSID = False 188 | tx = 0 189 | rx = 0 190 | if ssids is not None: 191 | for ssid in ssids: 192 | if re.search(cfg.ssid_regex, ssid.get("essid", "")): 193 | containsSSID = True 194 | tx = tx + ssid.get("tx_bytes", 0) 195 | rx = rx + ssid.get("rx_bytes", 0) 196 | if containsSSID: 197 | ( 198 | client_count, 199 | client_count24, 200 | client_count5, 201 | ) = get_client_count_for_ap(ap.get("mac", None), clients, cfg) 202 | 203 | ( 204 | channel5, 205 | rx_bytes5, 206 | tx_bytes5, 207 | channel24, 208 | rx_bytes24, 209 | tx_bytes24, 210 | ) = get_ap_channel_usage(ssids, cfg) 211 | 212 | lat, lon = 0, 0 213 | neighbour_macs = [] 214 | if ap.get("snmp_location", None) is not None: 215 | try: 216 | lat, lon = get_location_by_address( 217 | ap["snmp_location"], geolookup 218 | ) 219 | except: 220 | pass 221 | try: 222 | neighbour_macs.append(cfg.offloader_mac.get(site["desc"], None)) 223 | offloader_id = cfg.offloader_mac.get(site["desc"], "").replace( 224 | ":", "" 225 | ) 226 | offloader = list( 227 | filter( 228 | lambda x: x["mac"] 229 | == cfg.offloader_mac.get(site["desc"], ""), 230 | ffnodes["nodes"], 231 | ) 232 | )[0] 233 | except: 234 | offloader_id = None 235 | offloader = {} 236 | pass 237 | uplink = ap.get("uplink", None) 238 | if uplink is not None and uplink.get("ap_mac", None) is not None: 239 | neighbour_macs.append(uplink.get("ap_mac")) 240 | lldp_table = ap.get("lldp_table", None) 241 | if lldp_table is not None: 242 | for lldp_entry in lldp_table: 243 | if not lldp_entry.get("is_wired", True): 244 | neighbour_macs.append(lldp_entry.get("chassis_id")) 245 | aps.accesspoints.append( 246 | Accesspoint( 247 | name=ap.get("name", None), 248 | mac=ap.get("mac", None), 249 | snmp_location=ap.get("snmp_location", None), 250 | client_count=client_count, 251 | client_count24=client_count24, 252 | client_count5=client_count5, 253 | channel5=channel5, 254 | rx_bytes5=rx_bytes5, 255 | tx_bytes5=tx_bytes5, 256 | channel24=channel24, 257 | rx_bytes24=rx_bytes24, 258 | tx_bytes24=tx_bytes24, 259 | latitude=float(lat), 260 | longitude=float(lon), 261 | model=ap.get("model", None), 262 | firmware=ap.get("version", None), 263 | uptime=ap.get("uptime", None), 264 | contact=ap.get("snmp_contact", None), 265 | load_avg=float( 266 | ap.get("sys_stats", {}).get("loadavg_1", 0.0) 267 | ), 268 | mem_used=ap.get("sys_stats", {}).get("mem_used", 0), 269 | mem_buffer=ap.get("sys_stats", {}).get("mem_buffer", 0), 270 | mem_total=ap.get("sys_stats", {}).get("mem_total", 0), 271 | tx_bytes=tx, 272 | rx_bytes=rx, 273 | gateway=offloader.get("gateway", None), 274 | gateway6=offloader.get("gateway6", None), 275 | gateway_nexthop=offloader_id, 276 | neighbour_macs=neighbour_macs, 277 | domain_code=offloader.get("domain", cfg.fallback_domain), 278 | ) 279 | ) 280 | return aps 281 | 282 | 283 | def main(): 284 | """This function is the main function, it's only executed if we aren't imported.""" 285 | print(get_infos()) 286 | 287 | 288 | if __name__ == "__main__": 289 | main() 290 | --------------------------------------------------------------------------------