M2M Management System Release Version: 1.
mFi™ User Guide Table of Contents Table of Contents Chapter 1: System Setup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 mFi System Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 mFi Controller. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 mFi Hardware. . . . . . . . . . . . . . . . . . . . . .
mFi™ User Guide Table of Contents Chapter 5: Events Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 Filter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 Date Range. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19 Devices . . . . . . . . . . . . . . . . . . . .
mFi™ User Guide Table of Contents Appendix A: Pinouts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 mPort-S Serial DB9 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 mPort-S Terminal Block. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 RS232. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
mFi™ User Guide Chapter 1: System Setup mFi Example Diagram mFi-MSW mPort Fan Light mFi-THS SPEED CONSOLE 0 1 2 EdgeRouter Lite mPower UniFi AP or mFi Controller (On-Site Management Station) mFi Controller (Off-Site Cloud/NOC) Chapter 1: System Setup mFi System Overview mFi™ is a M2M management software solution from Ubiquiti Networks, Inc. that is designed to work with Ubiquiti’s mFi product line.
mFi™ User Guide Chapter 1: System Setup mFi Hardware mPort Serial The Ubiquiti Networks mFi platform has multiple solutions for connecting devices to the mFi Controller. The mPort Serial features RS232/422/485 serial connectivity through a standard DB9 serial port or a terminal block connector. It has built-in Wi-Fi and Ethernet to connect to the IP network. mPort The mPort has two mFi RJ45 connectors and a terminal block connector. It has built-in Wi-Fi and Ethernet to connect to the IP network.
mFi™ User Guide Chapter 1: System Setup mPower Mac Users mPower is a mFi Power Strip with independent, switchable AC ports, and energy monitoring. It has built-in Wi-Fi to connect to the IP network. 1. Click the Install icon. mSensors Ubiquiti Networks offers a variety of sensors to connect to the mPort and your mFi network. These sensors connect to the mPort using a standard RJ45 cable, except for the mFi-DS, which connects using a terminal block connector.
mFi™ User Guide Chapter 1: System Setup PC Users Configuring the mFi Controller Software 1. Launch mFi-installer.exe. 1. The mFi Controller software startup will begin. Click Launch a Browser to Manage Network. 2. Click Install. 3. If your computer doesn’t have Java 1.6 or above installed, you will be prompted to install it. Click Install to continue. 2. The mFi Configuration Wizard will appear the first time you launch the mFi Controller software.
mFi™ User Guide 4. Enter an administrator name in the Admin Name field. Enter a password in the Password and Confirm fields. Click Next. Chapter 1: System Setup Methods of Adoption Devices that were not found or connected during the mFi Controller software configuration can be added afterwards. The mPort and mPort Serial can be connected via Ethernet or Wi-Fi. The mPower must be configured via Wi-Fi.
mFi™ User Guide 4. Connect the power cord to the power port on the PoE Adapter. Connect the other end of the power cord to a power outlet. The Power LED should light up. Chapter 1: System Setup Adopting the mPort, mPort Serial, or mPower via the Device’s Configuration Portal The Device Configuration Portal is embedded in the hardware. It can be accessed with a wired Ethernet or wireless connection.
mFi™ User Guide Chapter 1: System Setup Wireless 3. Enter your network information: To configure the mPower, you must connect wirelessly to the SSID of the device. The devices have a default SSID (wireless network name) labeled mFi followed by the last six characters of the MAC address. To access the SSID, perform the following steps for your specific computer operating system: Windows 1. Go to Connect to Network. -- Windows 7 Right-click the Network icon. -- Windows Vista Go to Start > Connect To.
mFi™ User Guide Chapter 2: Using the mFi Software Chapter 2: Using the mFi Software The mFi software has a browser-based interface for easy configuration and management. Common Interface Options The common interface options are accessible from all tabs in the mFi interface. mPower Status mPort Status To access the interface, perform the following steps: 1. Launch the mFi application if hasn’t already been started. Windows users go to Start > All Programs > Ubiquiti mFi > mFi. 2.
mFi™ User Guide Chapter 2: Using the mFi Software Refresh Refresh Rate Refresh button Message Displays the device, triggering value, and event triggering information. Click the highlighted Details link to open the Details window. Events Slider If there is more than one page of events for viewing, the Events slider will appear. Drag the slider to the page you wish to view or click the arrows on the side of the slider to go forward or backward page by page.
mFi™ User Guide Settings Settings contains System and Admin Settings. Chapter 2: Using the mFi Software • Password Enter the password associated with the username that will be used to send email notifications. Apply Click Apply to save changes. Admin Settings System Admin Name Displays the current admin name used to login. To change the admin name, simply enter a new name and click Apply. Password A new password can be entered in this field.
mFi™ User Guide Chapter 3: Map Tab Chapter 3: Map Tab Adding a Map The mFi Controller software allows you to upload custom map images of your location for a visual representation of your mFi device layout. When you initially launch mFi, a default sample map is displayed. To add a custom map, you must first create the image. You can add an image you’ve created or photo that you’ve taken as a map image background.
mFi™ User Guide Chapter 3: Map Tab 2. Click Add a Map. 5. You can adjust the zoom using the slider on the right. Add a Map 3. Enter a map name in the Description field and click Upload my own. Click the Browse button to locate the file to use as a map (valid file formats are .jpg, .gif, and .png). Click Continue. 4. Click Close. Zoom Slider Use to zoom the map detail in and out. 6. Drag Device , mPower , and mPort icons from the list on the left to the appropriate location on the map.
mFi™ User Guide Chapter 3: Map Tab Device Icons Serial Based Device Sensor Outlet Device icons are placed on the map to show the location of your devices. Click and hold the icon to drag the Device to another location on the map. Current This icon represents an electrical current sensor. Current sensors measure values in amps. Power icon Turns on/off power. Green when powered. Shell icon Door/Window This icon represents a door or window sensor.
mFi™ User Guide Chapter 3: Map Tab Lock Locks the selected sensor to the current location on the map and disables the Remove icon functionality for this sensor while locked. Lock Locks the selected mPower to the current location on the map and disables the Remove icon functionality for this mPower while locked. Remove Remove the sensor from the location on the map. Remove Remove the mPower from the location on the map.
mFi™ User Guide Chapter 3: Map Tab Map Display Options Show: Select to show values, labels, details and topology. The following are the options available: • Values Displays real-time values of Device data. Buttons display the current state of the device. 2. Click and hold to draw a line in the area that you want to use to set the scale of the map. If you need to redraw the line, just click and hold again to draw a new line. Once you’re happy with the line, click Next.
mFi™ User Guide Chapter 4: Data Tab Chapter 4: Data Tab Date Range The Data tab allows you to view device data. You can set a date range for data results, create customized views, and compare data. On the left side of the screen there are three selection panels: Date Range, Views, and Devices. On the right side of the screen, data is displayed based on the selections made in the selection panels.
mFi™ User Guide Chapter 4: Data Tab Views Data Panel Mouseover Functionality Custom views can be created, saved, and selected for viewing here. Use the mouse to hover over the data timeline and view specific details. Create View Click to create a new view. Drag and drop devices from the selection panel on the left side of the screen to the data panel on the right side of the screen to display data from multiple devices in one view.
mFi™ User Guide Device names can be clicked on in the data panel to open the Device Details window. Chapter 4: Data Tab Devices Displays a list of the available devices categorized by type. Click on a specific device to view the data for the device in the data panel. When creating custom views, devices are dragged from this selection panel to the data panel. For information on the Device Details window, go to “Device Details” on page 27.
mFi™ User Guide Chapter 5: Events Tab Chapter 5: Events Tab Date Range The Events tab displays event information that can be filtered by search strings, date ranges, or devices. It also displays distribution information in visual charts. Filter Filter Allows you to filter data using specific search criteria. Any text that is entered is used as real‑time search criteria and anything that doesn’t match the entered characters will be removed from the view.
mFi™ User Guide Devices Chapter 5: Events Tab Device Distribution Allows you to control which devices are included in the event data that is displayed. Select or deselect individual devices or entire device categories. Device Distribution displays a pie chart representation of events generated by specific devices during a specific timeframe. If specific timeframes are selected on the Temporal Distribution graph, the timeframe will also be applied to the Device Distribution graph.
mFi™ User Guide Chapter 6: Rules Tab Chapter 6: Rules Tab Rules The Rules tab is where you can define conditions that trigger actions and what actions occur once conditions are met. Rules Rule Editor Click on a rule to display the conditions and actions in the Rule Editor or click Add a Rule to define a new rule. Add a Rule Click to create a rule. Ubiquiti Networks, Inc.
mFi™ User Guide Creating Rules Rules trigger actions when a specified condition or conditions occur. For example, a rule might be created to turn on a light when a door is opened. The door opening is the condition and the action that is triggered is the light turning on. Note that if the light is manually turned off while the door is open, the rule will not trigger again until the door has been closed and re-opened.
mFi™ User Guide Chapter 6: Rules Tab 4. (Optional) To add additional conditions, click Add Condition. a. Choose a device from the drop-down list. 5. Select whether Any Condition or All Conditions must be met to trigger the action. c. Select whether you want the device On or Off. -- Any Condition Action is triggered if any of the defined conditions occur. -- All Conditions All conditions listed in the rule must occur before the action is triggered. 6. Click Add Action. b. Click Add. d.
mFi™ User Guide Chapter 6: Rules Tab Rule Management Rules that have been saved can be viewed by highlighting the rule in the Rules panel. You can modify the rule by making changes and saving the rule again. There are also links to Delete Rule and Make a copy of this rule. Existing rules can be enabled or disabled by clicking on the On/Off button to the right of the rule name. Ubiquiti Networks, Inc.
mFi™ User Guide Chapter 7: Devices Tab The Devices tab displays a list and details of the connected devices and mPorts. Devices Chapter 7: Devices Tab Model Displays the model information. Device (port) Displays the name or MAC address of the mPort the device is associated with and the port it is connected to is displayed in parenthesis. Value Displays the last reported value from the device. Reported At Displays the time of the last reported value.
mFi™ User Guide Chapter 7: Devices Tab mFi Management Search Allows you to search for specific characters. Any text that is entered is used as real‑time search criteria and anything that doesn’t contain the entered characters will be removed from the view. Delete the search string to return to a normal view. Name/MAC Address Displays the name or MAC address of the mPort. Click on the name or MAC address of the mPort to display the mPort Details window.
mFi™ User Guide Chapter 8: Device Details Chapter 8: Device Details Binary devices will display event frequency for the selected time period. Details Device Events Name Displays the name of the device To edit the name, click the pencil icon. Model Displays the device model information. mPort Displays a clickable link to the mPort the device is associated with. Port Displays the port number that the device is using on the mPort. Value Displays the last reported value.
mFi™ User Guide Chapter 8: Device Details Rule Displays the name of the rule that triggered the event. Click on the Rule Name header to toggle the alphabetical display order from a-z to z-a. Serial-Based Device Details Web Shell Opens up a command line interface shell. Device Name Displays the name of the device. To edit the name, click the pencil icon. Model Displays the device model information. mPort Displays a clickable link to the mPort the serial‑based device is associated with.
mFi™ User Guide Chapter 9: mPort Details Chapter 9: mPort Details Device Type Description Output 24v Switch an external 24V relay. Outputs 24V on the Output (O) pin, when the port is on, and 0v otherwise. This type of machine displays an on/ off button in the mFi Controller interface, and can be selected as an output when creating a rule from the Rules tab.
mFi™ User Guide Details Chapter 9: mPort Details Add a New Serial Device Please enter device name here Enter the device name in this field. UART Mode Select RS232 or RS485. Baud Rate Select the baud rate from the drop-down list. Parity Select odd or even parity or select none. Antenna Select internal or external antenna. Add New Device After making your selections, click this button to create the new device. Overview Details Name Displays the MAC address or name of the mPort.
mFi™ User Guide Chapter 10: mPower Details Configuration Outlet x When the outlet number heading is black the outlet hasn’t been associated with a machine and the text will state Select a machine. Once the outlet has been associated with a machine, the outlet number heading is green and the name of the machine will be displayed. Associating a Device with an Outlet To associate a device with an outlet, click the + icon to the right of the outlet.
mFi™ User Guide Chapter 10: mPower Details Outlet Device Data Displays a visual representation of data for the specific device during the selected time period. By default, D is selected showing data from the last 24 hours. • H Displays data for the last hour. • D Displays data from the last 24 hours. • W Displays data from the last week. • M Displays data from the last month. • Y Displays data from the last year. The chart can be display cost (default) or energy.
mFi™ User Guide Appendix A: Pinouts Appendix A: Pinouts The table below lists the pinouts for RS232, RS422, and RS485. mPort-S Serial DB9 Function Pins 2, 3, 5, 6, and 9 are used for serial DB9 communication and grounding. RXD- TXD- Ground RX TX R+ T- Ground Pinout R- T+ RS232 ✓ RS422 ✓ ✓ ✓ ✓ * RS485 ✓ ✓ ✓ ✓ * ✓ G ✓ Note: RX-/TX- and RX+/TX+ can be jumpered for 2-wire RS485 networks.
mFi™ User Guide Appendix B: Contact Information Appendix B: Contact Information Ubiquiti Networks Support Ubiquiti Support Engineers are located in the U.S. and Europe and are dedicated to helping customers resolve software, hardware compatibility, or field issues as quickly as possible. We strive to respond to support inquiries within a 24 hour period. Email: support@ubnt.com Phone: 408-942-1153 (9 a.m. - 5 p.m. PST) Online Resources Wiki Page: wiki.ubnt.com Support Forum: forum.ubnt.
