Contents:

System Configuration¶

The API endpoint /system/config provides access to the system configuration.

The data model available at this endpoint is presented below:

system_name (str): Assign a name for the device.
password (str): Configure the API password. Setting this item takes immediate effect.
netifcfg_e0 (scalar struct of type mp_netif_config_t, see members below): Network configuration of the e0 interface.
netifcfg_e0.dhcp_en (bool): If enabled, the e0 interface will try to acquire an IP address using DHCP.
netifcfg_e0.ipaddr_cidr (str): A static IP address to use in case of DHCP disabled in CIDR format. Default is 192.168.1.92/24.
netifcfg_e0.gateway (str): IP address for the gateway. Can be left blank if not needed.
vlan_e0 (scalar struct, see members below): VLAN Network configuration of the e0 interface (optional).
vlan_e0.vlan_name (string): Name of the vlan.
vlan_e0.vlan_id (uint): A value of [1-255] will enable the vlan with the specified VLAN ID. A value of zero disables the VLAN. This does not affect the regular IP on the e0 interface.
vlan_e0.netif_vlan (scalar struct of type mp_netif_config_t, identical to netifcfg_e0): Network configuration of the e0 vlan interface, similar to netifcfg_e0.
vlan_e0.netif_vlan.dhcp_en (bool): If enabled, the e0 vlan interface will try to acquire an IP address using DHCP.
vlan_e0.netif_vlan.ipaddr_cidr (str): A static IP address to use in case of DHCP disabled in CIDR format. Avoid setting a subnet which overlaps with netifcfg_e0.
vlan_e0.netif_vlan.gateway (str): IP address for the gateway. Can be left blank if unused.

System Status¶

System status information is accessible using the /system/status API endpoint.

The data model is described below:

uptime: Gives information on the uptime of the AutobusGW.
firmware_version: Version of the running firmware.
boot_mode: Indicates the current boot mode: recovery, operational (first) or operational (second)
build_timestamp: Timestamp of firmware.
firmware_githash: Git version of running firmware.
temperature_deg_C: Temperature in degrees C.

API Engine logs are accessible using /system/log/api. Detailed CAN interface status is accessible using /system/status/can_interfaces.