LAN Connection

Requires the feature "ethernet". The ethernet module and appropriate hardware allow connection to a LAN.

warp1

Not supported on this hardware!

warp2

ethernet/state

The state of the LAN/Ethernet connection.

Example

HTTP (curl)

# $HOST e.g. warp2-AbCd

Read

curl http://$HOST/ethernet/state

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp2/AbCd

Read

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/ethernet/state

{
  "connection_state": 3,
  "connection_start": 4241,
  "connection_end": 0,
  "ip": "192.168.1.129",
  "subnet": "255.255.255.0",
  "full_duplex": true,
  "link_speed": 100
}

Name	Description
connection_state int	Connection state. 0 - Not configured 1 - Not connected 2 - Connecting 3 - Connected
ip string	IP of the device in the connected network. 0.0.0.0 if no connection exists.
subnet string	Subnet mask used by the device in the connected network. 0.0.0.0 if no connection exists.
full_duplex bool	true for a full-duplex connection, otherwise false
link_speed int (Mbit/s)	Negotiated connection speed. 0 - not connected 10 - 100 -
connection_start int (ms)	Time in milliseconds when a connection was last established.
connection_end int (ms)	Time in milliseconds when a connection was last disconnected.

ethernet/config

The LAN/Ethernet connection configuration.

Example

HTTP (curl)

# $HOST e.g. warp2-AbCd

Read

curl http://$HOST/ethernet/config

{
  "enable_ethernet": true,
  "ip": "0.0.0.0",
  "gateway": "0.0.0.0",
  "subnet": "0.0.0.0",
  "dns": "0.0.0.0",
  "dns2": "0.0.0.0"
}

Write

curl http://$HOST/ethernet/config -d '{
  "enable_ethernet": true,
  "ip": "0.0.0.0",
  "gateway": "0.0.0.0",
  "subnet": "0.0.0.0",
  "dns": "0.0.0.0",
  "dns2": "0.0.0.0"
}'

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp2/AbCd

Read

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/ethernet/config

{
  "enable_ethernet": true,
  "ip": "0.0.0.0",
  "gateway": "0.0.0.0",
  "subnet": "0.0.0.0",
  "dns": "0.0.0.0",
  "dns2": "0.0.0.0"
}

Write

With MQTT on $PREFIX/ethernet/config_update

mosquitto_pub -h $BROKER -t $PREFIX/ethernet/config_update -m '{
  "enable_ethernet": true,
  "ip": "0.0.0.0",
  "gateway": "0.0.0.0",
  "subnet": "0.0.0.0",
  "dns": "0.0.0.0",
  "dns2": "0.0.0.0"
}'

Name	Description
enable_ethernet bool	Indicates whether a LAN connection should be established. true - If a LAN connection should be established. false - If not.
ip string	IP address the device should use. This entry and the following are optional and can be set to "0.0.0.0" if the address configuration should be obtained automatically via DHCP.
gateway string	Gateway address the device should use.
subnet string	Subnet mask the device should use.
dns string	DNS server address the device should use.
dns2 string	Alternative DNS server address the device should use.

warp3

ethernet/state

The state of the LAN/Ethernet connection.

Example

HTTP (curl)

# $HOST e.g. warp3-AbCd

Read

curl http://$HOST/ethernet/state

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp3/AbCd

Read

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/ethernet/state

{
  "connection_state": 3,
  "connection_start": 4241,
  "connection_end": 0,
  "ip": "192.168.1.129",
  "subnet": "255.255.255.0",
  "full_duplex": true,
  "link_speed": 100
}

Name	Description
connection_state int	Connection state. 0 - Not configured 1 - Not connected 2 - Connecting 3 - Connected
ip string	IP of the device in the connected network. 0.0.0.0 if no connection exists.
subnet string	Subnet mask used by the device in the connected network. 0.0.0.0 if no connection exists.
full_duplex bool	true for a full-duplex connection, otherwise false
link_speed int (Mbit/s)	Negotiated connection speed. 0 - not connected 10 - 100 -
connection_start int (ms)	Time in milliseconds when a connection was last established.
connection_end int (ms)	Time in milliseconds when a connection was last disconnected.

ethernet/config

The LAN/Ethernet connection configuration.

Example

HTTP (curl)

# $HOST e.g. warp3-AbCd

Read

curl http://$HOST/ethernet/config

{
  "enable_ethernet": true,
  "ip": "0.0.0.0",
  "gateway": "0.0.0.0",
  "subnet": "0.0.0.0",
  "dns": "0.0.0.0",
  "dns2": "0.0.0.0"
}

Write

curl http://$HOST/ethernet/config -d '{
  "enable_ethernet": true,
  "ip": "0.0.0.0",
  "gateway": "0.0.0.0",
  "subnet": "0.0.0.0",
  "dns": "0.0.0.0",
  "dns2": "0.0.0.0"
}'

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp3/AbCd

Read

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/ethernet/config

