Powered by Redocly

/config/register/virtual/{reg}/value/{idx}

An additive term of the virtual register formula.

Get /config/register/virtual/{reg}/value/{idx}

SecurityApiKey
Request
path Parameters
reg
required
string

The name of a virtual register. May not be empty, contain commas (,), and may not consist entirely of digits. Virtual register names may contain a single dot (.) between a prefix and a suffix. The prefix is called the view name.

idx
required
integer >= 0

The index of a virtual register addend.

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/register/virtual/{reg}/value/{idx}
Request samples 
Response samples 
application/json
{
  • "result": {
    },
  • "error": "Error message (present if an error occurred)."
}
Replace /config/register/virtual/{reg}/value/{idx}
SecurityApiKey 
Request 
path Parameters
reg
required
string
The name of a virtual register.  May not be empty, contain
commas (,), and may not consist entirely of digits. Virtual
register names may contain a single dot (.) between a prefix
and a suffix.  The prefix is called the view
name.


 
idx
required
integer  >= 0 
The index of a virtual register addend.


 
Request Body schema: application/json
op
string (configRegisterVirtualRegValueItemOp) 
The operation that calculates the value of this addend.


Possible values are:


    

  • +: The physical register value is to be added.
    

    • 

  • -: The physical register value is to be subtracted.
    

    • 

  • +max0, -max0, +min0, -min0:
    

    • 



  Deprecated. These operators do
  not work correctly and remain only to preserve compatibility
  with existing, old, device configurations.  Attempting to write
  these operators with a PUT or POST request will result in an
  error.  They can only be returned as a result of a GET request.
  The intent of these operators was to add (+max0, +min0) or
  subtract (-max0, -min0) the maximum of the physical register
  value and 0 (+max0, -max0) or the minimum of the register value
  and 0 (+min0, -min0).


 Enum: "+" "-" "+max0" "-max0" "+min0" "-min0"  
register
string (configRegisterVirtualRegValueItemRegister) 
The name of the physical register to use in calculating the value
of this addend.


 
Responses 
200
Normal response.


401
Unauthorized response.


put/config/register/virtual/{reg}/value/{idx}
Request samples 
application/json
{ }
Response samples 
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}
Update /config/register/virtual/{reg}/value/{idx}
SecurityApiKey 
Request 
path Parameters
reg
required
string
The name of a virtual register.  May not be empty, contain
commas (,), and may not consist entirely of digits. Virtual
register names may contain a single dot (.) between a prefix
and a suffix.  The prefix is called the view
name.


 
idx
required
integer  >= 0 
The index of a virtual register addend.


 
Request Body schema: application/json
op
string (configRegisterVirtualRegValueItemOp) 
The operation that calculates the value of this addend.


Possible values are:


    

  • +: The physical register value is to be added.
    

    • 

  • -: The physical register value is to be subtracted.
    

    • 

  • +max0, -max0, +min0, -min0:
    

    • 



  Deprecated. These operators do
  not work correctly and remain only to preserve compatibility
  with existing, old, device configurations.  Attempting to write
  these operators with a PUT or POST request will result in an
  error.  They can only be returned as a result of a GET request.
  The intent of these operators was to add (+max0, +min0) or
  subtract (-max0, -min0) the maximum of the physical register
  value and 0 (+max0, -max0) or the minimum of the register value
  and 0 (+min0, -min0).


 Enum: "+" "-" "+max0" "-max0" "+min0" "-min0"  
register
string (configRegisterVirtualRegValueItemRegister) 
The name of the physical register to use in calculating the value
of this addend.


 
Responses 
200
Normal response.


401
Unauthorized response.


post/config/register/virtual/{reg}/value/{idx}
Request samples 
application/json
{ }
Response samples 
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}
Delete /config/register/virtual/{reg}/value/{idx}
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 
Request 
path Parameters
reg
required
string
The name of a virtual register.  May not be empty, contain
commas (,), and may not consist entirely of digits. Virtual
register names may contain a single dot (.) between a prefix
and a suffix.  The prefix is called the view
name.


 
idx
required
integer  >= 0 
The index of a virtual register addend.


 
Responses 
200
Normal response.


401
Unauthorized response.


delete/config/register/virtual/{reg}/value/{idx}
Request samples 
Response samples 
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}
➔ Next to /config/register/virtual/{reg}/value/{idx}/op