Unibrain API-810 User Manual Download

Page: 1 / 77

ubCore™ 3.1 User Guide

brain

The 1394 Innovators

e-mail:

[email protected]

web:

http://www.unibrain.com

store:

http://www.1394store.com/

Summary of Contents for API-810

Page 1: ...ubCore 3 1 User Guide unibrain The 1394 Innovators e mail support unibrain com web http www unibrain com store http www 1394store com 1 ...

Page 2: ...d to pass commands to the 1394 stack Benchmarking support is included FireNet Software to network two or more computers via 1394a or 1394b Fire i Software to Control and Display any 1394 Digital Camera IIDC Fire Share Software to allow sharing of any 1394a or 1394b SBP2 disk among multiple users Demo version Software Compatibility of ubCore Windows NT4 98SE Me 2000 XP Hardware Compatibility of ubC...

Page 3: ...ING WITH UBCORE 27 UNINSTALLING UBCORE 28 UPGRADING UBCORE 28 UBCORE AUTHORIZATION PROCEDURE 29 FIREAPI AUTHORIZATION PROCEDURE AND LICENSING POLICY 31 1394A AND 1394B SBP2 DISK DRIVER 32 INSTALLING SBP2 DISK DRIVER IN WINDOWS 98SE ME 33 1394 SBP2 EXTERNAL DISK CONNECTION 35 SAFE REMOVAL OF 1394 SBP2 DISKS 40 FIREVIEWER 1394 BUS VIEWER 41 THE NODE TREE 41 COLOR AND PATTERN CODING 43 ADAPTER SELECT...

Page 4: ... I 1394 IIDC CAMERAS SUITE 66 FIRE I COMPATIBILITY 66 FIRE I APPLICATION GUIDE 67 CONNECTED CAMERAS 67 VIDEO FORMAT 67 VIDEO MODE 67 FRAME RATE 67 SPEED 68 MEMORY PRESETS 68 CAMERA CONTROL 68 DISPLAY POPUP MENU 69 FIRE I SHORT KEYS 72 FIRESHARE 73 IMPORTANT WARNING 73 INTRODUCTION 73 USING FIRESHARE 74 DISK COLORING 75 FIRESHARE AUTHORIZATION 77 4 ...

Page 5: ...ons Please refrain from sending any queries directly to Unibrain engineering staff in order to maintain our support database and make sure that your email will be responded to in case any specific person is unavailable Please try to be as specific as possible in your inquiries to this email address and to restrict questions to technical issues For pricing and marketing information please e mail at...

Page 6: ...e maximum speed that a node can be accessed ubCore can do transactions at any speed and uses the maximum speed of a specific node that works This automatic mechanism enables the correct communication of every node in a 1394b bus even if not all devices operate at S100 or S200 speeds 3 Complete SBP2 support for 1394a and 1394b SBP2 hard disks SBP 2 Serial Bus Protocol 2nd version is the best model ...

Page 7: ...ed over ubCore is THE FIRST FireWire Networking Solution for ALL Windows platforms FireNet is a system independent software product that gives you full Ethernet compatibility at speeds of up to 800Mbps The basic features of FireNet are Complete Ethernet emulation Supports various network protocols TCP IP NetBEUI IPX SPX etc High speed up to 8 times the performance of 100Mbps fast Ethernet No hubs ...

Page 8: ...r 1394b compliant device based on the Texas Instruments TSB82AA2 1394b to PCI controller IIDC 1394 cameras Primitive support on Windows 98Se Me 2000 XP Fire i application and IIDC drivers for Windows NT4 98SE Me 2000 XP FireAPI includes FULL source code 1394 SBP2 Hard Disk support No sharing application FireShare application 1394 Native Networking Primitive support on Windows Me XP FireNet drivers...

Page 9: ...support Primitive support on Windows Me XP Windows NT4 98SE Me 2000 XP User mode API for applications development NO YES FireAPI Loopback functionality NO YES Source samples for FireAPI 2 44 Support NO YES Table 1 ubCore versus MS 1394 stack 9 ...

Page 10: ...apter or any built in 1394a or 1394b OHCI support or Unibrain s FireBoard400 PCI Lynx 2 1394a PCI adapter 4 You have disabled the Plug and Play Operating System flag on your BIOS setup in case that you are going to install ubCore into Windows NT 4 0 system Please also verify that your system has installed Service Pack 6 5 IMPORTANT Always UNPLUG the connecting FireWire cables between all the FireW...

