Message

SCPI Commands :

CONFigure:LTE:SIGNaling<instance>:CBS:MESSage:ENABle
CONFigure:LTE:SIGNaling<instance>:CBS:MESSage:ID
CONFigure:LTE:SIGNaling<instance>:CBS:MESSage:IDTYpe
CONFigure:LTE:SIGNaling<instance>:CBS:MESSage:CGRoup
CONFigure:LTE:SIGNaling<instance>:CBS:MESSage:CATegory
CONFigure:LTE:SIGNaling<instance>:CBS:MESSage:SOURce
CONFigure:LTE:SIGNaling<instance>:CBS:MESSage:DATA
CONFigure:LTE:SIGNaling<Instance>:CBS:MESSage:UCODed
CONFigure:LTE:SIGNaling<instance>:CBS:MESSage:WAENable
CONFigure:LTE:SIGNaling<Instance>:CBS:MESSage:WACoordinate
CONFigure:LTE:SIGNaling<instance>:CBS:MESSage:PERiod

class MessageCls

Message commands group definition. 19 total commands, 5 Subgroups, 11 group commands

get_category() → Priority

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

No command help available

return:

category: No help available

get_cgroup() → int

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

Queries the coding group of the message, for the data sources INTernal and FILE.

return:

coding_group: 0 | 1 0: coding group bits 0000, used for internal data source 1: coding group bits 0001, used for file data source

get_data() → str

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

Defines the message text for the data source INTernal.

return:

data: string Up to 1395 characters

get_enable() → bool

# SCPI: CONFigure:LTE:SIGNaling<instance>:CBS:MESSage:ENABle
value: bool = driver.configure.cbs.message.get_enable()

Enables the transmission of cell broadcast messages.

return:

enable: OFF | ON

get_id() → int

# SCPI: CONFigure:LTE:SIGNaling<instance>:CBS:MESSage:ID
value: int = driver.configure.cbs.message.get_id()

Specifies the message ID as decimal value. The related message type is set automatically.

return:

idn: numeric Range: 0 to 65535

get_id_type() → MessageType

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

Selects the message type. The related message ID is set automatically. For user-defined CMAS/ETWS, specify the message ID via method RsCmwLteSig.Configure.Cbs.Message.id.

return:

type_py: APResidentia | AEXTreme | ASEVere | AAMBer | EARThquake | TSUNami | ETWarning | ETWTest | UDCMas | UDETws | GFENcing APResidentia: presidential alert AEXTreme: extreme alert ASEVere: severe alert AAMBer: amber alert EARThquake: earthquake TSUNami: tsunami ETWarning: earthquake + tsunami ETWTest: ETWS test UDCMas: user-defined CMAS UDETws: user-defined ETWS GFENcing: geo fencing

get_period() → float

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

No command help available

return:

interval: No help available

get_source() → MessageHandling

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

Selects the source of the message text.

return:

message_handling: INTernal | FILE | UCODed INTernal The message text is defined via method RsCmwLteSig.Configure.Cbs.Message.data. FILE The message text is read from a file, selected via method RsCmwLteSig.Configure.Cbs.Message.File.value. UCODed The message contents are defined via method RsCmwLteSig.Configure.Cbs.Message.ucoded

get_ucoded() → float

# SCPI: CONFigure:LTE:SIGNaling<Instance>:CBS:MESSage:UCODed
value: float = driver.configure.cbs.message.get_ucoded()

Defines the message contents for the data source UCODed.

return:

user_coded: numeric 0 to 56 binary octets, as hexadecimal or binary number Only complete octets are allowed (binary n*8 bits or hexadecimal n*2 digits) .

get_wa_coordinate() → float

# SCPI: CONFigure:LTE:SIGNaling<Instance>:CBS:MESSage:WACoordinate
value: float = driver.configure.cbs.message.get_wa_coordinate()

Defines the contents of the warning area coordinates field.

return:

wa_coordinates: numeric 0 to 56 binary octets, as hexadecimal or binary number Only complete octets are allowed (binary n*8 bits or hexadecimal n*2 digits) .

get_wa_enable() → bool

# SCPI: CONFigure:LTE:SIGNaling<instance>:CBS:MESSage:WAENable
value: bool = driver.configure.cbs.message.get_wa_enable()

Enables or disables the transmission of the warning area coordinates to the UE.

return:

enable: OFF | ON

set_category(category: Priority) → None

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

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

Defines the message text for the data source INTernal.

param data:

string Up to 1395 characters

set_enable(enable: bool) → None

# SCPI: CONFigure:LTE:SIGNaling<instance>:CBS:MESSage:ENABle
driver.configure.cbs.message.set_enable(enable = False)

Enables the transmission of cell broadcast messages.

param enable:

OFF | ON

set_id(idn: int) → None

# SCPI: CONFigure:LTE:SIGNaling<instance>:CBS:MESSage:ID
driver.configure.cbs.message.set_id(idn = 1)

Specifies the message ID as decimal value. The related message type is set automatically.

param idn:

numeric Range: 0 to 65535

set_id_type(type_py: MessageType) → None

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

Selects the message type. The related message ID is set automatically. For user-defined CMAS/ETWS, specify the message ID via method RsCmwLteSig.Configure.Cbs.Message.id.

param type_py:

APResidentia | AEXTreme | ASEVere | AAMBer | EARThquake | TSUNami | ETWarning | ETWTest | UDCMas | UDETws | GFENcing APResidentia: presidential alert AEXTreme: extreme alert ASEVere: severe alert AAMBer: amber alert EARThquake: earthquake TSUNami: tsunami ETWarning: earthquake + tsunami ETWTest: ETWS test UDCMas: user-defined CMAS UDETws: user-defined ETWS GFENcing: geo fencing

set_period(interval: float) → None

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

No command help available

param interval:

No help available

set_source(message_handling: MessageHandling) → None

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

Selects the source of the message text.

param message_handling:

INTernal | FILE | UCODed INTernal The message text is defined via method RsCmwLteSig.Configure.Cbs.Message.data. FILE The message text is read from a file, selected via method RsCmwLteSig.Configure.Cbs.Message.File.value. UCODed The message contents are defined via method RsCmwLteSig.Configure.Cbs.Message.ucoded

set_ucoded(user_coded: float) → None

# SCPI: CONFigure:LTE:SIGNaling<Instance>:CBS:MESSage:UCODed
driver.configure.cbs.message.set_ucoded(user_coded = 1.0)

Defines the message contents for the data source UCODed.

param user_coded:

numeric 0 to 56 binary octets, as hexadecimal or binary number Only complete octets are allowed (binary n*8 bits or hexadecimal n*2 digits) .

set_wa_coordinate(wa_coordinates: float) → None

# SCPI: CONFigure:LTE:SIGNaling<Instance>:CBS:MESSage:WACoordinate
driver.configure.cbs.message.set_wa_coordinate(wa_coordinates = 1.0)

Defines the contents of the warning area coordinates field.

param wa_coordinates:

numeric 0 to 56 binary octets, as hexadecimal or binary number Only complete octets are allowed (binary n*8 bits or hexadecimal n*2 digits) .

set_wa_enable(enable: bool) → None

# SCPI: CONFigure:LTE:SIGNaling<instance>:CBS:MESSage:WAENable
driver.configure.cbs.message.set_wa_enable(enable = False)

Enables or disables the transmission of the warning area coordinates to the UE.

param enable:

OFF | ON

Cloning the Group

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

Subgroups

• DcScheme
• Etws
• File
• Language
• Serial