Message¶
SCPI Commands
CONFigure:GSM:SIGNaling<Instance>:CBS:MESSage:ENABle
CONFigure:GSM:SIGNaling<Instance>:CBS:MESSage:ID
CONFigure:GSM:SIGNaling<Instance>:CBS:MESSage:IDTYpe
CONFigure:GSM:SIGNaling<Instance>:CBS:MESSage:SERial
CONFigure:GSM:SIGNaling<Instance>:CBS:MESSage:DCSCheme
CONFigure:GSM:SIGNaling<Instance>:CBS:MESSage:CATegory
CONFigure:GSM:SIGNaling<Instance>:CBS:MESSage:DATA
CONFigure:GSM:SIGNaling<Instance>:CBS:MESSage:PERiod
- class Message[source]
Message commands group definition. 8 total commands, 0 Sub-groups, 8 group commands
- class SerialStruct[source]
Structure for reading output parameters. Fields:
Geo_Scope: enums.GeographicScope: CIMMediate | PLMN | LOCation | CNORmal The geographical area over which the message code is unique. CIMMediate: cell-wide, immediate display PLMN: PLMN-wide, normal display LOCation: location area-wide, normal display CNORmal: cell-wide, normal display
Message_Code: int: CB message identification Range: 0 to 1023
Auto_Incr: bool: OFF | ON OFF: no increase of UpdateNumber upon a CB message change ON: increase UpdateNumber automatically upon a CB message change
Update_Number: int: Indication of a content change of the same CB message Range: 0 to 15
- get_category() → RsCmwGsmSig.enums.Priority[source]
# SCPI: CONFigure:GSM:SIGNaling<instance>:CBS:MESSage:CATegory value: enums.Priority = driver.configure.cbs.message.get_category()
No command help available
- return
category: No help available
- get_data() → str[source]
# SCPI: CONFigure:GSM:SIGNaling<instance>:CBS:MESSage:DATA value: str = driver.configure.cbs.message.get_data()
Defines the CB message text.
- return
data: Up to 160 characters
- get_dc_scheme() → int[source]
# SCPI: CONFigure:GSM:SIGNaling<instance>:CBS:MESSage:DCSCheme value: int = driver.configure.cbs.message.get_dc_scheme()
Specifies language using the GSM 7-bit default alphabet.
- return
data_code_scheme: 0: coding group 0000, language 0001 (English) 1: coding group 0001, language 0000 (GSM 7-bit default alphabet; message preceded by language indication) Range: 0 to 1
- get_enable() → bool[source]
# SCPI: CONFigure:GSM:SIGNaling<instance>:CBS:MESSage:ENABle value: bool = driver.configure.cbs.message.get_enable()
Enables the particular CB message.
- return
enable: OFF | ON
- get_id() → int[source]
# SCPI: CONFigure:GSM:SIGNaling<instance>:CBS:MESSage:ID value: int = driver.configure.cbs.message.get_id()
Identifies source/type of a CB message. Edit this parameter for user-defined settings. Also, hexadecimal values are displayed for information.
- return
idn: Range: 0 to 65.535E+3
- get_id_type() → RsCmwGsmSig.enums.MsgIdSeverity[source]
# SCPI: CONFigure:GSM:SIGNaling<instance>:CBS:MESSage:IDTYpe value: enums.MsgIdSeverity = driver.configure.cbs.message.get_id_type()
Specifies the severity of the message ID.
- return
type_py: UDEFined | APResidentia | AEXTreme | ASEVere | AAMBer UDEFined: user defined APResidentia: presidential level alerts (IDs 4370 and 4383) AEXTreme: extreme alerts (IDs 4371 to 4372 and 4384 to 4385) ASEVere: severe alerts (IDs 4373 to 4378 and 4386 to 4391) AAMBer: amber alerts (IDs 4379 and 4392)
- get_period() → int[source]
# SCPI: CONFigure:GSM:SIGNaling<instance>:CBS:MESSage:PERiod value: int = driver.configure.cbs.message.get_period()
No command help available
- return
interval: No help available
- get_serial() → SerialStruct[source]
# SCPI: CONFigure:GSM:SIGNaling<instance>:CBS:MESSage:SERial value: SerialStruct = driver.configure.cbs.message.get_serial()
Specifies the unique CB message identification.
- return
structure: for return value, see the help for SerialStruct structure arguments.
- set_category(category: RsCmwGsmSig.enums.Priority) → None[source]
# SCPI: CONFigure:GSM:SIGNaling<instance>:CBS:MESSage:CATegory driver.configure.cbs.message.set_category(category = enums.Priority.BACKground)
No command help available
- param category
No help available
- set_data(data: str) → None[source]
# SCPI: CONFigure:GSM:SIGNaling<instance>:CBS:MESSage:DATA driver.configure.cbs.message.set_data(data = '1')
Defines the CB message text.
- param data
Up to 160 characters
- set_dc_scheme(data_code_scheme: int) → None[source]
# SCPI: CONFigure:GSM:SIGNaling<instance>:CBS:MESSage:DCSCheme driver.configure.cbs.message.set_dc_scheme(data_code_scheme = 1)
Specifies language using the GSM 7-bit default alphabet.
- param data_code_scheme
0: coding group 0000, language 0001 (English) 1: coding group 0001, language 0000 (GSM 7-bit default alphabet; message preceded by language indication) Range: 0 to 1
- set_enable(enable: bool) → None[source]
# SCPI: CONFigure:GSM:SIGNaling<instance>:CBS:MESSage:ENABle driver.configure.cbs.message.set_enable(enable = False)
Enables the particular CB message.
- param enable
OFF | ON
- set_id(idn: int) → None[source]
# SCPI: CONFigure:GSM:SIGNaling<instance>:CBS:MESSage:ID driver.configure.cbs.message.set_id(idn = 1)
Identifies source/type of a CB message. Edit this parameter for user-defined settings. Also, hexadecimal values are displayed for information.
- param idn
Range: 0 to 65.535E+3
- set_id_type(type_py: RsCmwGsmSig.enums.MsgIdSeverity) → None[source]
# SCPI: CONFigure:GSM:SIGNaling<instance>:CBS:MESSage:IDTYpe driver.configure.cbs.message.set_id_type(type_py = enums.MsgIdSeverity.AAMBer)
Specifies the severity of the message ID.
- param type_py
UDEFined | APResidentia | AEXTreme | ASEVere | AAMBer UDEFined: user defined APResidentia: presidential level alerts (IDs 4370 and 4383) AEXTreme: extreme alerts (IDs 4371 to 4372 and 4384 to 4385) ASEVere: severe alerts (IDs 4373 to 4378 and 4386 to 4391) AAMBer: amber alerts (IDs 4379 and 4392)
- set_period(interval: int) → None[source]
# SCPI: CONFigure:GSM:SIGNaling<instance>:CBS:MESSage:PERiod driver.configure.cbs.message.set_period(interval = 1)
No command help available
- param interval
No help available
- set_serial(value: RsCmwGsmSig.Implementations.Configure_.Cbs_.Message.Message.SerialStruct) → None[source]
# SCPI: CONFigure:GSM:SIGNaling<instance>:CBS:MESSage:SERial driver.configure.cbs.message.set_serial(value = SerialStruct())
Specifies the unique CB message identification.
- param value
see the help for SerialStruct structure arguments.