Page 11: ...o but the most simple and straightforward is the usage of the FireViewer application Please refer to the section Verification of ubCore installation 5 After verifying the correct installation of ubCore it is time to fully authorize it Please recall from previous section that the ubCore software you already have installed is a complete and fully functioning version that its usage is restricted to a...

Page 12: ...stalls the required files accordingly The first step is to verify that the Microsoft 1394 stack is installed in your system Provided that you have the required 1394 hardware in your PC the Windows XP system will recognize it as an IEEE 1394 Bus host Controller and will install it automatically as can be seen from the Device Manager see next figure Locate the file ubCore3 exe and launch it by doubl...

Page 13: ...you agree with the terms stated in this License Agreement click on Yes Enter your Customer Information click Next and Choose the Destination Location of the ubCore files Choose the type of installation The default selection is Typical but in case you want to modify the configuration choose the option Custom 13 ...

Page 14: ...FireViewer A 1394 Bus Viewer utility that displays the current topology of the local 1394 bus FireCommander a 1394 command interpreter tool that is used to pass commands to the 1394 stack Benchmarking support is included FireNet 1394 Networking software FireShare Software to allow sharing of any 1394a or 1394b SPB2 disk among multiple users Demo Version Fire i Software to Control and Display any 1...

Page 15: ...et Install create a new Program Folder or add the Unibrain ubCore icons to any existing group In the latter case select the Group you want to add ubCore Press Next to proceed The installer will start copying the required files in the respective directories Once the next dialogue box appears press Continue Anyway 15 ...

Page 16: ...ying software is installed and if you monitor the device manager you can observe the presence of Unibrain s driver for the control of the IEEE 1394 Bus host controllers To verify that the ubCore suite of drivers are all installed successfully run the FireViewer utility from the Start Programs ubCore For more details please refer to the section Verification of ubCore installation 16 ...

Page 17: ...pective section There is also an alternative way to verify that the ubCore suite has been correctly installed at your Windows NT 4 system After reboot open the Control Panel Devices and go to the entry UB In case you have installed a FireBoard400 or a FireCompact400 four Unibrain Drivers should have started Automatically Unibrain 1394 PCILynx Driver UBLynx sys PCILynx 2 minport for FireBoard 400 o...

Page 18: ...HCI compliant 1394 board then you should have Unibrain 1394 OHCI Driver UBohci sys OHCI miniport for OHCI compliant 1394 PCI controllers Unibrain 1394 Class Driver UB1394 sys Kernel Mode ring 0 1394 API Unibrain 1394 FireAPI Driver UBUMAPI sys User Mode ring 3 1394 API Unibrain 1394 SBM Driver UBSBM sys Serial Bus Manager client driver 18 ...

Page 19: ...ease refer to the respective section There is also an alternative way to verify that the ubCore suite has been correctly installed at your Windows 98SE Me 2000 XP system At the Device Manager you should be able to see the driver installed under the IEEE 1394 Bus host controllers section For example in the next figure you can see the Unibrain driver FireBoard Blue and the Unibrain driver FireBoard8...

Page 20: ...ry structure of ubCore installation After the complete installation of ubCore 3 1 the directory structure should be as depicted in the next figure provided that you use the default destination directory E Program Files Unibrain 20 ...

Page 21: ...limited use ubCore drivers here are provided the ub1394 inf and ubsbp2 inf system information files ubCore drivers WinNT for NT4 2000 XP OSs or ubCore drivers Win98 for 98SE Me OSs here are provided the drivers operating for all the OSs UB1394 sys Unibrain 1394 Class Driver Kernel Mode 1394 API UBLynx sys Unibrain 1394 PCILynx Driver PCILynx 2 minport for FireBoard400 or FireCompact400 UBOHCI sys ...

Page 22: ...vided the FireNet 1394 Networking software driver and this is the path you should retrieve during the manual installation of FireNet Please refer to the FireNet Installation section for more details ubCore FireShare here is provided the FireShare demo Software to allow sharing of any 1394a or 1394b SPB2 disk among multiple users Moreover the authorization program is located in this folder Please r...

