Difference between revisions of "User Manual/2. Setting up the system"

From Chordata documentation
Jump to: navigation, search
(ssh instructions)
(Hardware setup & testing the system sections)
Line 5: Line 5:
 
Congratulations! If you got here it’s because you have already gathered together [[User_Manual/1._Chordata_parts | all the parts needed to build your motion capture suit]]. Now is the moment of truth.
 
Congratulations! If you got here it’s because you have already gathered together [[User_Manual/1._Chordata_parts | all the parts needed to build your motion capture suit]]. Now is the moment of truth.
  
==Initializing and testing the system==
 
 
In this chapter we will put everything in place and see if it's working correctly. We should check the following functionalities:
 
In this chapter we will put everything in place and see if it's working correctly. We should check the following functionalities:
 
{{note | The crossed-out functionalities require some tweaking. They will be available soon..  
 
{{note | The crossed-out functionalities require some tweaking. They will be available soon..  
Line 14: Line 13:
 
*The [[Hub]] and [[K-Ceptor|K-Ceptors]] are wired correctly and the [[Notochord]] is able to talk to them.
 
*The [[Hub]] and [[K-Ceptor|K-Ceptors]] are wired correctly and the [[Notochord]] is able to talk to them.
  
 +
==Hardware setup==
 
===Powering the system===
 
===Powering the system===
 
[[File:Powerbank.jpg | thumb | 10400mAh Power bank and Raspberry Pi]]
 
[[File:Powerbank.jpg | thumb | 10400mAh Power bank and Raspberry Pi]]
Line 84: Line 84:
 
The SBC will connect to it on boot.
 
The SBC will connect to it on boot.
  
=== Test the connection ===
+
== Testing the system ==
{{note | The [[Utility software]] requires some tweaking. It will be available soon. (See [[Roadmap]])
+
In a near future, once the [[Utility software]] is up and running you will be able to access the system and test it in a much more easy way.
Once it's working it will allow you to connect to the SBC in an easier way. In the meantime you have to use [[SSH]]
+
 
| warning}}
+
In the meantime you have to access to the [[SBC]]'s terminal environment either by plugging a monitor and keyboard to it, or through [[SSH]].
  
====connect to SSH on Mac or Linux====
+
See the [[Roadmap]] to check the state of the development.
Connect to the SBC using [[SSH]]. If you are in a unix-like operating system (like linux or mac), then you just have to open a terminal emulator and issue:
 
<syntaxhighlight lang="bash">
 
ssh pi@notochord.local
 
</syntaxhighlight>
 
  
This relies on your computer being able to resolve the <code>notochord.local</code> name using the [https://en.wikipedia.org/wiki/Multicast_DNS mDNS protocol], which most linux or mac are able to do.
+
===Run the notochord to test the Hub===
If you get an answer like <code>Temporary failure in name resolution</code> it means that you should find out which the IP of the SBC is, and use that to connect through ssh. For example:
+
On the SBC terminal environment navigate to the folder where the <code>notochord</code> binary is, and run it. Add the [[User Manual/1. Chordata parts/1.4. Client software |client computer]] IP ADDRESS as a parameter in order to receive the data.
  
 
<syntaxhighlight lang="bash">
 
<syntaxhighlight lang="bash">
ssh pi@192.168.1.2
+
cd notochord/bin
 +
./notochord <CLIENT COMPUTER IP ADDRESS>
 
</syntaxhighlight>
 
</syntaxhighlight>
  
====connect to SSH on windows====
+
That will run the notochord using the default <code>Chordata.xml</code> configuration file, which by default reads only one K-Ceptor with a value of ''1'' from the ''J1'' gate on the Hub.
Windows generally doesn't come by default with an SSH client.
 
A good option is to use [https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html PuTTY].
 
  
Enter the IP address of the SBC on the configuration window, like the one below, and hit Open.  
+
{{note | The <code>Chordata.xml</code> file contains a description of the [[Hub]]s and [[K-Ceptor]]s connected the [[SBC]]. The notochord uses this description in a process called [[Armature parsing]] to create an internal representation of the devices to be readed, so it should match way the physical devices are connected. <br>You can learn more about how to describe this hierarchies [[Armature parsing| here]]. | hint}}
[[File:PuTTY 0.62 on Windows 8.png | 600px | left]]{{clearfix}}
 
  
====Run the notochord through SSH====
+
If you want to change the configuration file for the notochord use the <code>-c</code> flag. For example, to read a [[Default_Biped_Configuration]] you can issue:
Once you achieve the SSH connection, it will be just like using the terminal on your SBC.
+
 
You can now follow [[User_Manual/1._Chordata_parts/1.1._Microcomputer#Run_it|this instrucions]].
+
<syntaxhighlight lang="bash">
 +
./notochord -c ../default_byped.xml <YOUR COMPUTER'S IP ADDRESS>
 +
</syntaxhighlight>
  
  
 
{{Sibling nav | {{PREVSIBLING}} | {{NEXTSIBLING}} }}
 
{{Sibling nav | {{PREVSIBLING}} | {{NEXTSIBLING}} }}

Revision as of 14:30, 12 April 2019


Congratulations! If you got here it’s because you have already gathered together all the parts needed to build your motion capture suit. Now is the moment of truth.

In this chapter we will put everything in place and see if it's working correctly. We should check the following functionalities:

The crossed-out functionalities require some tweaking. They will be available soon.. See the Roadmap to get an idea of the state of the development
  • The SBC boots correctly.
  • The SBC acts as an access point, and we are able to connect to it from a separate PC.
  • The Utility software on the SBC is working correctly.
  • The Hub and K-Ceptors are wired correctly and the Notochord is able to talk to them.

Hardware setup

Powering the system

10400mAh Power bank and Raspberry Pi

To power the system a 5V, 2A supply is needed. It can be connected to the SCB only, or also to the Hub. Both connections use a micro USB-B connector. By far the easiest way to achieve it is to use a common power bank. It should be rated for at least 2A.To have a durable supply a capacity of at least 10000mAh is desirable. Under normal capture conditions such a power bank was able to keep the system running for around 8 hours.

The Chordata Hub has two possible configurations: with or without a separate power source. A jumper on the Hub (JP1) allows you to select between these configurations.

  • In the former the power comes from a buck converter on the Hub, that takes a 5V input and delivers 3.3V to the rest of the system.
  • In the latter the power comes from 3v3 rail on the SBC.


The Chordata system uses only a 3.3V tension. Don't apply 5V or higher voltages directly to any pin! Otherwise it can result on unrepairable damage.

A 5 volt tension can be applied only via the micro USB connectors on the Hub or SBC


Using the dedicated power source

This is the recommended configuration. The power line from the Powerbank should go to the micro USB connector on the Hub (J12), and from the big USB connector (J11) to the SBC.

To use this configuration the jumper should be positioned connecting the pins #1 and #2 of JP1


Using the 3v3 rail from the SBC

This configuration is mostly used for testing purpouses. The power line from the Powerbank should only go to the micro USB connector on the SBC.

To use this configuration the jumper should be positioned connecting the pins #2 and #3 of JP1

Wiring the Hub and raspberry

Start by wiring the hub and the raspberry using female jumper wires as described in the diagram. Then power the Raspberry. You should see a red led constantly on and a green led blinking, that means that the amount of power provided is enough to keep the Raspberry working, and also that the system is booting.

The blue led on the Hub should stay on as an indicator of a stable power supply.

Raspberry pi 3 and Chordata Hub wiring

the yellow 3v3 line is not used with the Dedicated power source configuration.

Connecting the K-Ceptors

Plug one of the ID Modules on top of one of the K-Ceptors, then plug it to one of the gates of the Hub.
Be sure to plug the cable on the IN --> connector of the K-Ceptor. Other K-Ceptors can be connected to the output of the previous one forming a chain, always going from OUT --> to IN -->.

On a working K-Ceptor the Blue led [D1] should turn on and stay that way.

K-Ceptor-wired.jpg

If you built the hardware yourself and want to know how to test and troubleshoot a K-Ceptor take a look at: Troubleshooting a K-Ceptor

Connecting to the WIFI LAN

The SBC acting as an access point feature requires some tweaking. It will be available soon. (See Roadmap)

In the meantime you can use an external access point as described in this section.


Use an external router or a smartphone hotspot to create a WIFI LAN with the following specs:

  • SSID: Chordata-net
  • Pass: chordata

The SBC will connect to it on boot.

Testing the system

In a near future, once the Utility software is up and running you will be able to access the system and test it in a much more easy way.

In the meantime you have to access to the SBC's terminal environment either by plugging a monitor and keyboard to it, or through SSH.

See the Roadmap to check the state of the development.

Run the notochord to test the Hub

On the SBC terminal environment navigate to the folder where the notochord binary is, and run it. Add the client computer IP ADDRESS as a parameter in order to receive the data.

cd notochord/bin
./notochord <CLIENT COMPUTER IP ADDRESS>

That will run the notochord using the default Chordata.xml configuration file, which by default reads only one K-Ceptor with a value of 1 from the J1 gate on the Hub.

The Chordata.xml file contains a description of the Hubs and K-Ceptors connected the SBC. The notochord uses this description in a process called Armature parsing to create an internal representation of the devices to be readed, so it should match way the physical devices are connected.
You can learn more about how to describe this hierarchies here.


If you want to change the configuration file for the notochord use the -c flag. For example, to read a Default_Biped_Configuration you can issue:

./notochord -c ../default_byped.xml <YOUR COMPUTER'S IP ADDRESS>