Skip to content

Commit

Permalink
[asuswrt] Apply suggestions from code review
Browse files Browse the repository at this point in the history 
Co-authored-by: Wouter Born <github@maindrain.net>
Signed-off-by: Christian Wild <christian@wildclan.de>
  • Loading branch information
@wildcs @wborn
wildcs and wborn committed Jul 10, 2023
1 parent daf9900 commit 18411a4
Show file tree
Hide file tree
Showing 14 changed files with 216 additions and 272 deletions.
60 changes: 30 additions & 30 deletions bundles/org.openhab.binding.asuswrt/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,38 +53,38 @@ All devices support some of the following properties:

All devices support some of the following channels:

| group | channel |type | description | things supporting this channel |
|------------------|--------------------|------------------------|--------------------------------------------|-----------------------------------|
| networkInfo | macAddress | text (RO) | HW-Address | interface, client |
| | ipAddress | text (RO) | IP-Address | interface |
| | ipMethod | text (RO) | Ip-Method (static/dhcp) | interface, client |
| | subnet | text (RO) | Subnetmask | interface |
| | gateway | text (RO) | Default-Gateway | interface |
| | dnsServers | text (RO) | DNS-Servers | interface |
| | networkState | Switch (RO) | Client is online | interface, client |
| | internetState | Switch (RO) | Client connected to Internet | client |
| sysInfoGroup | memTotal | Number:DataAmountype | Total memory in MB | router |
| | memUsed | Number:DataAmountype | Used memory in MB | router |
| | memFree | Number:DataAmountype | Free memory in MB | router |
| | memUsedPercent | Number:Dimensionles | Used memory in % | router |
| | cpuUsedPercent | Number:Dimensionles | Total CPU usage in percent over all cores | router |
| clientListGroup | knownClients | text (RO) | Known clients with name and MAC-Addresses | router |
| | onlineClients | text (RO) | Online clients with name and MAC-Addresses | router |
| | onlineMACs | text (RO) | List with mac-addresses of online clients | router |
| | onlineClientsCount | Number:Dimensionless | Count of online clients | router |
| traffic | curRX | Number:DataTransferRate| Current DataTransferRate MBits/s (receive) | interface, client |
| | curTX | Number:DataTransferRate| Current DataTransferRate MBits/s (send) | interface, client |
| | todayRX | Number:DataAmount | Data received since 0:00 a clock in MB | interface, client |
| | todayTX | Number:DataAmount | Data sent since 0:00 a clock in MB | interface, client |
| | totalRX | Number:DataAmount | Data received since reboot in MB | interface, client |
| | totalTX | Number:DataAmount | Data sent since reboot in MB | interface, client |
| group | channel |type | description | things supporting this channel |
|------------------|----------------------|------------------------|--------------------------------------------|-----------------------------------|
| network-info | mac-address | text (RO) | HW-Address | interface, client |
| | ip-address | text (RO) | IP-Address | interface |
| | ip-method | text (RO) | Ip-Method (static/dhcp) | interface, client |
| | subnet | text (RO) | Subnetmask | interface |
| | gateway | text (RO) | Default-Gateway | interface |
| | dns-servers | text (RO) | DNS-Servers | interface |
| | network-state | Switch (RO) | Client is online | interface, client |
| | internet-state | Switch (RO) | Client connected to Internet | client |
| sys-info | mem-total | Number:DataAmountype | Total memory in MB | router |
| | mem-used | Number:DataAmountype | Used memory in MB | router |
| | mem-free | Number:DataAmountype | Free memory in MB | router |
| | mem-used-percent | Number:Dimensionles | Used memory in % | router |
| | cpu-used-percent | Number:Dimensionles | Total CPU usage in percent over all cores | router |
| client-list | known-clients | text (RO) | Known clients with name and MAC-Addresses | router |
| | online-clients | text (RO) | Online clients with name and MAC-Addresses | router |
| | online-macs | text (RO) | List with mac-addresses of online clients | router |
| | online-clients-count | Number:Dimensionless | Count of online clients | router |
| traffic | current-rx | Number:DataTransferRate| Current DataTransferRate MBits/s (receive) | interface, client |
| | current-tx | Number:DataTransferRate| Current DataTransferRate MBits/s (send) | interface, client |
| | today-rx | Number:DataAmount | Data received since 0:00 a clock in MB | interface, client |
| | today-tx | Number:DataAmount | Data sent since 0:00 a clock in MB | interface, client |
| | total-rx | Number:DataAmount | Data received since reboot in MB | interface, client |
| | total-tx | Number:DataAmount | Data sent since reboot in MB | interface, client |