Page 23: ... following paragraphs present this procedure for a Windows XP system Lets assume that your system has two 1394 PCI devices one FireBoard800 Unibrain s 1394b 64 bit PCI adaptor and one FireBoard Blue Unibrain s 1394a 32 bit PCI adaptor and that you have successfully installed ubCore in your system So if you see the Device Manager you should observe a system configuration like the one bellow In orde...

Page 24: ...ubCore 3 1 User Guide Select the Install from a list of specific location Advanced radio button and click Next In the next dialogue select the Don t search I will choose the driver to install option 24 ...

Page 25: ...de Select the appropriate driver in our case is Texas Instruments OHCI Compliant IEEE 1394 Host Controller and click Next This is the completion stage of your hardware update so please click Finish in the next dialogue 25 ...

Page 26: ...Device Manager should appear like the below picture Please notice that for FireBoard800 we kept the same driver based on Unibrain s ubCore because it is the only existing driver providing full 1394b capabilities Please also recall that with a similar to the above procedure you can switch from Microsoft 1394 stack back to ubCore 26 ...

Page 27: ...rd party 1394a or 1394b OHCI PCI PCMCIA compliant adapter or any Desktop Portable PC with built in 1394a or 1394b OHCI support The two adjacent figures display how the ubCore 1394 stack recognizes and represents in the Device Manager two 1394b PCI controllers the FWB PCI01 board from IOI Technology Corporation and the GIC3800 from IOGEAR 27 ...

Page 28: ... Files ubCore Unistall ubCore The following Dialogue box will appear Select the Remove option and press Next Upgrading ubCore The correct procedure to upgrade your ubCore is to completely uninstall the old version REBOOT your system and then follow the steps of the installation procedure in order to install the new version 28 ...

Page 29: ...e ubCore Authorize utility application which can be found in Start Menu Program Files ubCore ubCore Authorize Enter your Name and the Product Key in the appropriate fields and press OK The application will display a message indicating if the operation was successful or not In order to enable unlimited usage of the ubCore stack and all the accompanying applications FireViewer FireCommander Fire i B...

Page 30: ...re you have to provide to the ubCore Authorize Utility a product key starting with the key word SHRE as in the next figure If you have installed in your system a Unibrain board with the ubCore 3 x Compliant label then you are authorized for unlimited usage of ubCore and you do not need to enter Authorization Product Key If you do so the next message will appear 30 ...

Page 31: ...C Fire Share Software to allow sharing of any 1394a or 1394b SBP2 disk among multiple users To enable an unrestricted use of the FireAPI it is required the FireAPI license per PC station This license has two alternative forms 1 either with the installation in your PC of one 1394 PCI board from Unibrain having the ubCore 3 x Compliant label 2 or with one FireAPI product key This product key is a un...

Page 32: ... ubCore installation in Windows 2000 and Windows XP IN CASE THAT YOU HAVE Windows 98SE or Windows Me YOU HAVE TO MANUALLY INSTALL THE SBP2 DISK AS DESCRIBED IN THE NEXT SECTION ENTITLED Installing SBP2 disk driver in Windows 98SE Me After the correct installation of ubCore you can observe the SBP2 driver from the Device Manager under the System devices enabling the option Show Hidden Devices Pleas...

Page 33: ...driver in Windows 98SE Me Please notice that for Windows 2K XP the installation is performed automatically once installed ubCore Start the Add Remove Hardware Wizard from Start Control Panel In the adjacent dialogue box select No I want to select the hardware from a list click Next Select from the Hardware types list the System devices and click Next 33 ...

Page 34: ... In the next dialogue click Have Disk and locate the directory in which ubCore and the SBP2 driver has been placed Once locating the driver the next dialogue will appear Click Next and the installation will be completed 34 ...

Page 35: ... to observe see adjacent picture the topology with FireBoard800 in node 2 and the two external hard disks in nodes 0 and 1 respectively notice that the default color for a 1394b node is blue A few seconds after the connection of the two external hard disks you can see from the Device Manager under the Disk drives section that both disks have been recognized by the operating system and are ready to...

Page 36: ...lid Windows file system format e g NTFS then you are able to explore and fully control the hard disks as valid volumes In our example depicted in the adjacent picture the two external hard disks have the volumes EXTA mapped in volume F and EXTB mapped in volume I 36 ...

