Package com.facebook.openwifi.rrm.optimizers.clientsteering

Class SingleAPBandSteering

java.lang.Object

com.facebook.openwifi.rrm.optimizers.clientsteering.ClientSteeringOptimizer

com.facebook.openwifi.rrm.optimizers.clientsteering.SingleAPBandSteering

public class SingleAPBandSteering
extends ClientSteeringOptimizer

Implements simple band steering for each AP separately

2G clients below a specified RSSI threshold are deauthenticated. 2G clients above a specified RSSI threshold are asked to move to either 5G or 6G. 5G and 6G clients below a configurable RSSI threshold are asked to move to 2G.

Nested Class Summary

Nested classes/interfaces inherited from class com.facebook.openwifi.rrm.optimizers.clientsteering.ClientSteeringOptimizer

ClientSteeringOptimizer.BTMReasonCode, ClientSteeringOptimizer.CLIENT_STEERING_ACTIONS

Field Summary

Fields

Modifier and Type	Field	Description
static String	ALGORITHM_ID	The RRM algorithm ID.
static long	DEFAULT_BACKOFF_TIME_NS	Default backoff time (ns) for all APs and radios
static short	DEFAULT_MAX_RSSI_2G	RSSI (dBm) above which a client on 2G should be requested to move to 5G/6G
static short	DEFAULT_MIN_RSSI_2G	RSSI (dBm) below which a client on 2G should be disconnected using deauthentication.
static short	DEFAULT_MIN_RSSI_NON_2G	RSSI (dBm) below which a client on 5G/6G should be requested to move to 2G

Fields inherited from class com.facebook.openwifi.rrm.optimizers.clientsteering.ClientSteeringOptimizer

clientSteeringState, deviceConfigs, model, zone

Constructor Summary

Constructors

Constructor	Description
SingleAPBandSteering(Modeler.DataModel model, String zone, DeviceDataManager deviceDataManager, ClientSteeringState clientSteeringState, short minRssi2G, short maxRssi2G, short minRssiNon2G, long backoffTimeNs)	Constructor

Method Summary

Modifier and Type	Method	Description
Map<String,Map<String,String>>	computeApClientActionMap(boolean dryRun)	Compute map from AP serial number to client MAC to client steering action.
static SingleAPBandSteering	makeWithArgs(Modeler.DataModel model, String zone, DeviceDataManager deviceDataManager, ClientSteeringState clientSteeringState, Map<String,String> args)	Make a SingleAPBandSteering object with the given arguments

Methods inherited from class com.facebook.openwifi.rrm.optimizers.clientsteering.ClientSteeringOptimizer

steer

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ALGORITHM_ID

public static final String ALGORITHM_ID

The RRM algorithm ID.

See Also:

Constant Field Values

DEFAULT_MIN_RSSI_2G

public static final short DEFAULT_MIN_RSSI_2G

RSSI (dBm) below which a client on 2G should be disconnected using deauthentication.

See Also:

Constant Field Values

DEFAULT_MAX_RSSI_2G

public static final short DEFAULT_MAX_RSSI_2G

RSSI (dBm) above which a client on 2G should be requested to move to 5G/6G

See Also:

Constant Field Values

DEFAULT_MIN_RSSI_NON_2G

public static final short DEFAULT_MIN_RSSI_NON_2G

RSSI (dBm) below which a client on 5G/6G should be requested to move to 2G

See Also:

Constant Field Values

DEFAULT_BACKOFF_TIME_NS

public static final long DEFAULT_BACKOFF_TIME_NS

Default backoff time (ns) for all APs and radios

See Also:

Constant Field Values

Constructor Detail

SingleAPBandSteering

public SingleAPBandSteering(Modeler.DataModel model,
                            String zone,
                            DeviceDataManager deviceDataManager,
                            ClientSteeringState clientSteeringState,
                            short minRssi2G,
                            short maxRssi2G,
                            short minRssiNon2G,
                            long backoffTimeNs)

Constructor

Method Detail

makeWithArgs

public static SingleAPBandSteering makeWithArgs(Modeler.DataModel model,
                                                String zone,
                                                DeviceDataManager deviceDataManager,
                                                ClientSteeringState clientSteeringState,
                                                Map<String,String> args)

Make a SingleAPBandSteering object with the given arguments

computeApClientActionMap

public Map<String,Map<String,String>> computeApClientActionMap(boolean dryRun)

Description copied from class: ClientSteeringOptimizer

Compute map from AP serial number to client MAC to client steering action.

Specified by:

computeApClientActionMap in class ClientSteeringOptimizer