{"id":1945,"date":"2025-04-14T11:44:39","date_gmt":"2025-04-14T11:44:39","guid":{"rendered":"https:\/\/webprojects.cloud\/wordpress\/splatco\/?post_type=spl_knowledgebase&p=1945"},"modified":"2025-06-10T08:51:21","modified_gmt":"2025-06-10T08:51:21","slug":"sx10506-programming","status":"publish","type":"spl_knowledgebase","link":"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/product-documentation\/product-documentation-xwire-peripherals\/sx10506-pressure-sensor\/sx10506-programming\/","title":{"rendered":"SX10506: Programming"},"content":{"rendered":"\n

The following table shows how the Xwire data block needs to appear in memory. The Receive data block consists of 4 bytes.<\/p>\n\n\n\n

Xwire receive data block:<\/p>\n\n\n\n

Memory<\/th>Description<\/th>Format<\/th><\/tr>
3<\/td>Pressure data<\/td>24 bit floating point number normalised to 1.0000<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

*Note that this data block does not need to start at memory location 0. The data block can be moved anywhere in memory as long as it stays together, is in the order above and is defined in the\u00a0NVEM<\/a>\u00a0Xwire table in the program code.<\/p>\n\n\n\n

Example program demonstrating how to interface with a SX10506<\/h6>\n\n\n\n
*    Program written for a MMI202a with a 2x16 LCD.
*    The MMI202a communicates to the SX10506 over the XWire peripheral interface.
*    MMI202a controller is the XWire master and the SX10506 is the XWire slave.
 
 
** Setup **
 
* The SX10502 is interfaced to the MMI202a over X<\/a>-Wire protocol by setting the communications jumper to the X position.
* No board ID jumpers are installed as the X-Wire slave address for the SX10506 is address 0.
* The X-Wire cable is connected from the CN12 connector on the MMI to the X1 connector on the SX10506. 
 
** Program operation **
 
* X-Wire is set up to return pressure data to the MMI202a. 
* Pressure from the SX10506 is continually updated on the LCD.
* If at any time there are Xwire communications errors the front panel LED on output 15 will light.
* The user presses and holds iBTN_Calibrate for 10 seconds to enter calibration mode.
* At power on if the pressure calibration has not been previously set the program will enter calibration mode.
* Once calibrated, the calibration values are stored to shadow memory so they survive power off.
  
 
   * XWire Equates *
 
XW_Address:       EQU            0                    ;Xwire Address of slave.  
 
 
   * XWire Receive data block *

   * Data block of 4 bytes *
 
XW_RxRAMstart:    EQU            100                  ;The starting memory location of the Xwire receive data block.
XW_RxRAMlength:   EQU            4                    ;The size of the returned data in bytes.
XW_fPressure:     mEQU           100,4                ;Location where the SX10506 Pressure reading is returned.
 
 
   * XWire Transmit data block *

   * Data block of 0 bytes *
  
XW_TxRAMstart:    EQU            120                  ;The starting memory location of the xwire transmit data block.
XW_TxRAMlength:   EQU            0                    ;There are no bytes to send to the SX10506.
 
 
   * Input Equates *
 
iBTN_Calibrate:   iEQU           12                   ;User presses and holds for 10 seconds to enter calibration mode.
iBTN_Poffset:     iEQU           11                   ;When button is pressed the current pressure reading is saved as the offset. (Calibration only)
iBTN_Pspan:       iEQU           10                   ;When button is pressed the span is calculated and saved.                    (Calibration only)
 
 
   * Output Equates *
 
oXW_XWireError:   oEQU           15                   ;LED turns on when there is an Xwire communication error.\t
 
   * Pressure sensor calibration constants SHADOW memory *
 
CalFlag:          EQU            'AA                  ;Value of the valid calibration flag.
ShadowLength:     EQU            9                    ;Length of shadow memory.
ShadowStart:      EQU            200                  ;Start of shadow memory buffer.
fPoffset:         mEQU           200,4                ;Floating point pressure calibration offset value.
fPspan:           mEQU           204,4                ;Floating point pressure scale factor.
bCalibratedFlag:  mEQU           208                  ;Byte that is set to 'AA when the pressure sensor is calibrated.
 
   * defFOAT Directives *
    
fCalc:            defFLOAT                            ;Where the current calculated water height is stored.
    
 *******************
 ** Program start **
 *******************
 
   XwireMaster    XwireTab                            ;Start xwire going.
   LaunchTask     MSQ_Start                           ;Start the Main Sequencer task running.
   LaunchTask     Xwire_Task                          ;Start the XWire error checking task running.
   RunTasksForever
 
 
MSQ_Start:
   ShadowRead     ShadowStart,ShadowLength            ;Recall calibration data (if present) from shadow memory.
   GoIfMNE        bCalibratedFlag,CalFlag,Calibrate   ;If the calibration flag is 'AA then calibration is already set. Otherwise calibrate the pressure sensor.         

MSQ_Display:
   YieldTask
   GoSub          MSQ_Sub0_CalcHeight                 ;Calculate the current water level.
   GoSub          MSQ_Sub1_DispHeight                 ;Display current water level.
   GoIfInOFF      iBTN_Calibrate,MSQ_Display          ;Test if the user wishes to enter Calibration mode.
   MarkTime                                           ;Start the timer running.
 
 * Enter this state if the user has pressed and holds *
 * the iBTN_Calibrate button *
   
MSQ_Display_T:  
   YieldTask
   GoSub          MSQ_Sub0_CalcHeight                 ;Calculate the current water level.
   GoSub          MSQ_Sub1_DispHeight                 ;Display current water level.
   GoIfInOFF      iBTN_Calibrate,MSQ_Display          ;Is the user still holding the iBTN_Calibrate button ?
   LoopIfTiming   1000,MSQ_Display_T
   GoTo           Calibrate                           ;If the user holds the iBTN_Calibrate button for 10 seconds enter Calibration Mode.
 
 * Subroutines *

MSQ_Sub0_CalcHeight:
   fRecallQ       XW_fPressure                        ;Calculate water height. Water height = (PressureSensorReading - Poffset) \/ (Pspan)
   fRecallW       fPoffset   
   fSub
   fRecallQ       fPspan   
   fSwap
   fDiv
   fStore         fCalc                               ;Store the calculated value temporarily.
   Return
 
MSQ_Sub1_DispHeight:
   fRecallW       fCalc                               ;Recall value to display.
                  ;0123456789012345
   OBLCD_SetCur   0,0
   OBLCD_Text     \"  Water height  \"
   OBLCD_SetCur   1,0                                 ;Display result on the LCD.
   OBLCD_fDispW   7,2
   OBLCD_Text     \"m        \"
   Return
    
*******************************\t\t
* Pressure sensor calibration *
*******************************
                  
* We are now in pressure calibration mode. We now wait for iBTN_Poffset button to be pressed before
* we store the low point value. Water depth is assumed to be at minimum.
  
Calibrate:        ;0123456789012345
   OBLCD_SetCur   0,0
   OBLCD_Text     \"Water level = 0m\"
   OBLCD_SetCur   1,0                                 ;Display message.
   OBLCD_Text     \"Press Poffset   \"

   WaitOn         iBTN_Poffset                        ;Has iBTN_Poffset button been pressed ?
   fRecallW       XW_fPressure                        ;Get current pressure sensor reading.
   fStore         fPoffset                            ;Store to Poffset.
                 
* We are now waiting for the iBTN_Pcal button to be pressed before we calculate the span. 
* Span is calculated as Pressure at 1m of water - fPoffset.
  
Calibrate_0:      ;0123456789012345
   OBLCD_SetCur   0,0
   OBLCD_Text     \"Water level = 1m\"
   OBLCD_SetCur   1,0                                 ;Display message.
   OBLCD_Text     \"Press Pspan     \"
   
   WaitOn         iBTN_Pspan                          ;Has iBTN_Pcal button been pressed ?
   fRecallQ       XW_fPressure                        ;Get current pressure sensor reading.
   fRecallW       fPoffset                            ;Calculate span.
   fSub
   fStore         fPspan                              ;Store to Pspan.
   SetMem         bCalibratedFlag,CalFlag             ;Set a flag to show at startup calibration has already been done.
   ShadowWrite    ShadowStart,ShadowLength            ;Save calibration parameters and flag.
   GoTo           MSQ_Start

 
 ****************************
 ** Xwire Error Check Task **
 ****************************
 
Xwire_Task:

XW0:
   YieldTask
   XwireGetErrCount                                   ;Get the xwire error count.
   GoIfF          XW1
   On             oXW_XWireError                      ;Turn on error LED if there are XWire errors.
   Pause          1
   GoTo           XW0
XW1:\t\t
   Off            oXW_XWireError\t
   GoTo           XW0

 

   NVEM0
 
XWireTab:         ;Slave address, transmit data block, Tx bytes, receive data block, Rx bytes.

   NV0Byte        XW_Address,XW_TxRAMstart,XW_TxRAMlength,XW_RxRAMstart,XW_RxRAMlength
   NV0Byte\t   255\t\t\t\t\t     ;End of table sentinel.    
<\/pre>\n","protected":false},"excerpt":{"rendered":"
The following table shows how the Xwire data block needs to appear in memory. The Receive data block consists of 4 bytes. Xwire receive data…<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":1933,"menu_order":6,"template":"","class_list":["post-1945","spl_knowledgebase","type-spl_knowledgebase","status-publish","hentry"],"acf":[],"yoast_head":"\nSX10506: Programming - SPLat Controls<\/title>\n<meta name=\"robots\" content=\"noindex, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"SX10506: Programming - SPLat Controls\" \/>\n<meta property=\"og:description\" content=\"The following table shows how the Xwire data block needs to appear in memory. The Receive data block consists of 4 bytes. Xwire receive data...\" \/>\n<meta property=\"og:url\" content=\"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/product-documentation\/product-documentation-xwire-peripherals\/sx10506-pressure-sensor\/sx10506-programming\/\" \/>\n<meta property=\"og:site_name\" content=\"SPLat Controls\" \/>\n<meta property=\"article:modified_time\" content=\"2025-06-10T08:51:21+00:00\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"1 minute\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/product-documentation\/product-documentation-xwire-peripherals\/sx10506-pressure-sensor\/sx10506-programming\/\",\"url\":\"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/product-documentation\/product-documentation-xwire-peripherals\/sx10506-pressure-sensor\/sx10506-programming\/\",\"name\":\"SX10506: Programming - SPLat Controls\",\"isPartOf\":{\"@id\":\"https:\/\/webprojects.cloud\/wordpress\/splatco\/#website\"},\"datePublished\":\"2025-04-14T11:44:39+00:00\",\"dateModified\":\"2025-06-10T08:51:21+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/product-documentation\/product-documentation-xwire-peripherals\/sx10506-pressure-sensor\/sx10506-programming\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/product-documentation\/product-documentation-xwire-peripherals\/sx10506-pressure-sensor\/sx10506-programming\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/product-documentation\/product-documentation-xwire-peripherals\/sx10506-pressure-sensor\/sx10506-programming\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/webprojects.cloud\/wordpress\/splatco\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Product documentation\",\"item\":\"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/product-documentation\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Product documentation: Xwire peripherals\",\"item\":\"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/product-documentation\/product-documentation-xwire-peripherals\/\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"SX10506: Pressure Sensor\",\"item\":\"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/product-documentation\/product-documentation-xwire-peripherals\/sx10506-pressure-sensor\/\"},{\"@type\":\"ListItem\",\"position\":5,\"name\":\"SX10506: Programming\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/webprojects.cloud\/wordpress\/splatco\/#website\",\"url\":\"https:\/\/webprojects.cloud\/wordpress\/splatco\/\",\"name\":\"SPLat Controls\",\"description\":\"OEM Embedded Machine Controllers\",\"publisher\":{\"@id\":\"https:\/\/webprojects.cloud\/wordpress\/splatco\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/webprojects.cloud\/wordpress\/splatco\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/webprojects.cloud\/wordpress\/splatco\/#organization\",\"name\":\"SPLat Controls\",\"url\":\"https:\/\/webprojects.cloud\/wordpress\/splatco\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/webprojects.cloud\/wordpress\/splatco\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/webprojects.cloud\/wordpress\/splatco\/wp-content\/uploads\/2024\/10\/logo.svg\",\"contentUrl\":\"https:\/\/webprojects.cloud\/wordpress\/splatco\/wp-content\/uploads\/2024\/10\/logo.svg\",\"caption\":\"SPLat Controls\"},\"image\":{\"@id\":\"https:\/\/webprojects.cloud\/wordpress\/splatco\/#\/schema\/logo\/image\/\"}}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"SX10506: Programming - SPLat Controls","robots":{"index":"noindex","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"og_locale":"en_US","og_type":"article","og_title":"SX10506: Programming - SPLat Controls","og_description":"The following table shows how the Xwire data block needs to appear in memory. The Receive data block consists of 4 bytes. Xwire receive data...","og_url":"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/product-documentation\/product-documentation-xwire-peripherals\/sx10506-pressure-sensor\/sx10506-programming\/","og_site_name":"SPLat Controls","article_modified_time":"2025-06-10T08:51:21+00:00","twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"1 minute"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/product-documentation\/product-documentation-xwire-peripherals\/sx10506-pressure-sensor\/sx10506-programming\/","url":"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/product-documentation\/product-documentation-xwire-peripherals\/sx10506-pressure-sensor\/sx10506-programming\/","name":"SX10506: Programming - SPLat Controls","isPartOf":{"@id":"https:\/\/webprojects.cloud\/wordpress\/splatco\/#website"},"datePublished":"2025-04-14T11:44:39+00:00","dateModified":"2025-06-10T08:51:21+00:00","breadcrumb":{"@id":"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/product-documentation\/product-documentation-xwire-peripherals\/sx10506-pressure-sensor\/sx10506-programming\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/product-documentation\/product-documentation-xwire-peripherals\/sx10506-pressure-sensor\/sx10506-programming\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/product-documentation\/product-documentation-xwire-peripherals\/sx10506-pressure-sensor\/sx10506-programming\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/webprojects.cloud\/wordpress\/splatco\/"},{"@type":"ListItem","position":2,"name":"Product documentation","item":"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/product-documentation\/"},{"@type":"ListItem","position":3,"name":"Product documentation: Xwire peripherals","item":"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/product-documentation\/product-documentation-xwire-peripherals\/"},{"@type":"ListItem","position":4,"name":"SX10506: Pressure Sensor","item":"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/product-documentation\/product-documentation-xwire-peripherals\/sx10506-pressure-sensor\/"},{"@type":"ListItem","position":5,"name":"SX10506: Programming"}]},{"@type":"WebSite","@id":"https:\/\/webprojects.cloud\/wordpress\/splatco\/#website","url":"https:\/\/webprojects.cloud\/wordpress\/splatco\/","name":"SPLat Controls","description":"OEM Embedded Machine Controllers","publisher":{"@id":"https:\/\/webprojects.cloud\/wordpress\/splatco\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/webprojects.cloud\/wordpress\/splatco\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/webprojects.cloud\/wordpress\/splatco\/#organization","name":"SPLat Controls","url":"https:\/\/webprojects.cloud\/wordpress\/splatco\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/webprojects.cloud\/wordpress\/splatco\/#\/schema\/logo\/image\/","url":"https:\/\/webprojects.cloud\/wordpress\/splatco\/wp-content\/uploads\/2024\/10\/logo.svg","contentUrl":"https:\/\/webprojects.cloud\/wordpress\/splatco\/wp-content\/uploads\/2024\/10\/logo.svg","caption":"SPLat Controls"},"image":{"@id":"https:\/\/webprojects.cloud\/wordpress\/splatco\/#\/schema\/logo\/image\/"}}]}},"_links":{"self":[{"href":"https:\/\/webprojects.cloud\/wordpress\/splatco\/wp-json\/wp\/v2\/spl_knowledgebase\/1945","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/webprojects.cloud\/wordpress\/splatco\/wp-json\/wp\/v2\/spl_knowledgebase"}],"about":[{"href":"https:\/\/webprojects.cloud\/wordpress\/splatco\/wp-json\/wp\/v2\/types\/spl_knowledgebase"}],"author":[{"embeddable":true,"href":"https:\/\/webprojects.cloud\/wordpress\/splatco\/wp-json\/wp\/v2\/users\/1"}],"up":[{"embeddable":true,"href":"https:\/\/webprojects.cloud\/wordpress\/splatco\/wp-json\/wp\/v2\/spl_knowledgebase\/1933"}],"wp:attachment":[{"href":"https:\/\/webprojects.cloud\/wordpress\/splatco\/wp-json\/wp\/v2\/media?parent=1945"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}