Page 37: ...ill appear Click Next to continue The number of disks that will appear depends on how many you have connected to your system Check mark the disks to initialize and click Next In the next dialogue click Finish to complete the disk initialization part 2 In the next Computer Management windows that will appear you can see a list of the available disk drives In our case there is Disk 0 with 3 differen...

Page 38: ...ytes the number of the partition size and click Next By default Windows XP will select the total disk space available for your drive single partition If you choose to create multiple partitions change the Partition size in MB and click Next At the next Assign Drive Letter or Path dialogue window assign the drive letter and click Next By default Windows XP will select the next available drive lette...

Page 39: ... as the File System For Allocation unit size leave the default setting and give your drive a Volume label Once completed click Next At the last dialogue Completing the Create Partition Wizard click Finish and start working with your external hard disk Please repeat the above procedure for each of the external 1394 SBP2 drives you attach to your system for the first time 39 ...

Page 40: ...rent example you can see an USB Mass Storage Device and the two 2 external 1394b hard disks recognized by Unibrain s SBP2 driver In order to remove a hard disk click the device in the list and then click Stop The operating system will automatically unplug the device and inform you for this safe removal If you are using the specific hard disk e g you have open a Word document located in this disk t...

Page 41: ... a hierarchical tree in the main application window with the root node at the top and the children of each node appearing on the row below the row where the parent is drawn Inside each node the program displays the node s physical ID and the node s speed or an icon that represents the type of the node In the picture below a sample bus topology is illustrated The root node is node 10 equipped with ...

Page 42: ...ing the computer s UNC name The node is an IIDC 1394 digital camera The node is a Camcorder with 1394 interface The node is an external SBP2 1394 hard disk If a computer with FireNet contains two or more adapters connected on the same bus FireNet will only be running on one of them which will be drawn with the FireNet icon The rest will contain only a speed code Keep in mind that the NodeID assign...

Page 43: ... the desired color from the swatch on the left The Sample area changes color according to your selection 3 Left click on the desired text color from the swatch on the right The Sample area changes text color according to your selection 4 When satisfied with the result press the Apply button to save the change for the specific speed code The main window is redrawn immediately to reflect the changes...

Page 44: ...on The topology shown each time is the one for the current adapter For multi adapter systems you can select the current adapter as in the following picture Up to 10 adapters are supported but only the present ones are shown in the menu 44 ...

Page 45: ...or 2 ports only one or two ports are displayed unless the device reports differently as some one port cameras do The port that is connected to the parent node is drawn at the top edge of the node s rectangle There is no line leading to an unconnected port The FireViewer shows the first three ports of each node whether they are present or not Select again the View Show Port menu item to disable the...

Page 46: ...node The information varies according to the node type The next figure shows the contents of this dialog box which are common to all node types The first line displays the node s Globally Unique IDentifier GUID The rest information is retrieved from the node s bus_info_block Refer to the 1394 standard s documentation for a detailed explanation of these items For FireNet nodes the Properties dialog...

Page 47: ... condition and initiates a bus reset after a couple of seconds to correct the situation so usually it won t be necessary to do this yourself The communication between nodes is never halted due to a topology error so you should not worry if this situation occurs In the rare case when the problem persists then there is some problem with some node on the bus The only thing you might do in this case i...

Page 48: ...port drawing respectively Customize colors Opens the Color dialog box Hide title and menu Has the same effect as double clicking the left mouse button in the window when the window has a caption and menu bar or Show title and menu Has the same effect as double clicking the left mouse button in the window when the window does not have a caption and menu bar Foreground on BR Active only when the win...

Page 49: ... in utility bench that performs instant benchmarking and performance measurement of the connection between two 2 1394 PC nodes Please refer to this utility description for more details The help command from within the interpreter provides the list of available commands and a summary of command syntax Running the program Run the FireCommander from the Start Programs ubCore It runs as a console proc...

Page 50: ... alarm that will immediately notify the user that there is a problem on the network You can test this alarm to see what it sounds like by running the alarm command The output of FIRECOMMANDER is sometimes too big to fit in the traditional 80x25 command windows It is suggested that you open the properties page of the command window right click on the window s title bar and change the size of the wi...

