Powered by Redocly

/config/net/homeplug

HomePlug configuration. This is used only by devices with built-in HomePlug power-line communication (egauge2, EG3x10 and EG41xx).

Get /config/net/homeplug

SecurityApiKey
Request
query Parameters
max-depth
integer >= 1

Limit output depth of the response. See Max-Depth.

Example: max-depth=2
filter
string

Response filter string. See Filter-Spec.

Example: filter={foo,bar}
Responses
200

Normal response.

401

Unauthorized response.

get/config/net/homeplug
Request samples 
Response samples 
application/json
{
  • "result": {
    },
  • "error": "Error message (present if an error occurred)."
}
Replace /config/net/homeplug
SecurityApiKey 
Request 
Request Body schema: application/json
region
string (configNetHomeplugRegion) 
The jurisdiction the meter is operating under.  The possible values are:


    

  • CE: European Union region.
    • 

  • NA: North American region.
    • 



This resource controls the frequency bands used by the HomePlug
communications interface that is built into some meters.  For
those meters, this resource must be set to the correct geographic
region to ensure compliance with local laws.


 Enum: "CE" "NA"  
Responses 
200
Normal response.


401
Unauthorized response.


put/config/net/homeplug
Request samples 
application/json
{ }
Response samples 
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}
Update /config/net/homeplug
SecurityApiKey 
Request 
Request Body schema: application/json
region
string (configNetHomeplugRegion) 
The jurisdiction the meter is operating under.  The possible values are:


    

  • CE: European Union region.
    • 

  • NA: North American region.
    • 



This resource controls the frequency bands used by the HomePlug
communications interface that is built into some meters.  For
those meters, this resource must be set to the correct geographic
region to ensure compliance with local laws.


 Enum: "CE" "NA"  
Responses 
200
Normal response.


401
Unauthorized response.


post/config/net/homeplug
Request samples 
application/json
{ }
Response samples 
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}
Delete /config/net/homeplug
Reset to default. See the descriptions of the individual endpoints for their default values.  Commonly, arrays and strings are cleared to empty, numbers are cleared to 0, and booleans are cleared to false.  


SecurityApiKey 
Responses 
200
Normal response.


401
Unauthorized response.


delete/config/net/homeplug
Request samples 
Response samples 
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}
➔ Next to /config/net/homeplug/region