Skip to content

Commit 6e94b5b

Browse files
nitram509nitram509
committed
update README output examples
1 parent 9ee12df commit 6e94b5b

File tree

3 files changed

+49
-48
lines changed

3 files changed

+49
-48
lines changed

‎README.md

Lines changed: 42 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -223,15 +223,15 @@ This means, separated by | (pipe) and optional suffixes with blanks.
223223

224224
Use the ```--output-format=json``` flag, to get JSON output instead.
225225

226-
```ntgrrc poe settings --address gs305ep```
226+
```ntgrrc poe settings --address gs316ep```
227227

228228
```markdown
229-
| Port ID | Port Power | Mode | Priority | Limit Type | Limit (W) | Type |
230-
|---------|------------|---------|----------|------------|-----------|----------|
231-
| 1 | disabled | 802.3at | low | user | 30.0 | IEEE 802 |
232-
| 2 | enabled | 802.3at | low | user | 30.0 | IEEE 802 |
233-
| 3 | enabled | 802.3at | low | user | 30.0 | IEEE 802 |
234-
| 4 | enabled | 802.3at | low | user | 30.0 | IEEE 802 |
229+
| Port ID | Port Name | Port Power | Mode | Priority | Limit Type | Limit (W) | Type | Longer Detection Time |
230+
|---------|------------------|------------|-------------|----------|------------|-----------|----------------------|-----------------------|
231+
| 1 | AGER 31 SUR Tech | enabled | Legacy | High | User | 30.0 | IEEE802 | Disable |
232+
| 2 | foobar | enabled | 802.3at | Low | User | 30.0 | IEEE802 | Disable |
233+
| 3 | zzz | enabled | 802.3at | Low | User | 30.0 | 4pt 802.3af + Legacy | Disable |
234+
| 4 | uuu | enabled | 802.3at | Low | User | 30.0 | IEEE802 | Disable |
235235
```
236236

237237
#### Status
@@ -244,12 +244,12 @@ Use the ```--output-format=json``` flag, to get JSON output instead.
244244
```ntgrrc poe status --address gs305ep```
245245

246246
```markdown
247-
| Port ID | Status | PortPwr class | Voltage (V) | Current (mA) | PortPwr (W) | Temp. (°C) | Error status |
248-
|---------|------------------|---------------|-------------|--------------|-------------|------------|--------------|
249-
| 1 | Delivering Power | 0 | 53 | 82 | 4.40 | 30 | No Error |
250-
| 2 | Searching | | 0 | 0 | 0.00 | 30 | No Error |
251-
| 3 | Searching | | 0 | 0 | 0.00 | 30 | No Error |
252-
| 4 | Searching | | 0 | 0 | 0.00 | 30 | No Error |
247+
| Port ID | Port Name | Status | PortPwr class | Voltage (V) | Current (mA) | PortPwr (W) | Temp. (°C) | Error status |
248+
|---------|-----------|------------------|---------------|-------------|--------------|-------------|------------|--------------|
249+
| 1 | Camera | Delivering Power | 0 | 53 | 82 | 4.40 | 30 | No Error |
250+
| 2 | | Searching | | 0 | 0 | 0.00 | 30 | No Error |
251+
| 3 | | Searching | | 0 | 0 | 0.00 | 30 | No Error |
252+
| 4 | | Searching | | 0 | 0 | 0.00 | 30 | No Error |
253253
```
254254

255255
### set Power Over Ethernet (POE)
@@ -265,10 +265,11 @@ Use the ```--output-format=json``` flag, to get JSON output instead.
265265
```ntgrrc poe set -p 3 -p 4 --power enable --address gs305ep```
266266

267267
```markdown
268-
| Port ID | Port Power | Mode | Priority | Limit Type | Limit (W) | Type |
269-
|---------|------------|---------|----------|------------|-----------|----------|
270-
| 3 | enabled | 802.3at | low | user | 30.0 | IEEE 802 |
271-
| 4 | enabled | 802.3at | low | user | 30.0 | IEEE 802 |
268+
| Port ID | Port Name | Port Power | Mode | Priority | Limit Type | Limit (W) | Type | Longer Detection Time |
269+
|---------|-----------|------------|-------------|----------|------------|-----------|---------|-----------------------|
270+
| 3 | | enabled | Legacy | High | User | 30.0 | IEEE802 | Disable |
271+
| 4 | | enabled | 802.3at | Low | User | 30.0 | IEEE802 | Disable |
272+
272273
```
273274

