Setting - MOB_SLP-RSP

This topic describes the following functions:

• Get/Set BSMOB_SLP_RSP_Operation

• Get/Set BSMOB_SLP_RSP_StartFrameNumber

• Get/Set BSMOB_SLP_RSP_Initial_Sleep_Window

• Get/Set BSMOB_SLP_RSP_Listening_Window

• Get/Set BSMOB_SLP_RSP_Final_Sleep_Window_Base

• Get/Set BSMOB_SLP_RSP_Final_Sleep_Window_Exponent

• Get/Set BSMOB_SLP_RSP_SPLID

E6651_Get/Set BSMOB_SLP_RSP_Operation

Declaration

int E6651_GetBSMOB_SLP_RSP_Operation(BYTE MID, BYTE* Value);

int E6651_SetBSMOB_SLP_RSP_Operation(BYTE MID, BYTE Value);

Parameter

MID [in]: User defined E6651A Machine ID

Value [out]: Current MS Sleep Mode activation setting.

Value [in]: Activate or deactivate the MS sleep mode.

0 - Deactivation
1 - Activation

Default

0, Deactivation

Return Value

Success: STATE_SUCCESS(1)

Failure: STATE_ERROR(-1)

Description

Retrieve and set the MS Sleep Mode into Activation or Deactivation.

E6651_Get/Set BSMOB_SLP_RSP_StartFrameNumber

Declaration

int E6651_GetBSMOB_SLP_RSP_StartFrameNumber(BYTE MID, WORD* Value);

int E6651_SetBSMOB_SLP_RSP_StartFrameNumber(BYTE MID, WORD Value);

Parameter

MID [in]: User defined E6651A Machine ID

Value [out]: Current Start Frame Number sent in the MOB_SLP-RSP message

Value [in]: Sets the Start Frame Number in the MOB_SLP-RSP message

Range

0 to 1023

Return Value

Success: STATE_SUCCESS(1)

Failure: STATE_ERROR(-1)

Description

Retrieve and set the Start Frame Number parameter used in the MOB_SLP-RSP message.

E6651_Get/Set BSMOB_SLP_RSP_Initial_Sleep_Window

Declaration

int E6651_GetBSMOB_SLP_RSP_Initial_Sleep_Window(BYTE MID, BYTE* Value);

int E6651_SetBSMOB_SLP_RSP_Initial_Sleep_Window(BYTE MID, BYTE Value);

Parameter

MID [in]: User defined E6651A Machine ID

Value [out]: Current sleep mode Initial Sleep Window setting.

Value [in]: Set the Initial Sleep Window value.

Range

1 to 255

Return Value

Success: STATE_SUCCESS(1)

Failure: STATE_ERROR(-1)

Description

Retrieve and set the Initial Sleep Window value. (The requested start value in frames for the sleep interval).

E6651_Get/Set BSMOB_SLP_RSP_Listening_Window

Declaration

int E6651_GetBSMOB_SLP_RSP_Listening_Window(BYTE MID, BYTE* Value);

int E6651_SetBSMOB_SLP_RSP_Listening_Window(BYTE MID, BYTE Value);

Parameter

MID [in]: User defined E6651A Machine ID

Value [out]: Current sleep mode Listening Window setting.

Value [in]: Set the Listening Window value.

Range

1 to 255

Return Value

Success: STATE_SUCCESS(1)

Failure: STATE_ERROR(-1)

Description

Retrieve and set the Listening Window value. (The number of frames the MS should remain in a listen state after the first sleep interval).

E6651_Get/Set BSMOB_SLP_RSP_Final_Sleep_Window_Base

Declaration

int E6651_GetBSMOB_SLP_RSP_Final_Sleep_Window_Base(BYTE MID, WORD* Value);

int E6651_SetBSMOB_SLP_RSP_Final_Sleep_Window_Base(BYTE MID, WORD Value);

Parameter

MID [in]: User defined E6651A Machine ID

Value [out]: Current sleep mode Final Window Base value.

Value [in]: Set the Final Window Base value.

Range

1 to 1023

Return Value

Success: STATE_SUCCESS(1)

Failure: STATE_ERROR(-1)

Description

Retrieve and set the sleep mode Final Window Base value. This base value is used in conjunction with the Final Sleep Window Exponent value to determine the final sleep window value.

E6651_Get/Set BSMOB_SLP_RSP_Final_Sleep_Window_Exponent

Declaration

int E6651_GetBSMOB_SLP_RSP_Final_Sleep_Window_Exponent(BYTE MID, BYTE* Value);

int E6651_SetBSMOB_SLP_RSP_Final_Sleep_Window_Exponent(BYTE MID, BYTE Value);

Parameter

MID [in]: User defined E6651A Machine ID

Value [out]: Current sleep mode Final Window Exponent value.

Value [in]: Set the sleep mode Final Window Exponent value.

Range

1 to 7

Return Value

Success: STATE_SUCCESS(1)

Failure: STATE_ERROR(-1)

Description

Retrieve and set the sleep mode Final Window Exponent value. This specifies the factor by which the Final Window Base value is multiplied to determine the Final Sleep Window value.

E6651_Get/Set BSMOB_SLP_RSP_SPLID

Declaration

int E6651_GetBSMOB_SLP_RSP_SPLID(BYTE MID, BYTE* Value);

int E6651_SetBSMOB_SLP_RSP_SPLID(BYTE MID, BYTE Value);

Parameter

MID [in]: User defined E6651A Machine ID

Value [out]: Current SLPID assigned to the MS for Sleep Mode

Value [in]: Set the SLPID assigned to the MS for Sleep Mode

Range

100 to 200

Return Value

Success: STATE_SUCCESS(1)

Failure: STATE_ERROR(-1)

Description

Retrieve and set the SLPID assigned to the MS for Sleep Mode