Page 51: ...own CSR offsets is hardwired into the program Create a file called REGS1394 TXT if you need to specify additional names FIRECOMMANDER always looks for this file in the directory that was current when the program was started The program reads its input from standard input and writes its output to standard output This means that you can use FIRECOMMANDER to execute a batch file with FIRECOMMANDER co...

Page 52: ...nsecutive pending writes without acknowledge and has maximum value of 10 that gives the best performance The packet size of each transaction is variable and starts from 512 bytes per packet 1024 bytes per packet 2048 bytes per packet till 4096 bytes per packet for 1394b transactions Example bench 2 5000 50 10 Start sending data from my 1394 node to the node 2 in the current bus with 5000 requests ...

Page 53: ...ubCore 3 1 User Guide 53 ...

Page 54: ...1394 command interpreter window file infile outfile Reads and executes a series of commands from the file specified by infile If outfile is provided as well then the output of all commands that will be executed will be redirected to that file Otherwise the output will be displayed on screen file commands cannot be nested a script file with 1394 commands cannot contain another file command A line i...

Page 55: ... with ID busID If the read is successful then the returned data are displayed in hex and ASCII format Otherwise the error response code or acknowledge code is displayed write w busID phyID offset bytes data Sends a write transaction request of size bytes starting from offset offset with contents data to the node with physical ID phyID on the bus with ID busID The command displays the binary data t...

Page 56: ...vour the asynchronous transmit FIFO rather than the receive FIFO and add the setup size of the isochronous transmit FIFO to the asynchronous transmit FIFO This yields the current values which in the above example are 2KB for receive and 2KB for asynchronous transmit When the FIFO command is run with parameters it updates the setup values For example if someone wanted to perform extensive isochrono...

Page 57: ...uld be COMPARE_SWAP FAILED old_value arg_value Old Value 0X7FFFFFFF dump busID phyID BaseOffset TotalBytes PacketSize filename Sends a series of read requests to the specified node and writes the returned data in the specified filename Each request reads PacketSize bytes The Nth request N 0 TotalBytes PacketSize 1 PacketSize is sent at offset BaseOffset N PacketSize resp resp_code Prints the ident...

Page 58: ...nt are not being displayed status status_code Prints the identifier for the status code provided as parameter With as parameter it prints out a list of all status codes status without a parameter is identical to status tcode transaction_code Prints the identifier for the transaction code provided as parameter With as parameter it prints out a list of all transaction codes tcode without a parameter...

Page 59: ...Please also refer to the paragraph entitled Directory structure of ubCore installation So you have to manually install the FireNet software according to the following instructions Important Always UNPLUG the connecting IEEE 1394 cables between all network computers before you begin installing or uninstalling FireNet software Installation on Windows NT4 The FireNet software can be installed as any ...

Page 60: ...IP address etc Then Windows NT requires restarting your PC in order to load the new adapter Select to restart your PC either at this point or later Your new network adapter will be available after your PC restarts Unibrain s FireNet adapter can be treated as any other network adapter since it emulates a typical Ethernet adapter To enable the configuration dialog of the FireNet driver please select...

Page 61: ...P 1394 is build according to the specs set from the IETF Engineering Taskforce Because this standard is not yet finalised this option is not available yet Maximum Payload This is for advanced users In case you experience problems with some boards change the automatic setting to 1024 The Default value is automatic Verify Installation In order to verify that you successfully performed the complete F...

Page 62: ...Guide Installation on Windows 98SE Me 2000 XP Start the Add Remove Hardware Wizard from Start Control Panel and select the Add Troubleshoot option Select the Add new device option and select manually the new device 62 ...

Page 63: ...Core 3 1 User Guide In the type list of devices select the Network adapters and click Next In the next dialogue click Have Disk in order to locate the path for Unibrain s FireNet Once located click OK 63 ...

Page 64: ...the current host PC is equipped with one FireBoard800 which is uses after the FireNet installation as an 1394 network adapter If you right click over Unibrain 1394 FireNet Adapter you can observe and control the properties of this adaptor 64 After the correct installation of FireNet you have to configure your new Local Area Connection by providing the correct parameters for the bundled routing pro...

