II-VI Incorporated 375 Saxonburg Boulevard Saxonburg, PA 16056 XMF-H User Guide D50165-IM T. 724.352.4455 | F. 724.352.5284 | www.ii-vi.
II-VI Incorporated 375 Saxonburg Boulevard Saxonburg, PA 16056 Table of Contents 1 Revision History .................................................................................................................................... 3 2 Scope ..................................................................................................................................................... 4 3 Network Setting .............................................................................................
II-VI Incorporated 375 Saxonburg Boulevard Saxonburg, PA 16056 1 Revision History Revision Date 1.0 October 12th, 2020 Description Initial Release T. 724.352.4455 | F. 724.352.5284 | www.ii-vi.
II-VI Incorporated 375 Saxonburg Boulevard Saxonburg, PA 16056 2 Scope The scope of this XMF-H document is to describe: • Procedure to configure network setting • Procedure to upgrade firmware images • Procedure to use SDK usage to build new application • Procedure to use supporting features T. 724.352.4455 | F. 724.352.5284 | www.ii-vi.
II-VI Incorporated 375 Saxonburg Boulevard Saxonburg, PA 16056 3 Network Setting This unit is configured in AP mode when it’s arrived. User may set it to Station Mode to add it to their network. This section describes the step to change the network setting to Station Mode. 1. Power up the unit and allow the boot to complete. Note: It takes approximately 35 seconds to boot up. 2. Click on the wireless access point and choose “XMF-H_{MAC_Address}” to connect to its WIFI. 3.
II-VI Incorporated 375 Saxonburg Boulevard Saxonburg, PA 16056 • Click “Save and Apply” at the lower right corner to save password. • Click “xmf-h Web Panel”, upper right corner, to return to the main GUI window. 5. Click NETWORK SETTINGS tab. 6. Click Network tab. 7. Select Station Mode. 8. 9. 10. 11. 12. Choose the “Detected WIFI network” and enter the password (network password). Click CONFIGURE & RESTART. Unit will take approximately 1 minute to go into a configuration and reboot.
II-VI Incorporated 375 Saxonburg Boulevard Saxonburg, PA 16056 4 Firmware Upgrade for XMF-H using Web UI This section describes how to update the XMF-H firmware through Web UI. Prerequisites: • Extract Pre-built-image.zip which contains XMF-H firmware file. 1. lks7688.img Procedure: 1. Access Web UI of XMF-H by entering http://ipaddress in chrome web browser. 2. Click “Network Settings” option on left side panel on Web page. 3. Enter Username (root) and Password, then press Sign In button.
II-VI Incorporated 375 Saxonburg Boulevard Saxonburg, PA 16056 5. Click on “Choose the file” and select the firmware image file lks7688.img. 6. Click “Upgrade & Restart” button, as shown below. 7. The firmware uploads to XMF-H. The WiFi LED will start blinking fast. Do not press the PWR button or reset the board. Please make sure the board stays connected to its power source until the firmware update is complete. A message confirms that the firmware is updated, click OK. T. 724.352.4455 | F. 724.352.
II-VI Incorporated 375 Saxonburg Boulevard Saxonburg, PA 16056 8. After approximately 3 minutes, the WiFi LED will light solid to indicate that the firmware update is completed. The device will automatically reboot. 9. After 30 seconds or more, the WiFi LED turns off. Now scan and connect to the WiFi AP, reload the webpage, set a new password and sign in. The new firmware version details will be displayed in the software information, as shown below. 10.
II-VI Incorporated 375 Saxonburg Boulevard Saxonburg, PA 16056 5 SDK usage to build new application for XMF-H This section provides procedure to build new application for XMF-H using SDK. XMF-H_SDK provides pre-compiled MIPS toolchain designed to cross compile packages. After building the application, user needs to transfer built application or IPK file using SCP to XMF-H. This transferred / installed applications will be retained over reboot.
II-VI Incorporated 375 Saxonburg Boulevard Saxonburg, PA 16056 3. Navigate to the directory "SDK". Linux_Prompt$ cd SDK 4. To compile provided example application, Copy provided sample folders inside APP/package to SDK package directory. Linux_Prompt [SDK]$ cp -r ../../APP/package/* package/.
II-VI Incorporated 375 Saxonburg Boulevard Saxonburg, PA 16056 ramips/bin 7. Find a package file named helloworld_x.x.x-x_ramips_24kec.ipk 8. Transfer the helloworld_x.x.x-x_ramips_24kec.ipk file from the host Linux machine to the XMF-H board using SCP. Linux_Prompt [SDK/bin/ramips/packages/base]$ scp helloworld_x.x.x-x_ramips_24kec.ipk root@ipaddress: Execute following steps on XMF-H board. 9. In the system console of the XMF-H board, navigate to the location of the .
II-VI Incorporated 375 Saxonburg Boulevard Saxonburg, PA 16056 6 Supporting Features 6.1 LIBRARY TO INCLUDE IN C/C++ APPLICATIONS Interface libraries are created for OTDR, OCM, SFP, OCC operations with underlying UART / I2C communications. If user needs to create any new C/C++ applications to communicate with these instruments, mentioned libraries can be linked. 6.1.1 OTDR Library Usage 1. User needs to include the header file of the library into the application. For OTDR, It will be
II-VI Incorporated 375 Saxonburg Boulevard Saxonburg, PA 16056 OTDR Interface Table: Sr No. Command API Remarks int OtdrInterfaceInit(T_OTDRCOMMMODE mode); int OtdrInterfaceDeInit(T_OTDRCOMMMODE mode); T_OTDRCOMMMODE Structure defined in otdr_interface.h T_OTDRCOMMMODE Structure defined in otdr_interface.h T_VER Structure defined in otdr_interface.
II-VI Incorporated 375 Saxonburg Boulevard Saxonburg, PA 16056 20 VER HW int OtdrGetHwVer(T_HWVER *verHw) 21 ALRM x HYS y int OtdrSetAlrmHysteresis(T_OTDRALARMS alarm, int hysteresis); 22 ALRM x CLR int OtdrClearAlarmLatch(T_OTDRALARMS alarm); 23 AST int OtdrGetAst(T_AST *ast) 24 25 26 27 28 29 ASTM N ASTM S ASTM RST BOOT RTC int OtdrSetAstmNormal(void) int OtdrSetAstmSticky(void) int OtdrGetAstm(int *mode) int OtdrFactoryReset(void); int OtdrReboot(void) int OtdrGetRtc(char *time, char *date
II-VI Incorporated 375 Saxonburg Boulevard Saxonburg, PA 16056 OTDR_DEVICE_OFF, OTDR_POWERING_UP, OTDR_POWERING_OFF If there is issue with Device on XMFH, OFF to ON transition will indicate status sequence as: OTDR_DEVICE_OFF > OTDR_POWERING_UP > Post 6-7 Sec timeout > OTDR_DEVICE_OFF 6.1.2 OCM Library Usage 1. User needs to include the header file of the library into the application. For OCM, It will be file. 2.
II-VI Incorporated 375 Saxonburg Boulevard Saxonburg, PA 16056 4 CSSP int OcmGetCSSP(uint32_t *channalPlan, float *startingFreq) T_CSSP Structure defined in ocm_interface.h 5 CSSPx int OcmSetCSSP(uint32_t *channalPlan, float *startingFreq) 6 CBDI int OcmGetCBDI(T_CBDI *cbdi) T_CBDI Structure defined in ocm_interface.h 7 CGTP1B int OcmGetCGTP1B(T_INTEGRATE integration, T_CGTP1B *cgtp1b) T_CGTP1 Structure defined in ocm_interface.
II-VI Incorporated 375 Saxonburg Boulevard Saxonburg, PA 16056 22 CMPP1 23 CSIL1 24 CSPT1 25 OCM Power Operation 26 Get OCM Power Status 6.1.3 int OcmSetCMPP1(float minimumPeakPower) int OcmSetCSIL1(float inserttionLoss) int OcmSetCSPT1(float peakDetectThreshold) int OCMPower(E_POWERSWITCH i_e_switch) int getOCMStatus(void) E_POWERSWITCH Structure defined in ocm_interface.h Possible values: OCM_DEVICE_ON, OCM_DEVICE_OFF, OCM_DEVICE_POWERING_UP, OCM_DEVICE_POWERING_OFF SFP Library Usage 1.
II-VI Incorporated 375 Saxonburg Boulevard Saxonburg, PA 16056 1 Init - Custom API 2 DeInit - Custom API int SFPInterfaceInit(void) int SFPInterfaceDeInit(void) 7 Page Read 8 Page Write 9 Read MOD ABS int SFPReadByte(uint8_t i_ui8_deviceAddress, uint8_t i_ui8_registerAddress, uint8_t* o_ui8_data) int SFPReadWord(uint8_t i_ui8_deviceAddress, uint8_t i_ui8_registerAddress, uint16_t* o_ui16_data) int SFPWriteByte(uint8_t i_ui8_deviceAddress, uint8_t i_ui8_registerAddress, uint8_t i_ui8_data) int SF
II-VI Incorporated 375 Saxonburg Boulevard Saxonburg, PA 16056 If there is issue with Device on XMFH, OFF to ON transition will indicate status sequence as: SFP_DEVICE_OFF > SFP_DEVICE_POWERING_UP > Post 3-4 Sec timeout > SFP_DEVICE_OFF 6.1.4 OCC Library Usage 1. User needs to include the header file of the library into the application. For OCC, It will be file. 2. After including the header file user needs to initialize the library by calling the OCCInterfaceInit() function.
II-VI Incorporated 375 Saxonburg Boulevard Saxonburg, PA 16056 typedef enum { PD_1577=0, PD_1550, PD_1270, PD_4, PD_NONE } E_PDNUM; 3 Read Power 6.1.5 int OCCReadPWR(int i_i_pdNum, float *o_f_pwrVal) XMF-H EEPROM should be flashed with OCC calibration values. If it is not, API will provide uncalibrated Power value and return value will indicate Error. Battery Management Library Usage 1. User needs to include the header file of the library into the application source code. 2.
II-VI Incorporated 375 Saxonburg Boulevard Saxonburg, PA 16056 6.1.6 LED Control Library Usage 1. User needs to include the header file of the library into the application source code. 2. User needs to initialize the library by calling the LEDInit() function. [Once Init is successful, multiple APIs can be called before deinit.] 3. Call the relevant API from following list in LED Control Interface Table to perform operation on LED I2C interface. 4.
II-VI Incorporated 375 Saxonburg Boulevard Saxonburg, PA 16056 3. Link the library while compiling the application by “-li2cinterface”. Common Interface Table: Sr No. Command API Remarks typedef struct _diag { uint8_t conf_reg; uint8_t mfg_id; uint8_t rev_id; uint8_t conv_rate; uint8_t ch_disable_reg; uint8_t status_reg; float temp; float channel[7]; } T_DIAG; 1 6.
II-VI Incorporated 375 Saxonburg Boulevard Saxonburg, PA 16056 6.3 SERIAL APPLICATION Serial Application is intended to use for direct communication over serial interface without much processing. It can help to automate communication using script by calling application along with required arguments. Serial application can be executed by “serialapp” command on XMF-H terminal prompt. Sample commands and output are displayed below.
II-VI Incorporated 375 Saxonburg Boulevard Saxonburg, PA 16056 otdr status OTDR STATUS: IDLE root@xmf-h:~# serialapp 0 cmd-a resp-a otdr dump trace%0d%0a otdr dump trace km,dB 0.0000,-17.50 0.0040,-17.50 0.0080,-17.33 0.0120,-17.10 0.0161,-17.59 0.0201,-40.00 0.0241,-23.23 … … ... 34.9839,-40.00 34.9880,-40.00 34.9920,-40.00 34.9960,-40.00 root@xmf-h:~# serialapp 0 cmd-a resp-a otdr dump event%0d%0a otdr dump event type,x_km,loss_u_km,refl_u_km,loss_dB,refl_dB,attn_dB/km 3,0.0000,0.1406,0.0618,-3.73,-42.
II-VI Incorporated 375 Saxonburg Boulevard Saxonburg, PA 16056 56 49 20 50 68 6f 74 6f 6e 69 63 73 20 20 20 20 20 4c 42 20 41 47 53 43 20 32 30 31 39 30 37 31 36 36 30 36 20 20 20 20 20 20 20 20 20 20 20 20 20 2c 0e root@xmf-h:/IoT/examples# serialapp 1 cmd-a resp-x CGTP1%0d%0a 0a 0a 00 00 00 00 10 03 00 00 00 00 00 00 00 00 00 00 00 00 35 cc 0e 37 ce b7 d5 34 34 33 44 43 a8 8d d6 34 67 26 44 43 7b 87 d6 34 9a 19 44 43 f0 04 d6 34 cd 0c 44 43 15 e8 d5 34 01 00 44 43 20 50 d6 34 34 f3 43 43 2f 97 d5 34 67 e
II-VI Incorporated 375 Saxonburg Boulevard Saxonburg, PA 16056 6.4 XMF-H WEB UI This section provides steps to use Web UI for communication with instruments of XMF-H. 1. To open Web UI, open chrome browser. Then, enter URL http://IP-ADDRESS • Ex: http://10.1.10.184 (if in Station mode) or Ex: http://xmf-h.local or http://192.168.100.1 (if in AP mode) Find out IP address from System information tab as shown in SECTION 3 or by issuing “ifconfig” command on Serial interface console.
II-VI Incorporated 375 Saxonburg Boulevard Saxonburg, PA 16056 • • • If you are accessing Web UI at very first time after firmware flash, set a password using at least six alphanumeric characters and click SIGN IN. Enter the password again and click SIGN IN. You’re now signed into the board’s Web UI. You can move on to flash the latest firmware (refer SECTION 4) or to configure network settings (refer SECTION 3). 3.
II-VI Incorporated 375 Saxonburg Boulevard Saxonburg, PA 16056 • • • • • 6.5 Select the OTDR from the instrument dropdown box. Then select (otdr_get_params, ver, OTDR_ON, OTDR_OFF etc.) command from command dropdown box as shown below: o Click on Submit Button. o You will now see response of selected command. Select the OSA from the instrument dropdown box. Then select any from (PWR_off, CTM_reset, PWR_on etc.) command from command dropdown box. o Click on Submit Button.
II-VI Incorporated 375 Saxonburg Boulevard Saxonburg, PA 16056 6.6 REMOTE FIRMWARE UPGRADE This section describes remote firmware upgrade procedure for XMF-H through Postman Chrome extension. Procedure: 1. Launch Postman Chrome Browser extension. 2. You can create a new request from the Postman launch screen, using New > Request, or by clicking the + button to open a new tab. 3.
II-VI Incorporated 375 Saxonburg Boulevard Saxonburg, PA 16056 8. Once you have your request set up, click Send and examine the Response. 9. A file should be uploaded to /tmp/ to the board. 10. The firmware uploads to XMF-H. The WiFi LED will start blinking fast. Do not press the PWR button or reset the board. Please make sure the board stays connected to its power source until the firmware update is complete. After approximately 5 minutes, the firmware upgrade will be completed.
II-VI Incorporated 375 Saxonburg Boulevard Saxonburg, PA 16056 7. FCC Interference Statement Federal Communications Commission (FCC) Interference Statement This equipment has been tested and found to comply with the limits for a Class B digital device, pursuant to Part 15 of the FCC Rules. These limits are designed to provide reasonable protection against harmful interference in a residential installation.
