Home

1756HP-GSM USER MANUAL

1. o Page 14 of 43 1756HP GSM User Manual Rev 2 24 Input Image Description Field Value Description Location Type Online 1 Busy 0 Indicates that the module has successfully initialized and that the module is connected to the GSM network indicates if module is busy Local s l Data 0 0 BIT New SMS Received PIN required PUK required SIM Error GPRS Error CSpeak GPRS RX Indicates new SMS received 0 No new SMS received 1 New SMS received Indicates that the SIM card the module uses requires a PIN number to be entered Please refer to the configuration of the module 0 No PIN required 1 PIN required Indicates that the SIM card the module uses requires a PUK number to be entered The SIM needs to be removed from the module and configured There is a problem with the module s SIM card There is a GPRS specific error Some form of CSpeak GPRS packet has been received 0 GPRS request has been issued 1 New CSpeak GPRS response has been received Local s l Data 0 1 Local s l Data 0 2 Local s l Data 0 3 Local s l Data 0 4 Local s l Data 0 5 Local s l Data 0 6 BIT BIT BIT BIT BIT BIT Error Code Signal Strength Should the module experience an error an error code will be inserted The strength of the signal expressed in percentage Local s l Data 0 8 15 Local s l Data 1
2. J Controller GSM SMS 29 Controller Fault Handler Power Up Handler Tasks 69 MainTask C MainProgram A Program Tags MainRoutine Bl SMS Receive SMS Send Unscheduled Programs Phases 3 Motion Groups Ungrouped Axes Trends 23 Data Types 68 User Defined 1 GSM Config Wi SMS Received SMS Sending Cal Strings Address SMS STRING W STRING Predefined C Module Defined YO Configuration 9 1756 Backplane 1756 47 fa 0 1756 L61 GSM SMS 8 4 1756 MODULE SMS Module Page 10 of 43 1756HP GSM User Manual Rev 2 24 Very Important When booting up the 1756HP GSM module enter the C correct PIN number in the configuration Booting up with the incorrect PIN 3 times will result in the SIM card being locked requiring a PUK security code The Configuration data is as follows GSMConfig E en GSMConfig GSMConfig PIN_Code 4743 STRING m GSMConfig PORT_Listen 15050 ow STRING aSMConfig APN Name uwwwy hiprom co za Ted STRING n GSMCaonfig FirewW all IP 196 135 148 1 DT IP Address m GSMConfig Firew all Mask 7255 255 255201 DISSE IP Address o m8SMConfig Module Mode 1 Decimal SINT iu GSMConfig ServiceCentreNumber 127829119 x STRING Figure 5 7 GSMConfig Configuration Should the SIM being used with the module require a PIN to be entered the Configuration data must be setup For example should the PIN be 47
3. chnolog E Horam E cpu 1756HP GSM USER MANUAL Rev 2 2 4 April 2008 1756HP GSM User Manual Rev 2 24 Table of Contents Chapter i e e e i Chapter 2 Module Accessories 1 Chapter 3 ModuleOperation Chapter 4 Installing the Module seen Chapter 5 ConfiguringtiheModule Chapter 6 Address Map sss rim iel demekse Chapter 7 SendingandReceivingaSMS Chapter 8 GPRS Communication esee Appendix A Module Status Mem Appendix B lt eu ERU MMC EN HIM MU MM n EIE Page 2 of 43 1756HP GSM User Manual Rev 2 24 CHAPTER 1 INTRODUCTION Hiprom presents the 1756HP GSM interface module The 1756HP GSM is an integrated GSM product that slots into the Allen Bradley ControlLogix PLC system The 1756HP GSM master module utilizes two forms of GSM communication to transmit information to from the PLC 1 SMS Short Message Service 2 GPRS General Packet Radio Service The module fits directly into any single slot within a ControlLogix System and is configured in RSLogix5000 using the Generic Profile A SMA connector located on the underside of the module provides an interface to the antenna supplied This document serves to describe the functionality
4. Page 12 of 43 1756HP GSM User Manual Rev 2 24 The following ladder is added to the program to copy the status over from the card s Input Image File Source Dest GSM Status GSM1 Extended Error Code Length OP Copy File Source Local 3 Data 0 Dest GSM Status GSM Length 2 Extended Error Code Local 3 l Data 5 1 Page 13 of 43 1756HP GSM User Manual Rev 2 24 CHAPTER 6 ADDRESS MAP The input and output image of the 1756HP GSM module is defined in the following sections Input Image 32bit words Word 31 30 29 28 27 26 24 23 22 21 20 19 18 17 16 15 14 13 12 10 9 8 7 6 5 4 3 2 1 50 Sra Strong ReewdSMSGemt GO Ea er RdressiHex Bye 4 Byte I GPRS 51 LstGomnection FROM Hex Byte 4 e faledOnt Hin Num IP recswedOnim Reserved Reserved Reserved Reserved Reserved SMSmode 0 GPRSmode 1 Reserved Reserved GPRS Listen Mode CSpeak GPRS RX SIM ERROR PUK Required PIN Required New SMS Received Online 1 Busy 0 Reserved RX Packet TNS Num H int GRPS Data Size to Follow L int GPRS Data 50 DINTs Max Table 6 1 Connected Input Image Output Image Words 0 50 DINTs Word Description Reserved Reserved Reserved Reserved Reserved Reserved Etc
5. Physical data that has been received GPRS Data Data is received High_INT Low_INT 16 54ae_6542 Local s l Data 13 Local s l Data 62 BINT Table 6 2 Input Image description Page 16 of 43 1756HP GSM User Manual Rev 2 24 CHAPTER 7 SENDING AND RECEIVING A SMS Sending an SMS SMS Send Routine An SMS is sent by issuing a custom CIP message to the module The ladder below is the recommended procedure to send the SMS using a timer smsTimer DN SG Type CIP Generic Message Control SendSMSMsg TON Timer On Delay Timer smsTimer Preset 3600000 Accum 355221 smsTimer DN SendSMSMsg DN smsONS Source 1 Source smsSentCount 1 Dest smsSentCount 1 Figure 7 1 Send SMS Ladder Example Field Value Message Type CIP Generic Service Type Custom Service Code 0x32 Class 0 71 Instance 0x01 Attribute 0x01 Source Length 184 bytes Destination Element Destination tag for reply data The destination element is a dummy array and named Response or SMS Response Page 17 of 43 1756HP GSM User Manual Rev 2 24 The message SendSMSMsg needs to be configured as follows Message Configuration SendSMSMsg t3 Configuration Communication Tag Message Type Generic Service Source Element SMSSendReq Numb xl Type Source Leng
6. SINT DINT Received SMS Count Received SMS Text Size Number of SMS received This Field will increment each time a new SMS is received Size of Received SMS Text This will indicate the size number of characters of the new SMS received Local s l Data 2 Local s l Data 3 DINT DINT Ext Error Code Local IP Address Extended Error Code Local IP address of Module This is the local IP address assigned to the SIM card by the network supplier Local s l Data 6 Local s l Data 4 DINT DINT Page 15 of 43 1756HP GSM User Manual Rev 2 24 Last Connection IP Shows the last IP address that has FROM contacted this module Local s l Data 5 DINT CRC ErrCnt L int Number of CRC errors received Local s l Data 7 INT ContextNotOpenedCnt Number of GPRS contexts that have H int failed Local s l Data 7 INT Number of times IP has been successfully returned from network IP receivedCnt L int Local s l Data 8 INT Activation failedCnt Number of times Context activation H int has failed Local s l Data 8 INT Internal RecCnt L int Number of Internal Network recoveries Local s l Data 9 INT Number that increments when Data RX Packet TNS Num Packet Arrives Can be used to track Local s l Data 12 INT H int Function 3 Data packet Arrival GRPS Data Size to The number of INTs that have been Follow received from another GSM module Local s I Data 12 INT
7. Page 30 of 43 1756HP GSM User Manual Rev 2 24 Message Block Configuration The configuration of the GPRS message instruction is as follows Field Value Message Type CIP Generic Service Type Custom Service Code 0x32 Class 0 71 Instance 0x02 Attribute 0x01 Source Length 232 bytes Destination Element Destination tag for reply data Table 8 1 1 GRPS configuration Message Configuration GPRS Message Block Configuration Communication Tag Message Type Generic Y Service Custom Source Element RS RequestIP LEN xl Source Length 232 Bytes Service EN i m Code 3 Hex Class 71 Hex Destination GPRS_Response Instance 2 Altribute 1 Hex Enable Enable Waiting Start Done Done Length 0 Error Code Extended Error Code Timed Out Error Path Error Text Cancel Help Figure 8 1 a GPRS Message Block Configuration Page 31 of 43 1756HP GSM User Manual Rev 2 24 EG P 1 if 8 Decimal 1501405 NOTE THIS VALUE MUST THE SAME i 750000 e e e e ok o nin om o Fe AH o I E co oo ojo 5 o o oo o ojo 5 o a Figure 8 1 b GPRS Message 00 lock Configuration Values Note The Val
8. 1 Data 6 Local 4l Data 7 Local 4 l Data 8 Local4 l Data 3 Local 4 1 Data 10 Local 4 1 Data 11 Local 4 l Data 12 Local 4 1 Data 13 Local 41l Data 14 Local 4 Data 15 Local4 Data 16 Local 4 1 Dataf1 7 11 perme 74 Decimal 0 Decimal 0 Decimal 16 487 9403 Hex 16 487 940a Hex 0 Decimal 0 Decimal 16 0000 0002 Hex 0 Decimal 0 Decimal 0 Decimal 16 0002 000a Hex 16 0006 0005 Hex 16 0008 0007 Hex 16 000a 0009 Hex Decimal 0 Decimal mc Figure 8 4 Inputlmage of GSM Module Data ype DINT 53 DINT DINT DINT DINT DINT DINT DINT DINT DINT DINT DINT DINT DINT DINT DINT DINT DINT DINT TIL d Page 35 of 43 1756HP GSM User Manual Rev 2 24 The IP Address data type is defined as i String IP Address max Name IP Address Description Maximum Characters 19 Members Data Type Size 20 byte s LEN DINT Decimal DATA SINT 15 ASCII Description oc Cancel Help Figure 8 5 IP Address Data Type The Address field will only accept an IP address in the correct format The format is Byte1 Byte2 Byte3 Byte4 Example 192 168 10 66 Note If the IP address is in the incorrect format the message block will Fail with Error Code 16 0003 Page 36 of 43 1756HP GSM User Manual Rev 2 24 ModuleStatusBits RunTest Local 5 Data 0 0 GPRS Message Bloc
9. Block Timeout 1640000 0002 1640000 0003 SMS timeout error potential network problem SMS Sending error Cell number and or message incorrect format A 6 Message Block Extended Error Codes GPRS Code Description 1640000 0204 Message Block Timeout 1680000 0001 CRC Error 1640000 0002 1640000 0003 1640000 0004 1640000 0006 1640000 0007 1640000 0008 1640000 000B GPRS Response has not been received correctly potential signal network problem Request IP address incorrect format length Module is in wrong Mode Timeout in opening Socket Slave might not be online Network quality antenna status might be suspect Retry connect Connection failed Slave might not be online Incorrect IP Incorrect Port Retry connect Context Not Opened Module will try to establish context Retry connect Internal Network Recover Page 42 of 43 1756HP GSM User Manual Rev 2 24 APENDIX8 SPECIFICATIONS Parameter Specification General Module Location Any Slot Electrical Backplane Current 515mA 0 5 1V 3mA 24V Schedules Connection Parameters RPI 5ms to 750 5 GPRS Specification GSM Module Telit GE863 QUAD RoHS Compliant Quad Band GPRS Class 10 Max Average current consumption during 400mA GPRS transmission Max Peak current consumption 1 9A impulsive Antenna GSM Shark Fin Antenna Connector SMA male connecto
10. Decimal GPRS Packet Recieved Ei GPRS Listen Mode BOOL Decimal Listen n 1 Reserved 1 BOOL Decimal Reserved fal Reserved_2 BOOL Decimal Reserved Module Mode BOOL Decimal SMS 0 GPRS SMS 1 Reserved 3 BOOL Decimal Reserved Reserved_4 BOOL Decimal Reserved Reserved 5 BOOL Decimal Reserved Ei Reserved BOOL Decimal Reserved Reserved_7 BOOL Decimal Reserved Bi ErrorCode SINT Decimal Error Code fal Reserved_8 SINT Decimal Reserved Signal Strength DINT Decimal GSM Signal Strength iei Extended Error Code DINT Decimal Extended Error Code 1 Description E MEE Decimal BOOL Decimal BOOL BOOL Decimal BOOL 5 Decimal BDOL Decimal BOOL Decimal BOOL BOOL Decimal Decimal BOOL Decimal Decimal SM Status PIN Required On Boot SM Status PUK Required SIMFail 5M Status Reserved 1 SM Status Reserved 2 GSM Status Module Mode Ex AC ba i er er SM Status Reserved 3 ololeololeleloeolrle o jojojojo 5M Status Reserved 5 SM Status Reserved GSM Status Reserved 7 GSM Status ErrorCode BSM Status Reserved 8 H GSM Status Signal Strength GSM Status Extended Error Code Decimal Decimal Decimal Decimal Decimal SINT Re Decimal s Decimal
11. List SMSIndex Message DateTime 0 Lenath SMS character Source Local 4 l Data 3 150 Dest SMS List SMSIndex Message Length 150 ADD Add Source 1 Source SMSIndex 0 Dest SMSindex 0 EQ 3 Grtr Than or E l amp B Move Source Source 0 Dest SMSlndex 0 Source B Figure 7 8 1 Processing Response Array Page 24 of 43 1756HP GSM User Manual Rev 2 24 Name EMS Received Description Data Type Size 204 byte s Members ISMS Received from Cell Number Message Length DINT Decima SMS character length Message DateTime SINT 20 ASCH and Time of SMS jata SINT 160 ASCII SMS Message characters Message_Data Moye Down Cancel Figure 7 8 2 SMS_Received UDT Name eceived Description Members Data Type Size 340 byte s iem ala Type Style Description SMS Received from 51 CellNumber STRING He MsgDateTime STRING Date and Time of SMS MsgData SMS STRING SMS Message characters Figure 7 8 3 Alternative SMS_Received UDT example Page 25 of 43 1756HP GSM User Manual Rev 2 24 In Figure 7 8 1 SMS List is an array of SMS data types to save received SMS s with an increasing SMS ndex value In this example the cell number and received message are copied into their respective positions in a SMS data type The messa
12. User Manual Rev 2 24 Receiving an SMS In the event of a new SMS being received the module will 1 Set bit 1 New SMS Received of Local s l Data 0 2 Increment Local s l Data 2 Received SMS Count 3 Set Local s l Data 3 Received SMS Text Size Count to the character size of the new SMS refer to section 6 2 Field Value Message Type CIP Generic Service Type Custom Service Code 0x32 Class 0 71 Instance 0x01 Attribute 0x02 Source Length 0 bytes Destination Element Destination tag for reply data 1 Message Configuration ReadHewSMS Configuration Communication Tag Message T ype Generic Service Custom Source Element Type Source Length Service Code 32 Hex Class 171 Hex Destination Instance 1 Attribute 2 Hex 1 Enable Enable Waiting D Start Done Q Error Code Extended Error Code Error Path Error Text 2 Bytes p SMS Response 0 New Tag Done Length 205 TimedDut Help Figure 7 6 Read SMS Message Page 21 of 43 1756HP GSM User Manual Rev 2 24 The response array holds the following data once a SMS has been received 28 1900800 1200500 NEU 111 MENE Figure 7 7 Response Array Note The Response array loads its INTEGER values low byte first Note Message received in this
13. installation configuration and use of the module 1 SMS The Short Message Service SMS often called text messaging is a means of sending short messages to and from GSM modules 2 GPRS The General Packet Radio Service GPRS is a service that allows information to be sent and received across a mobile telephone network It supplements today s Circuit Switched Data and Short Message Service GPRS is not related to GPS Global Positioning System Page 3 of 43 1756HP GSM User Manual Rev 2 24 CHAPTER 2 MODULE ACCESSORIES Each 1756HP GSM package includes the following components e 1756HP GSM module e GSM Antenna with patch lead CHAPTER 3 MODULE OPERATION The 1756HP GSM module is designed to operate within the Allen Bradley ControlLogix PLC system All power required for the module s operation is derived from the 1756 backplane Alphanumeric Display Status LEDs Reserved RJ45 Port SMA Connector Figure 3 1 1756HP GSM Layout The current status of the module is conveyed to the user by means of the 3 bi color Status LED s and the alphanumeric LED display Appendix A details the various states of the LED s and messages of alphanumeric display Page 4 of 43 1756HP GSM User Manual Rev 2 24 The following information is available to the user directly across the backplane by means of a scheduled connection Status of the GSM module Signal Strength Expressed in percentage 96 e Indica
14. 43 the above data would be entered Once the module has been inserted into the rack and powered the card will evaluate whether a PIN for the SIM is required If a PIN is required the card will load the PIN configured in the Configuration Image Once the SIM has been initialized correctly the module will attempt to establish connection with the GSM network The Red GSM status LED See Appendix A should be on and the Green GSM Registration LED will be flashing quickly The module will take approximately 1 minute to configure and establish a connection with the GSM network Once it has successfully connected the Green GSM Registration Status LED will begin flashing slowly The module is now ready to send and receive SMSs or transmit receive GPRS data Page 11 of 43 1756HP GSM User Manual Rev 2 24 The GSM Status UDT is shown below as well as an example of a Tag with its corresponding example values Name GSM_Status Description Members Data Type Size 12 byte s Style Description tare OF Bay Dem Busy 0 New SMS Received BOOL Decimal SMS Has Arrived PIN Required On Boot BOOL Decimal PIN Code Request is ON 1 Off 0 PUK Required SIMFail BOOL Decimal PUK Code is reuiqued to unlock SIM SIM Error BOOL Decimal SIM error Has occured GPRS_Error BOOL Decimal GPRS error has occured GPRS_Rx BODL
15. MSSendReq Number1 SMSSendReq Number 2 SMSSendReq Number 3 GE SMSSendReq Number 4 SMSSendRegq Number 5 amp SMSSendReq Number E amp SMSSendReq Number 7 SMSSendReq Number 8 SMSSendReq Number 9 amp SMSSendReq Number 10 SMSSendReq Number11 SMSSendReq Number12 SMSSendA eq Number 1 3 amp E SMSSendReq Number14 SMSSendReq Number 15 SMSSendRegq Number 15 SMSSendReg Number 1 7 SMSSendReg Number 1 8 SMSSendReq Number 13 SMSSendReq Message Desc ipi ASCII ASCII 15 ASC ut ASC 2 ASCI ASCI FT ASC is ASC 6 ASCI ASC s00 asc s00 ASC s00 ASCI s00 ASC goo ASC s00 ASCI 00 ASCI 00 ASCI s00 ASC 00 ASC Controller GSM Trip 12 March 2006 Figure 7 4 SMS Message Setup SMSSendReq Message will be 9 String Browser SMSSendReg Message SMS Sending SINT 20 SINT SINT SINT SINT SINT SINT SINT SINT SINT SINT SINT SINT SINT SINT SINT SINT SINT SINT SINT SINT SMS_STRING Controller GSM Trip on 12 March 2006 at 10 00 Line 2 Position 54 Count 54 of 160 Errors Cancel Help 5 ae 239 Note The module is only capable of sending and receiving text of up to Figure 7 5 SMS Message 160 characters Note CELL NUMBER IS IN ASCII format Page 20 of 43 1756HP GSM
16. RING Security PIN code PORT Listen STRING GPRS Listen PORT Number Name STRING Local APN Name Firewall IP Address Socket Firewall Setup Firewall Mask Address Socket Firewall Setup Module Mode SINT Decimal SMS GPRS 0 1 ServiceCentreNumber STRING SMS Service Center Number Figure 5 5 GSMConfig Configuration UDT 0 File Source GSMConfig Dest Local 5 C Data 0 Length 400 Figure 5 6 Configuration ladder code In the above figure GSMConfig is a user data type and is copied to the module in this manner The configuration data specifies the following The PIN number of the SIM card The GPRS Listening Port Number The GPRS Name The GPRS Firewall IP The GPRS Firewall mask The GSM Module Mode The SMS Service Center Number Page 9 of 43 1756HP GSM User Manual Rev 2 24 The different GSM Module types are 0 Standard SMS Module GSM GPRS disabled 1 GPRS Module GPRS SMS also enabled Note The Configuration is ONLY read when the card initializes itself If any data is changed the card must be reset to enable the changes The mode only needs to be set once Very Important When booting up the 1756HP GSM module enter the correct PIN number in the configuration Booting up with the incorrect PIN 3 times will result in the SIM card being locked requiring a PUK security code Below is an example of what the RSLogix Drop down tree menu might look like
17. See extended error code Connection Received conR A successful GPRS connection has been received from a master module RptC Connection Retry Module is retrying the connection attempt Disconnect Success Module has successfully Disconnected CSP Packet Received CSpeak GPRS data packet has been received Acknowledgement Received A CSpeak GPRS acknowledgment has been received RICA Context Retry Module is attempting to reset GPRS context Snt SMS Message Sent Page 41 of 43 1756HP GSM User Manual Rev 2 24 A 4 Local Error Codes These error codes are located Local s l Data 0 16 23 as an SINT value The error code will occasionally be echoed in the Extended error code DINT value Local s l Data 6 LED Error Display C MSG Block Error Code Description if any Code if any 10 SIM not inserted NoSM 11 SIM PIN required SimE 12 SIM PUK required PUK 13 SIM failure SimE 14 SIM busy SimE 15 SIM wrong SimE 16 SIM Code Incorrect PINx 17 SIM PIN2 required PN2x 18 SIM PUK2 required PUK2 20 memory full SimE 23 memory failure SimE 30 no network service no balance on Sim AIRx 31 network timeout SimE 82 Timeout in opening socket 409 6 83 Connection failed 412 7 84 Context not opened 406 8 85 TX error 413 87 Activation failed 405 98 Already Listening No Err 414 CRC Error 399 1 A 5 Message Block Extended Error Codes SMS Code Description 1640000 0204 Message
18. bytes per day Total 410688 bytes per month 31 days per SIM card Total 0 50 month per SIM card contract therefore the Monthly cost will remain at R39 00 month Note The Total bytes for the month is less than the data included in the per SIM card Page 29 of 43 1756HP GSM User Manual Rev 2 24 Scenario 2 a ONE 1756HP GSM Master FIVE 1756HP GSM Slaves AND b ONE 1756HP GSM Master FIVE 1756HP GSM Slaves Each Master Communicating with 5 slaves polling one at a time a We are Request Read Outputlmage ONCE every 5 minutes from all 5 slaves of 50 Integers 100 bytes b We are sending a Request Write Inputlmage ONCE every 10 minutes to the other 5 slaves of 10 integers 20 bytes a SIM Total per slave Per Day 288 requests received 288 messages sent 288 x 14bytes 288 x 12 100bytes 4032 32256 36288 bytes SIM Total master Per Day 36288 x 5 181440 bytes Total per day 217728 bytes day Total per month 6749568 bytes approx 6 7MB month Each Slave uses 1124928 bytes approx 1 1MB per month Master uses 5624640 bytes approx 5 6MB per month b SIM Total per slave Per Day 144 Write Inputlmage Received 144 Acks sent 144 x 12 20bytes 144 x 14 6624 bytes SIM Total master Per Day 6624 x 5 33120 bytes Each Slave uses 205344 bytes less than 0 5MB per month Master uses 1026720 bytes approx 1MB per month
19. es Type Description Response 0 2 INT Number of INTS requested Response 1 2 INT Slave s Outputlmage 0 Response n 2 INT Slave s Outputlmage n 1 where n indicates the number of INTs requested Table 8 1 2 GPRS Read Outputlmage response The Datasize of the GPRS payload it restricted to Minimum Maximum 1 INT 100 INTs 2 bytes 200 bytes per message Page 34 of 43 1756HP GSM User Manual Rev 2 24 Function 3 returns an Acknowledgement and therefore no data will be loaded into the response array The data that is sent to the slave is loaded into its Inputlmage starting at index position 12 see Fig 8 4 Note Local s I Data 12 constitutes two INTs HIGH INT Rx Packet TNS Number LOW INT Number of INTS that have been received In Figure 8 4 Local s Data 12 1620002 000a This means TNS value is 2 Three Function3 packets have arrived 0 1 and 2 The data size is 10 INTS 0x000a Data Received Integer1 0x0005 Integer2 0x0006 Integer3 0x0007 Integer4 0x0008 Integer4 0x0009 Integer4 0x000a amp Value Local 4 l Data decimal 5 decimal 6 decimal 7 decimal 8 decimal 9 decimal 10 Force Style 1 1 Decimal Locak4 1 Data 0 2 0000 0000 0000 0000 0000 0100 1100 0101 Binary Local4l Data 1 Local4l Data 2 Local 4 1 Data 3 Local 4 l Data 4 Local 4 Data 5 Local 4
20. example above figure is Hello Response 21 Response 23 Note This is viewed in ASCII style Page 22 of 43 1756HP GSM User Manual Rev 2 24 The following array positions are important Note Response 26 denotes array position 26 position Description 0 Start of Cell Number of Sending SMS SIM card 11 Start of Date and Time 21 Start of Message Received Table 7 1 Response Array positions Refer to Figure 7 7 when using this table Note The module is only capable of sending and receiving text of up to 160 characters i e Largest message Response 21 Response 100 Page 23 of 43 1756HP GSM User Manual Rev 2 24 SMS Receive Routine The example code illustrates the recommended procedure to read a new SMS Please note that once an SMS has been read the SMS will be deleted from the SIM card in the module to ensure that the card will not run out of memory The ladder example code below thus stores all the received SMS in an array SMS List of data type SMS Received as detailed in Figure 7 8 2 SMS Received from ReadMewSMS DM StoreMessageONS OP 2 Copy File Source SMS Response 0 Dest SMS List SMSIndex Cell Number 0 Length 20 SMS Message characters OP Copy File Source SMS Response 21 Dest SMS List SMSIndex Message Data 0 Length Local 4 Data 3 Date and Time of SMS Copy File Source SMS_Response 11 Dest SMS
21. ge block is fired in the following manner based on the value of the LastSMSCount variable Number of SMS received EG Not Equal Source Local 4 l Data 2 2 Move Source Local 4 l Data 2 2 Source B LastSMSCount Dest LastSMSCount 2 2 ReadSMS ReadSMS SG Type CIP Generic Message Control ReadNewSMS zs 5 5 Figure 7 8 4 Receiving Message Block firing Page 26 of 43 1756HP GSM User Manual Rev 2 24 The following is a list of the parameters needed for sending and receiving SMS s using the sample code provided Figure 7 8 5 Parameter List The following ladder rungs can be added to the Main routine These load the Configuration image and fire the Send Receive routines when applicable 0 Copy File Source Dest Local 4 C Data 0 Length 400 4 Jump To Subroutine Routine Name SMS Send 2 Jump To Subroutine Routine Name SMS Receive End Figure 7 8 6 Main Routine ladder Page 27 of 43 1756HP GSM User Manual Rev 2 24 CHAPTER 8 GPRS COMMUNICATION GPRS Communication is accomplished by setting up a CIP Generic Custom message block The 1756HP GSM Master module is designed in such a way that it can establish a one to one GPRS connection with multiple slave modules The Master connects to a slave sends request receives the requested data and then disconnects The process of contacting one slave takes approximately 15 30 seconds
22. k EN SG 0 e Co Type CIP Generic Message Control GPRS Message Block RunTest End Figure 8 6 Read Outputlmage Message ladder example Page 37 of 43 1756HP GSM User Manual Rev 2 24 Network Examples Eg1 SMS aciei aai Sending SMS Control Room Alarm has been triggered 19 07 Module CELL PHONE 1 1756HP GSM CELL PHONE 2 Module1 p CELL PHONE 3 5 CELL PHONE 4 1756HP GSM Module2 Figure 8 7 SMS Network Example Page 38 of 43 1756HP GSM User Manual Rev 2 24 Eg2 GPRS CONTROLLOGIX RACK 1756HP GSM 1 192 168 10 001 192 168 10 002 192 168 10 003 192 168 10 004 1756HP GSM 1756HP GSM 1756HP GSM INSTRUMENT 1 INSTRUMENT 2 INSTRUMENT 3 Page 39 of 43 1756HP GSM User Manual Rev 2 24 APENDIX a MODULE STATUS The following sections describe the status indicators of the module A 1 Status LEDs of Display DESCRIPTION STATUS MEANING Solid Red Initialization or Watch Dog Fault Module Status Flashing Red Major Fault Flashing Green Minor Fault Green Module operating correctly 2 GSM Status LEDs Located on the bottom of the module LED DESCRIPTION STATUS MEANING Solid Red a GSM module is powered and unctioning properly RED Power No power is being supplied to the GSM Off module the module is not operating correctly Flashi
23. ng Quickly The Module has not established Approx Every 1 connection with the GSM network GREEN Registration Sec Approx every 1 Sec Status Flashing Slowly The module has successfully Approx Every 3 established a connection with the GSM Sec network Page 40 of 43 1756HP GSM User Manual Rev 2 24 A 3 Status Display Init Initialization of Module The module is initialized only on power up Frn Firmware Revision The firmware revision number is displayed on power up Conn Establishing Connection The module is attempting to connect to the network PnOK The PIN code has been accepted PINx The PIN code has not been accepted PUK PUK Required The SIM card requires the PUK code Err Error Received An error has been received see ERROR CODE in the Inputlmage GSM Module is configured as a standard GSM module GPRS is disabled GPRS Module is configured as a GPRS module SMSr Reading new received SMS from the module SMSt Transmitting an SMS from the module SSxx Signal Strength Xx is the GSM network signal strength expressed in percentage Connection Attempt conA Master module is attempting to establish a connection with a slave module Connection Success conS GPRS connection has been successfully established data communication will now follow assuming sufficient signal quality Connection Failure GPRS connection has failed
24. r Frequency Range 824 960 MHz and 1700 2170 MHz Polarization Linear Vertical or Horizontal Impedance 500 nominal VSWR lt 2 511 Gain 1 5 0 5 dBi including cable losses Weight 300g Page 43 of 43
25. re 8 2 GPRS Connect Request UDT Page 33 of 43 1756HP GSM User Manual Rev 2 24 EISEFIEEISESEESEBESESESESESESESESESISESISESEE GPRS Request GPRS Request IP GPRS_Request PORT GPRS Request Function Number GPRS Request Reserved Con GPRS Request Reserved gsmC GPRS Reguest Slave Response GPRS Request DataSize GPRS_Request Data GPRS_Request Data 0 GPRS_Request Data 1 GPRS Request Data 2 GPRS Request Data 3 GPRS Request Data 4 GPRS Request Data 5 GPRS Request Data 5 GPRS Request Data GPRS Request Data 8 GPRS Request Data 3 GPRS Request Data 10 GPRS Request Data 11 GPRS Request Data 12 GPRS Request Data 13 GPRS Request Data 14 GPRS Request Data 39 net an 196 135 148 3 5050 2 0 0 100 o ojojojojojojojojojojojolojojojojojojo Decimal Decimal Decimal Decimal Decimal Decimal Decimal Decimal Decimal Decimal Decimal Decimal Decimal Decimal Decimal Decimal Decimal Decimal Decimal Decimal Decimal Decimal Decimal Decimal Decimal Decimal GPRS_Connect_Request IP_Address INT INT INT INT INT INT INT 100 INT INT INT INT INT INT INT INT INT INT INT INT INT INT INT INT INT INT INT Figure 8 3 GPRS Request variable Function 2 will return the data into the destination response array with the following format Field Byt
26. ser Manual Rev 2 24 The steps required to add a new 1756HP GSM module are detailed below Controller GPS EG3 Description Communications Controllers Digital Drives Motion Find Add Favorite G nesi LZ Figure 5 2 Select Generic 1756 Module 1756 MODULE By Vendor Favorites Page 7 of 43 1756HP GSM User Manual Rev 2 24 General Connection Module Info Backplane Type 1756 MODULE Generic 1756 Module Parent Local m Connection Parameters Assembly Instance Size Name esM Input fi 63 32 bit Description Output 2 50 H 2i Configuration 4 400 E 8 bit Comm Format Osta DINT Status Input Slot gt H Status Status Offline Cancel Apply Help Figure 5 3 Configure module s parameters General Connection Module Info Backplane Requested Packet Interval RPI 000 0 2 750 0 ms Inhibit Module Major Fault On Controller If Connection Fails While in Run Mode Use Scheduled Connection aver ControlNet Module Fault Status Offline Cancel Apply Help Figure 5 4 Configure module s Requested Packet Interval Page 8 of 43 1756HP GSM User Manual Rev 2 24 The configuration data is defined in a UDT of type GSMConfig defined as follows Name GSMContig Description Members Data Type Size 396 byte s Style Description PIN_Code ST
27. th 184 i Bytes Service 2 m Code 32 Hex Class 71 Hex Destination 0 7 Instance f Attribute 1 Hex Nene Enable Enable Waiting Q Start Done Done Length 0 Error Code Extended Error Code Timed Out Error Path SMS_Module Error Text Cancel Appl Help Figure 7 2 Send SMS Message Configuration The source tag element SMSSendReg is a UDT User Data Type of type SMS Sending which is detailed below SMS Sending ES Name 5 5 Sending Description Members Data Type Size 184 byte s Description Number SINT 20 ASCII Cell number to send to Message SMS STRING Message to Send i Cancel App Help Figure 7 3 1 SMS_Sending UDT Page 18 of 43 1756HP GSM User Manual Rev 2 24 The SMS STRING data type is defined as follows in the following diagram STRING Description Maximum Characters fi 50 25 Data Size 164 byte s Description Figure 7 3 2 SMS STRING UDT Page 19 of 43 1756HP GSM User Manual Rev 2 24 Example of sending an SMS Let s assume we would like to send an SMS to 0851234567 with the text Controller GSM Trip on 12 March 2006 at 10 00 Line 2 The source Tag SMSSendReq will be configured as follows q SMSSendReq H SMSSendReg Number SMSSendReq Number 0 S
28. tion of new SMS and size of new SMS The SMA connector located on the bottom of the module provides an external connection for the GSM antenna The module is supplied with the respective patch cable Other information is also available with respect to the GPRS functionality Local IP Address of SIM e Indication of received CSpeak GPRS packet data CHAPTER 4 INSTALLING THE MODULE The module is equipped with RIUP Removal and Insertion Under Power circuitry enabling the module to be installed or removed from the chassis while power is applied Page 5 of 43 1756HP GSM User Manual Rev 2 24 CHAPTER 5 CONFIGURING THE MODULE A direct connection between the controller and the 1756HP GSM module is required to transfer data to and from the module Establishing the Direct Connection This section describes the procedures necessary to configure the 1756HP GSM module within the ControlLogix system Each 1756HP GSM module must be owned by a single ControlLogix controller The 1756 Generic Module is used in RSLogix5000 to configure the module The configuration of the module is detailed in the tables below Module Configuration Data Format CommFormat Data DINT Connection parameters Description Instance Size Input 1 63 32 Bit Output 2 50 32 Bit Configuration 4 400 8 Bit RPI RPI 100 msec Table 5 1 1756HP GSM connection parameters Page 6 of 43 1756HP GSM U
29. ue of the Unconnected Message Block Timeout must be set to between 60seconds 90seconds le 60000000 605 Page 32 of 43 1756HP GSM User Manual Rev 2 24 Creating a Connection To create a data transfer connection we need a GPRS Message Block and a variable of the UDT GPRS Connect Request called GPRS Request in this example Fig 8 2 and 8 3 Using this variable we specify the IP address and Port Number we want to connect to as well as the Function Number we would like to use with their respective other reference values The IP address is the address associated with the SIM card obtained through an APN The Port number can range from 0 65535 Function Numbers 2 Read the Slave s Outputlmage size returns values to response array Slave Response DataSize Number of Integers required from slave 3 Write Data to Slave s Inputlmage data is sent to slave module DataSize Number of Integers to send to slave Data 0 99 Physical data to send to slave Name GPRS Connect Request Description Members Data Type Size 232 byte s DataType Address PORT INT Decimal Function Number INT Decimal 2 ReadSlaveDutputlmage 3 WriteD ataT oSlavelnputlmage Reserved Con INT Decimal Reserved gsmComp INT Decimal Slave Response DataSize Decimal Used with Function 2 requested data size in INTS DataSize INT Decimal Used with Function 3 Data INT 100 Decimal Used with Function 3 Figu
30. under good signal conditions This is dependent on network availability and good network conditions The Master can contact multiple slaves in a polling fashion Each slave is required to have a unique SIM card with a network assigned unique IP address GPRS communication is very cost effective and is calculated by the volume of data sent and received by each module and not the time you spend connected The GPRS communication uses a communication protocol called CSpeak The following data characteristics are associated with this protocol Minimum Packet Size Master Requests Request Read Outputlmage 14 Bytes Request Write Inputlmage 12 Bytes Payload Slave Messages Response Read Outputlmage 12 Bytes Payload Response Write Inputlmage Ack 14 Bytes Page 28 of 43 1756HP GSM User Manual Rev 2 24 Data Cost Examples Using an example Network Supplied SIM contract with the following details Contract R39 00 month Data included 5 Megabyte Effective In bundle rate R7 80 per MB Out of bundle rate R2 00 per MB Approx 7 8x10 cents per byte Scenario 1 ONE 1756HP GSM Master ONE 1756HP GSM Slave a We are sending a Request Read Outputlmage ONCE every 10 minutes and we are requesting 10 Integers 16bit 10 integers 20 bytes SIM Total Per Day 144 requests Sent 144 messages Received a 144 x 14bytes 144 x 12 20 bytes 6624 bytes Total for Master 6624 bytes per day Total for Slave 6624

1756HP-GSM USER MANUAL

Contents

Download Pdf Manuals

Related Search

Related Contents