Page 65: ...l bundled with Unibrain 1394 FireNet Adapter Un installing FireNet In order to remove the FireNet go to the Control Panel click the Network applet and select the Adapters tab Then in the list with the Network Adapters select the Unibrain FireNet adapter and Uninstall the driver 65 ...

Page 66: ...all PCs connected with the camera s Controls any camera anywhere on the 1394 Bus Supports loading and saving Camera Memory presets Fire i Compatibility The following table illustrates the set of 1394 cameras tested with the Fire i application A SONY models A A Model No Description 1 CCM DS250 200 Mbps Colour including lens 2 DFW V300 200 Mbps Colour no lens 3 DFW V500 400 Mbps Colour no lens 4 DFW...

Page 67: ...ill let the user specify the dimensions position as well as other feature of the image In the above dialog you can see that you have to ability to specify arbitrary horizontal and vertical sizes for your image as well as image position and the size of the packets that will comprise an camera frame Decreasing the size of the packets increases the number of packets that need to be transmitted in ord...

Page 68: ...cus Adjustment of the lens to the subject distance The distance interval where the picture is still in focus before and after the subject is called depth of field Depth of field is increased by closing the lens iris Zoom Optical magnification control of the lens Brightness Constant amount of luminance electronically added to each pixel Increasing brightness makes dark and bright parts of the pictu...

Page 69: ...eration and works combined with gain control Increasing exposure by iris reduces the depth of field of the picture There is no influence on colour In this Camera Control group you have the possibility to further control the camera if it has trigger possibilities Display Popup Menu By right clicking on the display window while a camera is displaying the user can bring up a popup menu with the optio...

Page 70: ...options of the application By pressing the add button you can add shortcuts to the list of Assigned shortcuts which trigger the save operation At the above configuration hitting the space bar will save a camera frame in the directory specified by the user In the general options the user has three controls Force stop current camera This button stops the currently selected camera in the main dialog ...

Page 71: ...only have the ability to display the camera output on his screen In order to refresh the camera control buttons in case the specified camera is stopped the user should reselect the camera from the Camera Selection Combo box The above picture shows an instance of the Fire i controller application which found that a camera was already started The user can only view the camera at this point by clicki...

Page 72: ...1 User Guide Fire i Short Keys Fire i gives you the following functions using your keyboard ALT F4 Close your camera display windows Possible shortcuts for save operation Ctrl S Space Enter Left mouse button 72 ...

Page 73: ...disk located in your bus e g one other PC of your 1394 network can access the SBP2 disk that is physically attached to your PC So NEVER unplug or turn off an external 1394 SBP2 disk before ensuring that this disk is not used by any PC in the 1394 bus Introduction As is already mentioned the new ubCore 3 provides and installs automatically complete 1394 SBP2 Hard Disk driver suite support Unibrain ...

Page 74: ...ireViewer should appear like the adjacent image In this stage without connecting any external 1394 SBP2 HDD if you run FireShare you will get the following dialogue box Lets say that you connect a 1394b SBP2 external disk and you power it on The FireViewer will represent in the bus topology the presence of this disk Please notice that due to the SBP2 protocol nature ONLY one PC will mount the exte...

Page 75: ...tracted also from the disk s hardware Disk coloring Each disk in the bus will be listed in the FireWire disks list with the following coloring depending on the availability of the disk GREEN the disk is mounted and allocated to the current PC so this is the ONLY PC having full access capabilities YELLOW the disk has been released from its previous owner and it is now available for ANY PC in the bu...

Page 76: ...o mount again the disk double click on the disk provided that it is still YELLOW colored available and you will get the ownership of the disk Please observe that while the disk is RED colored that is allocated from another PC you cannot mount the disk The owner should first release the disk so it becomes YELLOW and then you can get ownership In case of many external hard disks connected to the bus...

Page 77: ...it for data backup You can type your message to the message box and after pressing the Send Message button this message will be broadcasted to all the PCs in the 1394 bus FireShare Authorization The FireShare application is provided in ubCore in DEMO mode with full functional capabilities for 30 minutes In order to have unlimited usage of the ubCore stack and all the accompanying applications Fire...

Search results

Summary of Contents for API-810

Reviews:

Related manuals for API-810

Brands by name

Popular brands

Unibrain API-810, User Manual

Search results

Summary of Contents for API-810

Reviews:

Related manuals for API-810

Brands by name

Popular brands