Skip to content

power: add ubus NetworkPowerPort#1409

Merged
Emantor merged 1 commit intolabgrid-project:masterfrom
aparcar:power-ubus
Jun 18, 2024
Merged

power: add ubus NetworkPowerPort#1409
Emantor merged 1 commit intolabgrid-project:masterfrom
aparcar:power-ubus

Conversation

@aparcar
Copy link
Copy Markdown
Contributor

@aparcar aparcar commented May 21, 2024 •
edited
Loading

Description

Using PoE switches as power supply is convenient since a switch is needed in many cases anyway and with the right adapter most embedded devices can be powered.

OpenWrt offers ubus as micro bus system to control the system, including PoE ports on switches.

This commit adds a driver to handle PoE switches running OpenWrt.

Checklist

  • Documentation for the feature
  • Tests for the feature
  • The arguments and description in doc/configuration.rst have been updated
  • Add a section on how to use the feature to doc/usage.rst

Same as for all other NetworkPowerPorts

  • Add a section on how to use the feature to doc/development.rst
  • PR has been tested
  • Man pages have been regenerated

no changes

@aparcar
Copy link
Copy Markdown
Contributor Author

aparcar commented May 22, 2024

I don't understand how this fails since I haven't touched the problematic files:

************* Module labgrid.util.yaml
labgrid/util/yaml.py:87:18: E0606: Possibly using variable 'items' before assignment (possibly-used-before-assignment)
************* Module labgrid.util.agents.network_interface
labgrid/util/agents/network_interface.py:98:23: E0606: Possibly using variable 'nm' before assignment (possibly-used-before-assignment)
************* Module labgrid.remote.client
labgrid/remote/client.py:1215:27: E0606: Possibly using variable 'data' before assignment (possibly-used-before-assignment)
labgrid/remote/client.py:1327:29: E0606: Possibly using variable 'data' before assignment (possibly-used-before-assignment)
************* Module labgrid.driver.mqtt
labgrid/driver/mqtt.py:46:23: E0606: Possibly using variable 'status' before assignment (possibly-used-before-assignment)

@jremmet
Copy link
Copy Markdown
Contributor

jremmet commented May 22, 2024 •
edited by Emantor
Loading

I don't understand how this fails since I haven't touched the problematic files:

Saw this today with an new pylint version

@Emantor
Copy link
Copy Markdown
Member

Emantor commented May 22, 2024 •
edited
Loading

I don't understand how this fails since I haven't touched the problematic files:

************* Module labgrid.util.yaml
labgrid/util/yaml.py:87:18: E0606: Possibly using variable 'items' before assignment (possibly-used-before-assignment)
************* Module labgrid.util.agents.network_interface
labgrid/util/agents/network_interface.py:98:23: E0606: Possibly using variable 'nm' before assignment (possibly-used-before-assignment)
************* Module labgrid.remote.client
labgrid/remote/client.py:1215:27: E0606: Possibly using variable 'data' before assignment (possibly-used-before-assignment)
labgrid/remote/client.py:1327:29: E0606: Possibly using variable 'data' before assignment (possibly-used-before-assignment)
************* Module labgrid.driver.mqtt
labgrid/driver/mqtt.py:46:23: E0606: Possibly using variable 'status' before assignment (possibly-used-before-assignment)

Yep thats the new pylint version. See #1406

sjg20
sjg20 approved these changes May 22, 2024
View reviewed changes
@aparcar
Copy link
Copy Markdown
Contributor Author

aparcar commented Jun 4, 2024

Successfully tested on real hardware.

@aparcar aparcar marked this pull request as ready for review June 4, 2024 15:05
@aparcar
Copy link
Copy Markdown
Contributor Author

aparcar commented Jun 13, 2024

How do I regenerate the Man pages?

@Emantor
Copy link
Copy Markdown
Member

Emantor commented Jun 17, 2024

How do I regenerate the Man pages?

There is a Makefile inside the man folder which requires the python rst2man module.

@aparcar
Copy link
Copy Markdown
Contributor Author

aparcar commented Jun 17, 2024 •
edited
Loading

done... let me actually fix these dependency issues Installing the dependencies via pip install .[doc] and running make in the man/ folder did not change any docs.

@Emantor
Copy link
Copy Markdown
Member

Emantor commented Jun 17, 2024

done... let me actually fix these dependency issues Installing the dependencies via pip install .[doc] and running make in the man/ folder did not change any docs.

Ah, yeah this is only required if you touch the .rst files inside the man folder.

@aparcar
Copy link
Copy Markdown
Contributor Author

aparcar commented Jun 17, 2024

In that case please let me know if anything else is needed prior a merge :)

@Emantor
Copy link
Copy Markdown
Member

Emantor commented Jun 17, 2024

In that case please let me know if anything else is needed prior a merge :)

The docstring seems to have the wrong format, thats why the CI is failing.

@aparcar
power: add ubus NetworkPowerPort
aae45b6 
Using PoE switches as power supply is convenient since a switch is
needed in many cases anyway and with the right adapter most embedded
devices can be powered.

OpenWrt offers `ubus` as micro bus system to control the system,
including PoE ports on switches.

This commit adds a driver to handle PoE switches running OpenWrt.

An ACL example is given below:

```shell
root@switch:~# cat /usr/share/rpcd/acl.d/unauthenticated.json
{
    "unauthenticated": {
        "description": "Access controls for unauthenticated requests",
        "read": {
            "ubus": {
                "session": [
                    "access",
                    "login"
                ],
                "poe": [
                    "info",
                    "manage"
                ]
            }
        }
    }
}
```

Signed-off-by: Paul Spooren <mail@aparcar.org>
@codecov
Copy link
Copy Markdown

codecov bot commented Jun 17, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 52.7%. Comparing base (70232e4) to head (aae45b6).
Report is 143 commits behind head on master.

❗ There is a different number of reports uploaded between BASE (70232e4) and HEAD (aae45b6). Click for more details.

HEAD has 9 uploads less than BASE
Flag BASE (70232e4) HEAD (aae45b6)
10 1
Additional details and impacted files 
@@           Coverage Diff            @@
##           master   #1409     +/-   ##
========================================
- Coverage    62.2%   52.7%   -9.5%     
========================================
  Files         164     165      +1     
  Lines       12201   12216     +15     
========================================
- Hits         7590    6439   -1151     
- Misses       4611    5777   +1166

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@aparcar
Copy link
Copy Markdown
Contributor Author

aparcar commented Jun 17, 2024

I added the specific example to the commit message to make docstring happy.

@Emantor Emantor merged commit 67c7c58 into labgrid-project:master Jun 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Emantor Emantor Emantor approved these changes

+1 more reviewer

@sjg20 sjg20 sjg20 approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@aparcar @jremmet @Emantor @sjg20