{
  "enable_ethernet": true,
  "ip": "0.0.0.0",
  "gateway": "0.0.0.0",
  "subnet": "0.0.0.0",
  "dns": "0.0.0.0",
  "dns2": "0.0.0.0"
}

Write

With MQTT on $PREFIX/ethernet/config_update

mosquitto_pub -h $BROKER -t $PREFIX/ethernet/config_update -m '{
  "enable_ethernet": true,
  "ip": "0.0.0.0",
  "gateway": "0.0.0.0",
  "subnet": "0.0.0.0",
  "dns": "0.0.0.0",
  "dns2": "0.0.0.0"
}'

Name	Description
enable_ethernet bool	Indicates whether a LAN connection should be established. true - If a LAN connection should be established. false - If not.
ip string	IP address the device should use. This entry and the following are optional and can be set to "0.0.0.0" if the address configuration should be obtained automatically via DHCP.
gateway string	Gateway address the device should use.
subnet string	Subnet mask the device should use.
dns string	DNS server address the device should use.
dns2 string	Alternative DNS server address the device should use.

wem

ethernet/state

The state of the LAN/Ethernet connection.

Example

HTTP (curl)

# $HOST e.g. wem-AbCd

Read

curl http://$HOST/ethernet/state

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. wem/AbCd

Read

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/ethernet/state

{
  "connection_state": 3,
  "connection_start": 4241,
  "connection_end": 0,
  "ip": "192.168.1.129",
  "subnet": "255.255.255.0",
  "full_duplex": true,
  "link_speed": 100
}

Name	Description
connection_state int	Connection state. 0 - Not configured 1 - Not connected 2 - Connecting 3 - Connected
ip string	IP of the device in the connected network. 0.0.0.0 if no connection exists.
subnet string	Subnet mask used by the device in the connected network. 0.0.0.0 if no connection exists.
full_duplex bool	true for a full-duplex connection, otherwise false
link_speed int (Mbit/s)	Negotiated connection speed. 0 - not connected 10 - 100 -
connection_start int (ms)	Time in milliseconds when a connection was last established.
connection_end int (ms)	Time in milliseconds when a connection was last disconnected.

ethernet/config

The LAN/Ethernet connection configuration.

Example

HTTP (curl)

# $HOST e.g. wem-AbCd

Read

curl http://$HOST/ethernet/config

{
  "enable_ethernet": true,
  "ip": "0.0.0.0",
  "gateway": "0.0.0.0",
  "subnet": "0.0.0.0",
  "dns": "0.0.0.0",
  "dns2": "0.0.0.0"
}

Write

curl http://$HOST/ethernet/config -d '{
  "enable_ethernet": true,
  "ip": "0.0.0.0",
  "gateway": "0.0.0.0",
  "subnet": "0.0.0.0",
  "dns": "0.0.0.0",
  "dns2": "0.0.0.0"
}'

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. wem/AbCd

Read

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/ethernet/config

{
  "enable_ethernet": true,
  "ip": "0.0.0.0",
  "gateway": "0.0.0.0",
  "subnet": "0.0.0.0",
  "dns": "0.0.0.0",
  "dns2": "0.0.0.0"
}

Write

With MQTT on $PREFIX/ethernet/config_update

mosquitto_pub -h $BROKER -t $PREFIX/ethernet/config_update -m '{
  "enable_ethernet": true,
  "ip": "0.0.0.0",
  "gateway": "0.0.0.0",
  "subnet": "0.0.0.0",
  "dns": "0.0.0.0",
  "dns2": "0.0.0.0"
}'

Name	Description
enable_ethernet bool	Indicates whether a LAN connection should be established. true - If a LAN connection should be established. false - If not.
ip string	IP address the device should use. This entry and the following are optional and can be set to "0.0.0.0" if the address configuration should be obtained automatically via DHCP.
gateway string	Gateway address the device should use.
subnet string	Subnet mask the device should use.
dns string	DNS server address the device should use.
dns2 string	Alternative DNS server address the device should use.

wem2

ethernet/state

The state of the LAN/Ethernet connection.

Example

HTTP (curl)

# $HOST e.g. wem2-AbCd

Read

curl http://$HOST/ethernet/state

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. wem2/AbCd

Read

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/ethernet/state

{
  "connection_state": 3,
  "connection_start": 4241,
  "connection_end": 0,
  "ip": "192.168.1.129",
  "subnet": "255.255.255.0",
  "full_duplex": true,
  "link_speed": 100
}

Name	Description
connection_state int	Connection state. 0 - Not configured 1 - Not connected 2 - Connecting 3 - Connected
ip string	IP of the device in the connected network. 0.0.0.0 if no connection exists.
subnet string	Subnet mask used by the device in the connected network. 0.0.0.0 if no connection exists.
full_duplex bool	true for a full-duplex connection, otherwise false
link_speed int (Mbit/s)	Negotiated connection speed. 0 - not connected 10 - 100 -
connection_start int (ms)	Time in milliseconds when a connection was last established.
connection_end int (ms)	Time in milliseconds when a connection was last disconnected.

