nrf9160

Set command

The set command can be used to write, read, and clear periodic search configuration and to start a search. The configuration affects the periodic searches that the User Equipment (UE) performs in limited service state to obtain normal service.

Syntax:

%PERIODICSEARCHCONF=<mode>[,<loop>,<return_to_pattern>,<band_optimization>,<pattern_1>
[,<pattern_2>][,<pattern_3>][,<pattern_4>]]

Response syntax for mode 1:

%PERIODICSEARCHCONF: <loop>,<return_to_pattern>,<band_optimization>,<pattern_1>[,<pattern_2>][,<pattern_3>][,<pattern_4>]
+CME ERROR code
513 – Not found.
527 – Invalid content.

The set command parameters and their defined values are the following:

<mode>
Selects the performed operation. The additional optional parameters are valid only for mode 0.
0 – Write.
1 – Read.
2 – Clear.
3 – Search now.
Note: When <mode> is 3, the response is always OK, which indicates that the request has been delivered to the modem. The search is performed only when the modem is in sleep state between periodic searches.
<loop>
Indicates if the last given search pattern is looped from the beginning when the pattern has ended. If several search patterns are configured, <loop> impacts only the last pattern.
0 – No loop.
1 – Loop last search pattern.
<return_to_pattern>
Indicates if the modem can return to a given search pattern with shorter sleep periods, for example, when radio conditions change and the given pattern index has already been exceeded.
0 – No return.
1–4 – Return to search pattern index 1–4.
<band_optimization>
0 – No optimization. Every periodic search is an all band search.
1 – Use default optimizations predefined by the modem. Predefinition depends on the active data profile, which can be configured with %XDATAPRFL.
2 – Every second periodic search is an all band search.
3 – Every third periodic search is an all band search.
4 – Every fourth periodic search is an all band search.
20 – Every 20th periodic search is an all band search.
<pattern_1…pattern_4>
The write command and response to the read command can contain 1–4 search pattern entries. Each pattern entry is range or table type and enclosed in quotation marks ("pattern_1", "pattern_2").
Range type search pattern: "<type>,<initial_sleep>, <final_sleep>,[<time_to_final_sleep>], <pattern_end_point>"
Table type search pattern: "<type>,<val1>[,<val2>][,<val3>][,<val4>][,<val5>]"

The following parameters describe the content of <pattern 1...pattern4>:

<type>
0 – Range.
1 – Table.
<initial_sleep>
0–65535 s.
Sleep time between searches in the beginning of the range.
<final_sleep>
0–65535 s.
Sleep time between searches in the end of the range.
<time_to_final_sleep>
0–1080 min. Optional.
Target time for achieving the <final_sleep> value. This can be used to determine the angle factor between the <initial_sleep> and <final_sleep> times. The timeline for the <time_to_final_sleep> starts from the beginning of the search pattern.
If given, the value cannot be greater than the value of <pattern_end_point> in the same search pattern. If not given, the angle factor is calculated using the <pattern_end_point> value so that the <final_sleep> value is reached at the point of <pattern_end_point>.
<pattern_end_point>
0–1080 min.
Time that must elapse before entering the next search pattern. The timeline for <pattern_end_point> starts from the beginning of the limited service starting point which is the moment when the first sleep period started.
<val1...val5>
0–65535 s.
1–5 sleep time values between searches. After going through all values, the last value of the last search pattern is repeated if not configured differently by the <loop> or <return_to_pattern> parameters.

The following diagram shows an example of two configured search patterns' behavior on a timeline. The first search pattern is table type, and the second search pattern is range type.

Figure 1. Example of two different types of search patterns
Example of two different types of search patterns

The following diagram shows the sleep lengths in search pattern 1 in Example of two different types of search patterns.

Figure 2. Sleep lengths in search pattern 1
Sleep lengths in search pattern 1

The following diagram shows the sleep lengths in search pattern 2 in Example of two different types of search patterns. The sleep time reaches the <final_sleep> value in 10 minutes according to the <time_to_final_sleep> parameter.

Figure 3. Sleep lengths in search pattern 2
Sleep lengths in search pattern 2

The following command example configures one range type search pattern without the optional <time_to_final_sleep> parameter:

AT%PERIODICSEARCHCONF=0,0,0,10,"0,60,3600,,600"
OK

The following command example reads the configuration:

AT%PERIODICSEARCHCONF=1
%PERIODICSEARCHCONF: 0,0,10,"0,60,3600,,600"
OK

The following command example configures one range type search pattern with the optional <time_to_final_sleep> parameter and additional table type search pattern with three sleep time values that are looped when the pattern has ended:

AT%PERIODICSEARCHCONF=0,1,0,10,"0,60,3600,300,600","1,60,120,3600"
OK

The following command example requests an extra search now:

AT%PERIODICSEARCHCONF=3
OK

The following command example clears the configuration:

AT%PERIODICSEARCHCONF=2
OK

The following command example reads the configuration when no configuration is stored:

AT%PERIODICSEARCHCONF=1
%PERIODICSEARCHCONF: 
OK

The modem uses specific periodic search patterns for each power level defined in the %XDATAPRFL command. The following commands correspond to the search pattern configurations used for each power level. They are default configurations, and any specific periodic cell search configuration overrides them.

Ultra low power:

AT%PERIODICSEARCHCONF=0,0,0,1,"0,10,40,,5","1,300,600,1800,1800,3600"

Low power:

AT%PERIODICSEARCHCONF=0,0,0,1,"0,10,40,,5","1,300,600"

Normal:

AT%PERIODICSEARCHCONF=0,0,0,1,"0,10,40,5,15","1,60,90,300"

Performance:

AT%PERIODICSEARCHCONF=0,0,0,1,"0,10,40,5,15","1,60,90"

High performance:

AT%PERIODICSEARCHCONF=0,0,0,1,"1,10","0,10,40,,15"

For more information on data profile power levels, see Data profile %XDATAPRFL.