Code Docs

BloxOsLite (UbiSwitch, SwitchBlox Industrial)

PHY status/control

📘 Allows you to control port speed, duplex and auto-negotiation settings

Enable/disable link

[port <int>] link [{"off", "on"}]

Parameters

Property Type Description Required?
port int Switch port PHY number. ✅
link string String literal describing whether the PHY should have link down or up ✅

Quick Guides

Available on v0.1.0 or higher.

Change PHY settings

[port <int>] phy [autoneg {"off", "on"}] [speed <int>] [duplex {"full", "half"}] [advertise <int> <int> ...]

Parameters

Property Type Description Required?
port int Switch port PHY number ✅
autoneg string String literal describing whether the port’s PHY should enable auto-negotiation. ❌
speed int PHY speed if auto-negotiation disabled. Must be (10, 100, 200, 1000, 2500, 5000, 10000). Required if auto-negotiation is disabled. ❌
duplex string PHY duplex if auto-negotiation disabled. String literal must be “full” or “half”. Required if auto-negotiation is disabled. ❌
advertise List[int] The advertised link modes supported by the PHY. You can add support for multiple link modes by providing a list of ints.
0x01 - 10BaseT half
0x02 - 10BaseT full
0x04 - 100BaseT half
0x08 - 100BaseT full
0x10 - 1000BaseT half
0x20 - 1000BaseT full ❌

Quick Guides

Available on v0.2.0 or higher.

Saving Port MAC/PHY configuration

This allows you to save all ports MAC and PHY configurations stored so that the configuration will be written on reset.

port save

Available on v0.2.0 or higher.

Clearing Port MAC/PHY configuration

This allows you to clear all ports MAC and PHY configuration from memory so that on reset, no port configuration will be loaded on reboot.

port clear

Available on v0.3.1 or higher.

Showing Port MAC/PHY configuration

[port <int>] show conf

Available on v0.2.0 or higher.

Read temperature

*Currently only available on UbiSwitch

[port <int>] temperature

Parameters

Property Type Description Required?
port int Switch port PHY number ✅

Quick Guides

Available on v0.3.1 or higher.

Change PCS mode on SERDES ports

*Currently only available on UbiSwitch

[port <int>] mac [mode {"1000basex", "sgmii", "2500basex", "5gbaser", "10gbaser", "usxgmii"}]

Parameters

Property Type Description Required?
port int Switch port PHY number ✅
mode string Possible PCS modes for SERDES ports supported: 1000basex, sgmii, 2500basex, 5gbaser, 10gbaser, usxgmii ✅

Available on v0.4.0 or higher.

Change EEE mode on PHY/MAC

*Currently only available on UbiSwitch

[port <int>] eee [{"on", "off"}]

Parameters

Property Type Description Required?
port int Switch port PHY number ✅
eee string on for advertise EEE to link partner, off for no advertisement EEE to link partner ✅

Available on v0.4.0 or higher.

Prior versions

Table of Contents