274275
#### Port Power Mode
@@ -280,10 +281,10 @@ Use the ```--output-format=json``` flag, to get JSON output instead.
280281
```ntgrrc poe set -p 3 -p 5 --mode legacy --address gs305ep```
281282

282283
```markdown
283-
| Port ID | Port Power | Mode | Priority | Limit Type | Limit (W) | Type |
284-
|---------|------------|--------|----------|------------|-----------|----------|
285-
| 3 | enabled | legacy | low | user | 30.0 | IEEE 802 |
286-
| 5 | disabled | legacy | low | user | 30.0 | IEEE 802 |
284+
| Port ID | Port Name | Port Power | Mode | Priority | Limit Type | Limit (W) | Type | Longer Detection Time |
285+
|---------|-----------|------------|-------------|----------|------------|-----------|---------|-----------------------|
286+
| 3 | | enabled | Legacy | High | User | 30.0 | IEEE802 | Disable |
287+
| 4 | | enabled | Legacy | Low | User | 30.0 | IEEE802 | Disable |
287288
```
288289

289290
#### Port Priority
@@ -295,10 +296,10 @@ Use the ```--output-format=json``` flag, to get JSON output instead.
295296
```ntgrrc poe set -p 3 -p 5 --priority critical --address gs305ep```
296297

297298
```markdown
298-
| Port ID | Port Power | Mode | Priority | Limit Type | Limit (W) | Type |
299-
|---------|------------|--------|----------|------------|-----------|----------|
300-
| 3 | enabled | legacy | critical | user | 30.0 | IEEE 802 |
301-
| 5 | disabled | legacy | critical | user | 30.0 | IEEE 802 |
299+
| Port ID | Port Name | Port Power | Mode | Priority | Limit Type | Limit (W) | Type | Longer Detection Time |
300+
|---------|-----------|------------|-------------|----------|------------|-----------|---------|-----------------------|
301+
| 3 | | enabled | Legacy | critical | User | 30.0 | IEEE802 | Disable |
302+
| 5 | | enabled | Legacy | critical | User | 30.0 | IEEE802 | Disable |
302303
```
303304

304305
#### Power Limit
@@ -310,10 +311,10 @@ Use the ```--output-format=json``` flag, to get JSON output instead.
310311
```ntgrrc poe set -p 3 -p 5 --pwr-limit 5 --address gs305ep```
311312

312313
```markdown
313-
| Port ID | Port Power | Mode | Priority | Limit Type | Limit (W) | Type |
314-
|---------|------------|--------|----------|------------|-----------|----------|
315-
| 3 | enabled | legacy | critical | user | 5.0 | IEEE 802 |
316-
| 5 | disabled | legacy | critical | user | 5.0 | IEEE 802 |
314+
| Port ID | Port Name | Port Power | Mode | Priority | Limit Type | Limit (W) | Type | Longer Detection Time |
315+
|---------|-----------|------------|-------------|----------|------------|-----------|---------|-----------------------|
316+
| 3 | | enabled | Legacy | critical | User | 5.0 | IEEE802 | Disable |
317+
| 5 | | enabled | Legacy | critical | User | 5.0 | IEEE802 | Disable |
317318
```
318319

319320
#### Power Limit Type
@@ -325,10 +326,10 @@ Use the ```--output-format=json``` flag, to get JSON output instead.
325326
```ntgrrc poe set -p 3 -p 5 --limit-type class --address gs305ep```
326327

327328
```markdown
328-
| Port ID | Port Power | Mode | Priority | Limit Type | Limit (W) | Type |
329-
|---------|------------|--------|----------|------------|-----------|----------|
330-
| 3 | enabled | legacy | critical | class | 16.2 | IEEE 802 |
331-
| 5 | disabled | legacy | critical | class | 30.0 | IEEE 802 |
329+
| Port ID | Port Name | Port Power | Mode | Priority | Limit Type | Limit (W) | Type | Longer Detection Time |
330+
|---------|-----------|------------|-------------|----------|------------|-----------|---------|-----------------------|
331+
| 3 | | enabled | Legacy | critical | class | 30.0 | IEEE802 | Disable |
332+
| 5 | | enabled | Legacy | critical | class | 30.0 | IEEE802 | Disable |
332333
```
333334

