Skip to main content
Skip table of contents

Expansion Commands

Last updated: 2025/5/22 17:53:3

Path To

Name

Description/Function

/api/expansion

/porttype

Gets expansion port types.

/api/expansion

/off/{port}

Turns off the specified breaker.

/api/expansion

/on/{port}

Turns on the specified breaker.

/api/expansion

/off

Turns off all breakers.

/api/expansion

/ison/{port}

Forces a refresh of the state of the expansion board.

/api/expansion

/isfaulted/{port}

Requests the current fault state of the breaker.

/porttype

Function

Gets expansion port types.

Method

Get

Example

CODE
http://IP_ADDRESS:8080/api/expansion/porttype

Response

Expansion board port type.

Response Type

string

Response Example

CODE
None

/off/{port}

Function

Turns off the specified breaker.

Method

Get

Example

CODE
http://IP_ADDRESS:8080/api/expansion/off/{port}

Response

The index of the breaker to turn off.

Response Type

Not Available

Response Example

CODE
Not Available

/on/{port}

Function

Turns on the specified breaker.

Method

Get

Example

CODE
http://IP_ADDRESS:8080/api/expansion/on/{port}

Response

The index of the breaker to turn on.

Response Type

Not Available

Response Example

CODE
Not Available

/off

Function

Turns off all breakers.

Method

Get

Example

CODE
http://IP_ADDRESS:8080/api/expansion/off

Response

Status code 200, for completed operation being preformed.

Response Type

none

Response Example

CODE
Response OK(200)

/ison/{port}

Function

Forces a refresh of the state of the expansion board.

Method

Get

Example

CODE
http://IP_ADDRESS:8080/api/expansion/ison/{port}

Response

State of port.

Response Type

Boolean

Response Example

CODE
true

/isfaulted/{port}

Function

Requests the current fault state of the breaker.

Method

Get

Example

CODE
http://IP_ADDRESS:8080/api/expansion/isfaulted/{port}

Response

If port is faulted.

Response Type

Boolean

Response Example

CODE
false
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.