1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
|
/*
* FreeRTOS V202111.00
* Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of
* this software and associated documentation files (the "Software"), to deal in
* the Software without restriction, including without limitation the rights to
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
* the Software, and to permit persons to whom the Software is furnished to do so,
* subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*
* https://www.FreeRTOS.org
* https://github.com/FreeRTOS
*
*/
/**
* @file cellular_setup.c
* @brief Setup cellular connectivity for board with cellular module.
*/
/* FreeRTOS include. */
#include <FreeRTOS.h>
#include "task.h"
#include <stdbool.h>
#include <stdlib.h>
#include <stdio.h>
/* Demo Specific configs. */
#include "demo_config.h"
/* The config header is always included first. */
#ifndef CELLULAR_DO_NOT_USE_CUSTOM_CONFIG
/* Include custom config file before other headers. */
#include "cellular_config.h"
#endif
#include "cellular_config_defaults.h"
#include "cellular_types.h"
#include "cellular_api.h"
#include "cellular_comm_interface.h"
/*-----------------------------------------------------------*/
#ifndef CELLULAR_APN
#error "CELLULAR_APN is not defined in cellular_config.h"
#endif
#define CELLULAR_SIM_CARD_WAIT_INTERVAL_MS ( 500UL )
#define CELLULAR_MAX_SIM_RETRY ( 5U )
#define CELLULAR_PDN_CONNECT_WAIT_INTERVAL_MS ( 1000UL )
/*-----------------------------------------------------------*/
/* the default Cellular comm interface in system. */
extern CellularCommInterface_t CellularCommInterface;
/*-----------------------------------------------------------*/
/* Secure socket needs application to provide the cellular handle and pdn context id. */
/* User of secure sockets cellular should provide this variable. */
CellularHandle_t CellularHandle = NULL;
/* User of secure sockets cellular should provide this variable. */
uint8_t CellularSocketPdnContextId = CELLULAR_PDN_CONTEXT_ID;
/*-----------------------------------------------------------*/
bool setupCellular( void )
{
bool cellularRet = true;
CellularError_t cellularStatus = CELLULAR_SUCCESS;
CellularSimCardStatus_t simStatus = { 0 };
CellularServiceStatus_t serviceStatus = { 0 };
CellularCommInterface_t * pCommIntf = &CellularCommInterface;
uint8_t tries = 0;
CellularPdnConfig_t pdnConfig = { CELLULAR_PDN_CONTEXT_IPV4, CELLULAR_PDN_AUTH_NONE, CELLULAR_APN, "", "" };
CellularPdnStatus_t PdnStatusBuffers = { 0 };
char localIP[ CELLULAR_IP_ADDRESS_MAX_SIZE ] = { '\0' };
uint32_t timeoutCountLimit = ( CELLULAR_PDN_CONNECT_TIMEOUT / CELLULAR_PDN_CONNECT_WAIT_INTERVAL_MS ) + 1U;
uint32_t timeoutCount = 0;
uint8_t NumStatus = 1;
CellularPsmSettings_t psmSettings = { 0 };
/* Initialize Cellular Comm Interface. */
cellularStatus = Cellular_Init( &CellularHandle, pCommIntf );
if( cellularStatus == CELLULAR_SUCCESS )
{
/* wait until SIM is ready */
for( tries = 0; tries < CELLULAR_MAX_SIM_RETRY; tries++ )
{
cellularStatus = Cellular_GetSimCardStatus( CellularHandle, &simStatus );
if( ( cellularStatus == CELLULAR_SUCCESS ) &&
( ( simStatus.simCardState == CELLULAR_SIM_CARD_INSERTED ) &&
( simStatus.simCardLockState == CELLULAR_SIM_CARD_READY ) ) )
{
/* Turn of PSM because this is demo to showcase MQTT instead of PSM mode. */
psmSettings.mode = 0;
cellularStatus = cellularStatus = Cellular_SetPsmSettings( CellularHandle, &psmSettings );
if( cellularStatus != CELLULAR_SUCCESS )
{
configPRINTF( ( ">>> Cellular_SetPsmSettings failure <<<\r\n" ) );
}
else
{
configPRINTF( ( ">>> Cellular SIM okay <<<\r\n" ) );
}
break;
}
else
{
configPRINTF( ( ">>> Cellular SIM card state %d, Lock State %d <<<\r\n",
simStatus.simCardState,
simStatus.simCardLockState ) );
}
vTaskDelay( pdMS_TO_TICKS( CELLULAR_SIM_CARD_WAIT_INTERVAL_MS ) );
}
}
/* Setup the PDN config. */
if( cellularStatus == CELLULAR_SUCCESS )
{
cellularStatus = Cellular_SetPdnConfig( CellularHandle, CellularSocketPdnContextId, &pdnConfig );
}
else
{
configPRINTF( ( ">>> Cellular SIM failure <<<\r\n" ) );
}
/* Rescan network. */
if( cellularStatus == CELLULAR_SUCCESS )
{
cellularStatus = Cellular_RfOff( CellularHandle );
}
if( cellularStatus == CELLULAR_SUCCESS )
{
cellularStatus = Cellular_RfOn( CellularHandle );
}
/* Get service status. */
if( cellularStatus == CELLULAR_SUCCESS )
{
while( timeoutCount < timeoutCountLimit )
{
cellularStatus = Cellular_GetServiceStatus( CellularHandle, &serviceStatus );
if( ( cellularStatus == CELLULAR_SUCCESS ) &&
( ( serviceStatus.psRegistrationStatus == REGISTRATION_STATUS_REGISTERED_HOME ) ||
( serviceStatus.psRegistrationStatus == REGISTRATION_STATUS_ROAMING_REGISTERED ) ) )
{
configPRINTF( ( ">>> Cellular module registered <<<\r\n" ) );
break;
}
else
{
configPRINTF( ( ">>> Cellular GetServiceStatus failed %d, ps registration status %d <<<\r\n",
cellularStatus, serviceStatus.psRegistrationStatus ) );
}
timeoutCount++;
if( timeoutCount >= timeoutCountLimit )
{
cellularStatus = CELLULAR_INVALID_HANDLE;
configPRINTF( ( ">>> Cellular module can't be registered <<<\r\n" ) );
}
vTaskDelay( pdMS_TO_TICKS( CELLULAR_PDN_CONNECT_WAIT_INTERVAL_MS ) );
}
}
if( cellularStatus == CELLULAR_SUCCESS )
{
cellularStatus = Cellular_ActivatePdn( CellularHandle, CellularSocketPdnContextId );
}
if( cellularStatus == CELLULAR_SUCCESS )
{
cellularStatus = Cellular_GetIPAddress( CellularHandle, CellularSocketPdnContextId, localIP, sizeof( localIP ) );
}
if( cellularStatus == CELLULAR_SUCCESS )
{
cellularStatus = Cellular_GetPdnStatus( CellularHandle, &PdnStatusBuffers, CellularSocketPdnContextId, &NumStatus );
}
if( ( cellularStatus == CELLULAR_SUCCESS ) && ( PdnStatusBuffers.state == 1 ) )
{
configPRINTF( ( ">>> Cellular module registered, IP address %s <<<\r\n", localIP ) );
cellularRet = true;
}
else
{
cellularRet = false;
}
return cellularRet;
}
/*-----------------------------------------------------------*/
|