ethernet/config

The LAN/Ethernet connection configuration.

Example

HTTP (curl)

# $HOST e.g. wem2-AbCd

Read

curl http://$HOST/ethernet/config

{
  "enable_ethernet": true,
  "ip": "0.0.0.0",
  "gateway": "0.0.0.0",
  "subnet": "0.0.0.0",
  "dns": "0.0.0.0",
  "dns2": "0.0.0.0"
}

Write

curl http://$HOST/ethernet/config -d '{
  "enable_ethernet": true,
  "ip": "0.0.0.0",
  "gateway": "0.0.0.0",
  "subnet": "0.0.0.0",
  "dns": "0.0.0.0",
  "dns2": "0.0.0.0"
}'

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. wem2/AbCd

Read

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/ethernet/config

{
  "enable_ethernet": true,
  "ip": "0.0.0.0",
  "gateway": "0.0.0.0",
  "subnet": "0.0.0.0",
  "dns": "0.0.0.0",
  "dns2": "0.0.0.0"
}

Write

With MQTT on $PREFIX/ethernet/config_update

mosquitto_pub -h $BROKER -t $PREFIX/ethernet/config_update -m '{
  "enable_ethernet": true,
  "ip": "0.0.0.0",
  "gateway": "0.0.0.0",
  "subnet": "0.0.0.0",
  "dns": "0.0.0.0",
  "dns2": "0.0.0.0"
}'

Name	Description
enable_ethernet bool	Indicates whether a LAN connection should be established. true - If a LAN connection should be established. false - If not.
ip string	IP address the device should use. This entry and the following are optional and can be set to "0.0.0.0" if the address configuration should be obtained automatically via DHCP.
gateway string	Gateway address the device should use.
subnet string	Subnet mask the device should use.
dns string	DNS server address the device should use.
dns2 string	Alternative DNS server address the device should use.

any

ethernet/state

The state of the LAN/Ethernet connection.

Example

HTTP (curl)

# $HOST e.g. warp-AbCd

Read

curl http://$HOST/ethernet/state

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp/AbCd

Read

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/ethernet/state

{
  "connection_state": 3,
  "connection_start": 4241,
  "connection_end": 0,
  "ip": "192.168.1.129",
  "subnet": "255.255.255.0",
  "full_duplex": true,
  "link_speed": 100
}

Name	Description
connection_state int	Connection state. 0 - Not configured 1 - Not connected 2 - Connecting 3 - Connected
ip string	IP of the device in the connected network. 0.0.0.0 if no connection exists.
subnet string	Subnet mask used by the device in the connected network. 0.0.0.0 if no connection exists.
full_duplex bool	true for a full-duplex connection, otherwise false
link_speed int (Mbit/s)	Negotiated connection speed. 0 - not connected 10 - 100 -
connection_start int (ms)	Time in milliseconds when a connection was last established.
connection_end int (ms)	Time in milliseconds when a connection was last disconnected.

ethernet/config

The LAN/Ethernet connection configuration.

Example

HTTP (curl)

# $HOST e.g. warp-AbCd

Read

curl http://$HOST/ethernet/config

{
  "enable_ethernet": true,
  "ip": "0.0.0.0",
  "gateway": "0.0.0.0",
  "subnet": "0.0.0.0",
  "dns": "0.0.0.0",
  "dns2": "0.0.0.0"
}

Write

curl http://$HOST/ethernet/config -d '{
  "enable_ethernet": true,
  "ip": "0.0.0.0",
  "gateway": "0.0.0.0",
  "subnet": "0.0.0.0",
  "dns": "0.0.0.0",
  "dns2": "0.0.0.0"
}'

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp/AbCd

Read

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/ethernet/config

{
  "enable_ethernet": true,
  "ip": "0.0.0.0",
  "gateway": "0.0.0.0",
  "subnet": "0.0.0.0",
  "dns": "0.0.0.0",
  "dns2": "0.0.0.0"
}

Write

With MQTT on $PREFIX/ethernet/config_update

mosquitto_pub -h $BROKER -t $PREFIX/ethernet/config_update -m '{
  "enable_ethernet": true,
  "ip": "0.0.0.0",
  "gateway": "0.0.0.0",
  "subnet": "0.0.0.0",
  "dns": "0.0.0.0",
  "dns2": "0.0.0.0"
}'

Name	Description
enable_ethernet bool	Indicates whether a LAN connection should be established. true - If a LAN connection should be established. false - If not.
ip string	IP address the device should use. This entry and the following are optional and can be set to "0.0.0.0" if the address configuration should be obtained automatically via DHCP.
gateway string	Gateway address the device should use.
subnet string	Subnet mask the device should use.
dns string	DNS server address the device should use.
dns2 string	Alternative DNS server address the device should use.