334335
#### Detection type
@@ -340,10 +341,10 @@ Use the ```--output-format=json``` flag, to get JSON output instead.
340341
```ntgrrc poe set -p 3 -p 5 --detect-type "4pt 802.3af + Legacy" -a gs305ep```
341342

342343
```markdown
343-
| Port ID | Port Power | Mode | Priority | Limit Type | Limit (W) | Type |
344-
|---------|------------|--------|----------|------------|-----------|----------------------|
345-
| 3 | enabled | legacy | critical | user | 30.0 | 4pt 802.3af + Legacy |
346-
| 5 | disabled | legacy | critical | user | 30.0 | 4pt 802.3af + Legacy |
344+
| Port ID | Port Name | Port Power | Mode | Priority | Limit Type | Limit (W) | Type | Longer Detection Time |
345+
|---------|-----------|------------|-------------|----------|------------|-----------|----------------------|-----------------------|
346+
| 3 | | enabled | Legacy | critical | User | 30.0 | 4pt 802.3af + Legacy | Disable |
347+
| 5 | | enabled | Legacy | critical | User | 30.0 | 4pt 802.3af + Legacy | Disable |
347348
```
348349

349350
#### cycle Power Over Ethernet (POE)
@@ -357,8 +358,8 @@ Alternativly, you can achieve the same request with this
357358
```ntgrrc poe cycle --address gs305ep --port=3,5```
358359

359360
```markdown
360-
| Port ID | Port Power | Mode | Priority | Limit Type | Limit (W) | Type |
361-
|---------|------------|---------|----------|------------|-----------|----------|
362-
| 3 | enabled | 802.3at | low | user | 30.0 | IEEE 802 |
363-
| 5 | enabled | 802.3at | low | user | 30.0 | IEEE 802 |
361+
| Port ID | Port Name | Status | PortPwr class | Voltage (V) | Current (mA) | PortPwr (W) | Temp. (°C) | Error status |
362+
|---------|------------------|------------------|---------------|-------------|--------------|-------------|------------|--------------|
363+
| 3 | Camera | Delivering Power | | 54 | 24 | 1.30 | 30 | No Error |
364+
| 5 | Sensor | Searching | | 0 | 0 | 0.00 | 30 | Power Denied |
364365
```

‎poe_cycle.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -60,13 +60,14 @@ func (poe *PoeCyclePowerCommand) cyclePowerGs30xEPx(args *GlobalOptions) error {
6060
return errors.New(result)
6161
}
6262

63-
settings, err = requestPoeConfiguration(args, poe.Address, poeExt)
63+
statuses, err := requestPoeStatus(args, poe.Address)
6464
if err != nil {
6565
return err
6666
}
67+
statuses = filter(statuses, func(status PoePortStatus) bool {
68+
return slices.Contains(poe.Ports, int(status.PortIndex))
69+
})
6770

68-
changedPorts := collectChangedPoePortConfiguration(poe.Ports, settings)
69-
prettyPrintPoePortSettings(args.model, args.OutputFormat, changedPorts)
7071
return nil
7172
}
7273

@@ -97,8 +98,7 @@ func (poe *PoeCyclePowerCommand) cyclePowerGs316EPx(args *GlobalOptions) error {
9798
return errors.New(result)
9899
}
99100

100-
// hint in contrast to GS30x, we print PO status here, as this seems more useful
101-
statuses, err := getPoeStatus(args, poe.Address)
101+
statuses, err := requestPoeStatus(args, poe.Address)
102102
if err != nil {
103103
return err
104104
}

‎poe_status.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ type PoeStatusCommand struct {
3333
}
3434

3535
func (poe *PoeStatusCommand) Run(args *GlobalOptions) error {
36-
statuses, err := getPoeStatus(args, poe.Address)
36+
statuses, err := requestPoeStatus(args, poe.Address)
3737
if err != nil {
3838
return err
3939
}
@@ -42,7 +42,7 @@ func (poe *PoeStatusCommand) Run(args *GlobalOptions) error {
4242

4343
}
4444

45-
func getPoeStatus(args *GlobalOptions, address string) ([]PoePortStatus, error) {
45+
func requestPoeStatus(args *GlobalOptions, address string) ([]PoePortStatus, error) {
4646
var result []PoePortStatus
4747
statusPage, err := requestPoePortStatusPage(args, address)
4848
if err != nil {

0 commit comments

Comments
 (0)