Message¶

SCPI Commands

CONFigure:WCDMa:SIGNaling<Instance>:CBS:MESSage:ENABle
CONFigure:WCDMa:SIGNaling<Instance>:CBS:MESSage:ID
CONFigure:WCDMa:SIGNaling<Instance>:CBS:MESSage:IDTYpe
CONFigure:WCDMa:SIGNaling<Instance>:CBS:MESSage:SERial
CONFigure:WCDMa:SIGNaling<Instance>:CBS:MESSage:CGRoup
CONFigure:WCDMa:SIGNaling<Instance>:CBS:MESSage:CATegory
CONFigure:WCDMa:SIGNaling<Instance>:CBS:MESSage:SOURce
CONFigure:WCDMa:SIGNaling<Instance>:CBS:MESSage:DATA
CONFigure:WCDMa:SIGNaling<Instance>:CBS:MESSage:PERiod

class Message[source]

Message commands group definition. 14 total commands, 3 Sub-groups, 9 group commands

class SerialStruct[source]

Structure for reading output parameters. Fields:

Geo_Scope: enums.GeoScope: CIMMediate | PLMN | SERVice | CNORmal The geographical area over which the message code is unique. CIMMediate: cell-wide, immediate display PLMN: PLMN wide SERVice: service area wide 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() → RsCmwWcdmaSig.enums.Priority[source]

# SCPI: CONFigure:WCDMa:SIGNaling<instance>:CBS:MESSage:CATegory
value: enums.Priority = driver.configure.cbs.message.get_category()

Indicates the privilege category of a CB message.

return

category: BACKground | NORMal | HIGH BACKground: to be broadcast, when no CB messages of category high priority or normal are broadcast NORMal: to be broadcast according to the associated repetition period HIGH: to be broadcast at the earliest opportunity

get_cgroup() → int[source]

# SCPI: CONFigure:WCDMa:SIGNaling<instance>:CBS:MESSage:CGRoup
value: int = driver.configure.cbs.message.get_cgroup()

Queries the coding group to be indicated to the CB message recipient. The coding group is defined in 3GPP TS 23. 038, section 5 as bits 4 to 7 of CBS data coding scheme.

return

coding_group: 0: used for internal messages (‘Data Source’ = ‘Use Internal’) 1: used for CBS files (only language = 1: UCS2 is supported) Range: 0 to 1

get_data() → str[source]

# SCPI: CONFigure:WCDMa:SIGNaling<instance>:CBS:MESSage:DATA
value: str = driver.configure.cbs.message.get_data()

Defines the CB message text.

return

data: Up to 1395 characters

get_enable() → bool[source]

# SCPI: CONFigure:WCDMa: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:WCDMa: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. Hexadecimal values are displayed for information.

return

idn: Range: 0 to 65.535E+3

get_id_type() → RsCmwWcdmaSig.enums.CbsMessageSeverity[source]

# SCPI: CONFigure:WCDMa:SIGNaling<instance>:CBS:MESSage:IDTYpe
value: enums.CbsMessageSeverity = driver.configure.cbs.message.get_id_type()

Specifies the severity of the CBS message ID as either decimal or hexadecimal number.

return

type_py: UDEFined | APResidentia | AEXTreme | ASEVere | AAMBer | EARThquake | TSUNami | ETWarning | ETWTest 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) EARThquake: earthquake warning (ID 4352) TSUNami: tsunami warning (ID 4353) ETWarning: earthquake and tsunami warning (ID 4354) ETWTest: ETWS test message (ID 4355)

get_period() → float[source]

# SCPI: CONFigure:WCDMa:SIGNaling<instance>:CBS:MESSage:PERiod
value: float = driver.configure.cbs.message.get_period()

Repetition period to broadcast the CB message again.

return

interval: Range: 1 s to 4096 s

get_serial() → SerialStruct[source]

# SCPI: CONFigure:WCDMa: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.

get_source() → RsCmwWcdmaSig.enums.MessageHandling[source]

# SCPI: CONFigure:WCDMa:SIGNaling<instance>:CBS:MESSage:SOURce
value: enums.MessageHandling = driver.configure.cbs.message.get_source()

Specifies whether the CB message text is entered manually via method RsCmwWcdmaSig.Configure.Cbs.Message. data or an existing CBS file is used. The CBS file is selected via method RsCmwWcdmaSig.Configure.Cbs.Message.File.value.

return

message_handling: INTernal | FILE INTernal: content entered manually FILE: specified *.cbs file is used

set_category(category: RsCmwWcdmaSig.enums.Priority) → None[source]

# SCPI: CONFigure:WCDMa:SIGNaling<instance>:CBS:MESSage:CATegory
driver.configure.cbs.message.set_category(category = enums.Priority.BACKground)

Indicates the privilege category of a CB message.

param category

BACKground | NORMal | HIGH BACKground: to be broadcast, when no CB messages of category high priority or normal are broadcast NORMal: to be broadcast according to the associated repetition period HIGH: to be broadcast at the earliest opportunity

set_data(data: str) → None[source]

# SCPI: CONFigure:WCDMa:SIGNaling<instance>:CBS:MESSage:DATA
driver.configure.cbs.message.set_data(data = '1')

Defines the CB message text.

param data

Up to 1395 characters

set_enable(enable: bool) → None[source]

# SCPI: CONFigure:WCDMa: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:WCDMa: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. Hexadecimal values are displayed for information.

param idn

Range: 0 to 65.535E+3

set_id_type(type_py: RsCmwWcdmaSig.enums.CbsMessageSeverity) → None[source]

# SCPI: CONFigure:WCDMa:SIGNaling<instance>:CBS:MESSage:IDTYpe
driver.configure.cbs.message.set_id_type(type_py = enums.CbsMessageSeverity.AAMBer)

Specifies the severity of the CBS message ID as either decimal or hexadecimal number.

param type_py

UDEFined | APResidentia | AEXTreme | ASEVere | AAMBer | EARThquake | TSUNami | ETWarning | ETWTest 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) EARThquake: earthquake warning (ID 4352) TSUNami: tsunami warning (ID 4353) ETWarning: earthquake and tsunami warning (ID 4354) ETWTest: ETWS test message (ID 4355)

set_period(interval: float) → None[source]

# SCPI: CONFigure:WCDMa:SIGNaling<instance>:CBS:MESSage:PERiod
driver.configure.cbs.message.set_period(interval = 1.0)

Repetition period to broadcast the CB message again.

param interval

Range: 1 s to 4096 s

set_serial(value: RsCmwWcdmaSig.Implementations.Configure_.Cbs_.Message.Message.SerialStruct) → None[source]

# SCPI: CONFigure:WCDMa: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.

set_source(message_handling: RsCmwWcdmaSig.enums.MessageHandling) → None[source]

# SCPI: CONFigure:WCDMa:SIGNaling<instance>:CBS:MESSage:SOURce
driver.configure.cbs.message.set_source(message_handling = enums.MessageHandling.FILE)

Specifies whether the CB message text is entered manually via method RsCmwWcdmaSig.Configure.Cbs.Message. data or an existing CBS file is used. The CBS file is selected via method RsCmwWcdmaSig.Configure.Cbs.Message.File.value.

param message_handling

INTernal | FILE INTernal: content entered manually FILE: specified *.cbs file is used

Cloning the Group

# Create a clone of the original group, that exists independently
group2 = driver.configure.cbs.message.clone()

Subgroups