## Events

All devices support some of the following Events:
| group | event |kind | description | things supporting this event |
|------------------|-------------------|------------|------------------------------------------------------------------------|---------------------------------|
| networkInfo | connectionEvent | Trigger | Fired if connection is established ('connected') or ('disconnected') | interface |
| | clientOnlineEvent | Trigger | Fired if Client leaves ('gone') or enters ('connected') the network | client |
| clientListGroup | clientOnlineEvent | Trigger | Fired if Client leaves ('gone') or enters ('connected') the network | router |
| group | event |kind | description | things supporting this event |
|------------------|---------------------|------------|------------------------------------------------------------------------|---------------------------------|
| network-info | connection-event | Trigger | Fired if connection is established ('connected') or ('disconnected') | interface |
| | client-online-event | Trigger | Fired if Client leaves ('gone') or enters ('connected') the network | client |
| client-list | client-online-event | Trigger | Fired if Client leaves ('gone') or enters ('connected') the network | router |
3 changes: 1 addition & 2 deletions ...ding.asuswrt/src/main/java/org/openhab/binding/asuswrt/internal/api/AsuswrtConnector.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ public void querySysInfo(boolean asyncRequest) {
}

/**
* Query Data From Device asynchron
* Query Data From Device
*
* @param command command constant to sent
* @param asyncRequest True if request should be sent asynchron, false if synchron
Expand Down Expand Up @@ -206,5 +206,4 @@ protected String getURL(String site) {
}
return url + "/" + site;
}

}
4 changes: 2 additions & 2 deletions ...src/main/java/org/openhab/binding/asuswrt/internal/constants/AsuswrtBindingConstants.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -95,8 +95,8 @@ public class AsuswrtBindingConstants {
public static final String CHANNEL_TRAFFIC_TOTAL_TX = "total-tx";
public static final String CHANNEL_TRAFFIC_TODAY_RX = "today-rx";
public static final String CHANNEL_TRAFFIC_TODAY_TX = "today-tx";
public static final String CHANNEL_TRAFFIC_CURRENT_RX = "cur-rx";
public static final String CHANNEL_TRAFFIC_CURRENT_TX = "cur-tx";
public static final String CHANNEL_TRAFFIC_CURRENT_RX = "current-rx";
public static final String CHANNEL_TRAFFIC_CURRENT_TX = "current-tx";

/**
* PROPERTIES
Expand Down
8 changes: 4 additions & 4 deletions ...uswrt/src/main/java/org/openhab/binding/asuswrt/internal/helpers/AsuswrtErrorHandler.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,8 @@ public void raiseError(String errorMessage, @Nullable String infoMessage) {
* Reset Error
*/
public void reset() {
this.errorMessage = "";
this.infoMessage = "";
errorMessage = "";
infoMessage = "";
}

/***********************************
Expand All @@ -94,13 +94,13 @@ public void reset() {
* Get Error Message
*/
public String getErrorMessage() {
return this.errorMessage;
return errorMessage;
}

/**
* Get Error Message
*/
public String getInfoMessage() {
return this.infoMessage;
return infoMessage;
}
}
Loading

0 comments on commit 18411a4

Please sign in to comment.