OS - Phidget SBC: Difference between revisions

Revision as of 20:19, 11 June 2018

Quick Downloads

Already know what you're doing? Here you go:

For PhidgetSBC (1070):

For PhidgetSBC2 (1072):

For PhidgetSBC3 (1073) kernel version 3.6.3:

For PhidgetSBC3 (1073) kernel version 3.14.27:

For PhidgetSBC4 (SBC3003):

Getting Started With the Phidget SBC

Welcome to using the Phidget SBC. If you haven't already, check out the user guide in order to set up the following:

Networking
Administrator password

If you are ready to go, the first step will be deciding how you will use the SBC:

Use the SBC like any other Linux computer, simply connect a monitor and a keyboard and begin your development.
Use a more powerful external computer to develop your code, and then simply copy the files to the SBC.

If you are using an external computer, there are videos available to help you get started, here is a video for Java:

We also have videos for Python and C.

If you will not be using an external computer, jump ahead to learn about installing packages for development, otherwise, keep reading!

Developing with an External Computer

There are two main ways in which you can access your SBC from an external computer:

SBC Web Interface
Secure Shell (SSH)

The user guide covers the SBC Web Interface in detail, so we will review SSH below.

SSH

If you are unfamiliar with SSH, it is a simple yet powerful tool that allows you to log into a remote machine in order to execute commands. You can also transfer files using the associated SCP tool.

In order to use SSH, you need to know the following things about the SBC:

IP address (e.g. 192.168.3.195) or the link local address (e.g. phidgetsbc.local)
The administrator password

You must also enable SSH on the SBC. You can do this via the SBC Web Interface which is shown in the image below:

SSH on Windows

To use SSH on Windows, we recommend PuTTY. Use the images below as a guide for configuring PuTTY (use the IP address or the link local address interchangeably):

After clicking open, simply login as root and provide the administrator password:

To transfer files between your SBC and Windows machine, we recommend either of these programs:

You will follow a similar process to access the SBC as described for SSH.

SSH on Linux and macOS

SSH is available on Linux and macOS by default. To run SSH, simply open the terminal and type the following:

ssh root@phidgetsbc.local

Or, something like this (you will need to know the IP address of your SBC):

ssh root@192.168.3.195

You will then be prompted for the password in order to gain access to the SBC:

To copy a file from the SBC to your development machine using SCP, simply open the terminal and type the following:

scp root@phidgetsbc.local:/path/to/source /path/to/destination

You can reverse this if you want to transfer a file from your development machine to your SBC:

scp  /path/to/source root@phidgetsbc.local:/path/to/destination

Installing Packages for Development

At this point you have connected to the SBC through one or more these three options:

SBC Web Interface
SSH
Directly via monitor and keyboard

Now that you are connected, you may want to start developing on/for the SBC. Before you do this, you need to install some packages. Let's start with C and Java.

C and Java

The simplest way to install C and Java support on the SBC is via the install buttons on located on the SBC Web Interface (System->Packages). Check Include full Debian Package Repository before installing.

When developing for Java, ensure your development machine and your SBC have the same version of Java. Check your Java version by entering this command:

Java -version

If you need to update the version of Java on your SBC, use the following commands:

apt-get install openjdk-7-jre-headless
su
update-alternatives --config java

You're now ready to begin programming! Continue through this guide for code examples and directions on where to go next.

Installing Python

Installing support for Python has three steps:

Ensure Include full Debian Package Repository is checked on the SBC Web Interface (System->Packages)
Install Python
Install Phidget Python module

You will need to run commands on the SBC to install support for Python. You can either use SSH to issue the commands, or you can connect directly to the SBC via a monitor and keyboard.

Basic Python

The base Python functionality can be downloaded and installed in one step:

apt-get install python

Next, install the Phidget Python module.

Method 1: Use the Internet

First, install wget and unzip:

apt-get install wget
apt-get install unzip

Next, copy the web link address for the Python Libraries and use it in the following command (right click to copy into a terminal):

wget http://copied_link

The Phidget Python libraries should now be downloaded in the folder you ran the previous command in. The next step is to unzip the file:

unzip filename

Finally, change directories to the unzipped folder:

cd /path/to/unzipped/folder

and install the Phidget Python libraries:

python setup.py install

You're now ready to begin programming! Continue through this guide for code examples and directions on where to go next.

Method 2: Use a USB Key

Copy the Python Libraries onto a USB key. Unpack the zip file into a folder on the USB key. Insert the key into the SBC.

You will have to figure out where the USB key (and the Phidget Python library folder) is now located. We describe how in the general Using USB Data Keys section. Next, run the following commands (be sure to modify the usb directory number if necessary):

cd /media/usb0/
python setup.py install

You're now ready to begin programming! Continue through this guide for code examples and directions on where to go next.

Developing Applications

If you are interested in developing on an external computer, keep reading. If you are planning on developing directly on the SBC, you can jump ahead to developing directly on the SBC.

Developing with an External Computer

When developing on an external computer, you will write, compile, and test your programs on that machine. When you are ready, you will then upload your programs to the SBC to run them. To demonstrate, we will use the Hello World example for Java. Download the following on your development machine before we get started:

Next, follow these steps:

1. Place phidget22.jar on your development machine in a directory that you will use to compile your Java files.

2. Copy the HelloWorld.java file from the example package to the same directory.

3. Compile the HelloWorld.java file. If you are using a Windows machine, type the following into the command prompt:

javac -classpath .;phidget22.jar HelloWorldExample.java

If you are using a Linux or macOS machine, type the following into the terminal:

javac -classpath .:phidget22.jar HelloWorldExample.java

You should now have the following class file:

HelloWorldExample.class

4. Using the SBC Web Interface, create a new project called HelloWorld:

5. On the next screen, you will be prompted to upload your files. We will upload the Java class file, and then click the Start button:

6. You'll note that as it runs, there are two links below the Stop button:

stdout: view the program output like you would in a terminal or command prompt
stderr: view the program error output

Success! The HelloWorld example is running on your SBC. If you aren't interested in developing directly on the Phidget SBC, jump ahead to running a program automatically.

Developing Directly on the Phidget SBC

When developing directly on the SBC, you will do so in one of the following ways:

Access the terminal by connecting directly to the SBC using a keyboard and monitor.
Access the terminal by using SSH.

Regardless of how you choose to access the terminal, the process is the same. First, you will need to pick a terminal editor in order to write and edit your files. Here are some options we recommend:

nano - recommended for beginners, already installed
vi - advanced, already installed
emacs - advanced, needs to be installed

Next, follow these steps:

1. If you haven't already, connect to the SBC using SSH or a keyboard and monitor.

2. Download the Phidget Java HelloWorld Example to the SBC.

wget http://examples_link

3. Unpack the examples

unzip examples_filename

4. Compile the HelloWorldExample.java example:

javac -classpath .:/usr/share/java/phidget22.jar HelloWorldExample.java

5.Run the HelloWorldExampleprogram:

java -classpath .:/usr/share/java/phidget22.jar HelloWorldExample

Success! The HelloWorld example is running on your SBC. Now that you have a program running on your SBC, you may be interested in having it run automatically when the SBC boots, or maybe even on a schedule. Keep reading for more information.

Running a Program Automatically

After testing your program, you will likely want it to run on boot, or on a schedule, without your input.

Run on Boot

Running on boot ensures that your program will never miss an event. As long as the SBC is running, your code will be running. This section assumes you have written and compiled your program on an external computer, and have uploaded it to the SBC Web Interface. If you are not using the SBC Web Interface, jump ahead to using a boot script.

To have your program run on boot, navigate to Projects->ProjectName->Startup Settings in the SBC Web Interface. After selecting your project, copy the settings from the image below:

We will review some of the options that are shown in the image above:

Startup Order: lower numbers boot first. Booting later means more programs are available for use, booting earlier means other programs can use your program.
Run as a daemon: starts the program as a daemon. Unless you have explicitly written your program as a daemon, leave this checked, or else your SBC may hang on boot.
Executable/Class name: your main Java class or C file.
Arguments: any command line arguments the program needs.

After saving your changes, your program will run automatically whenever your SBC boots.

Automatically Running Python Code

To run a Python script as a standalone application, you will need to add a line called a "shebang" to the top of the script, with the path to your Python executable. If you have followed the steps in this guide, the line will be:

#!/usr/bin/python

Run on a Schedule

Running your program on a schedule allows you to perform your task once a week, or once a minute without worrying about memory management issues or instability problems that may arise. It executes, and then gets cleaned up. To run your program on a schedule, we recommend using Cron. Cron can automatically schedule programs (known as jobs, or cron jobs). Cron simply reads a crontab file and runs whatever programs are listed, with whatever timing they are listed with. Cron runs continuously in the background, but the cron jobs only run as long as they naturally would, and then they exit.

Let`s set up your first cron job. We will use nano to edit the crontab file, but feel free to use whatever editor you prefer.

First, set your editor to nano:

export EDITOR=nano

Next, edit your crontab file:

crontab -e

Finally, schedule your cron job:

#cron job that will run at 5AM every week:
0 5 * * 1 /root/code/myprogram argument1

After entering your task, simply save and exit the file.

Run Using a Boot Script

If you want your program to run on boot, you can install your program into the boot order using a script. This process is covered here.

Programming

Ready to write some code? Select one of the programming languages below:

Phidget Network Server

The Phidget Network Server is an extremely useful feature of Phidgets that allows you to remotely control Phidgets over your network. If you haven't already, check out the Phidget Network Server page for a complete overview.

Try it Out!

The Phidget SBC comes with the Phidget Network Server installed, and the SBC automatically starts the Network Server on boot. In order to change any of this default behaviour, navigate to Phidgets->phidget22NetworkServer using the SBC Web Interface:

In order to try the Phidget Network Server out, you will need a host computer, and a client computer:

Host computer: the computer that is physically connected to the Phidgets via USB and is running the Phidget Network Server.
Client computer: a computer running a Phidgets application that accesses Phidgets connected to the host computer.

For this example, we will use the Phidget SBC as the host computer. The next step is setting up your client computer. If you are using a Windows computer as your client, keep reading, otherwise, you can jump ahead here:

macOS Client
Linux Client

Windows Client

In order to remotely access Phidgets on your SBC, you should get your client computer set up. Follow the Getting Started guide for Windows below before continuing:

Getting started with Windows

Now that you have Phidget drivers and libraries installed on your client computer, we can test the Phidget Network Server by following the steps below:

1. Open the Phidget Control Panel on your client computer. You will see something like this:

2. You now have access to the Phidgets that are connected to your Phidget SBC. Try double-clicking one of them to bring up an example.

macOS Client

In order to remotely access Phidgets on your SBC, you should get your client computer set up. Follow the Getting Started guide for macOS below before continuing:

Getting started with macOS

Now that you have Phidget drivers and libraries installed on your client computer, we can test the Phidget Network Server by following the steps below:

1. Open the Phidget Control Panel on your client computer. You will see something like this:

2. You now have access to the Phidgets that are connected to your Phidget SBC. Try double-clicking one of them to bring up an example.

Linux Client

In order to remotely access Phidgets on your SBC, you should get your client computer set up. Follow the Getting Started guide for Linux below before continuing:

Getting started with Linux

Now that you have Phidget drivers and libraries installed on your client computer, we can test the Phidget Network Server by following the steps below:

1. From the terminal, type in the following command:

 phidget22admin -s

You will now see something like this:

As shown in the image above, the server running on your SBC can now be seen over the network. You will now be able to remotely access any Phidgets connected to your SBC.

What's Next?

Now that you have seen the Network Server in action, you may be interested in implementing an application that takes advantage of all it's features. Luckily, every programming language we support comes with example code on how to do this! Jump to programming languages above.

Advanced Information

Writing Image to SD Card

If you would like to reflash your micro SD card, your first step will be to download the SBC4 SD Card Image. After downloading, unzip to get the .img file.

The next step is to flash your card. We recommend Etcher for flashing - this supports Windows, macOS, and Linux. It's also possible to flash from the command line on macOS and Linux, but this is not recommended as it does not verify the image (See Command Line).

Download and run Etcher. Plug in the MicroSD card using a card reader. Etcher will probably pick up the card automatically - otherwise, chose the card. Select the .img file using the select image button. :

Next, press the Flash! button. After writing and verifying, you will see:

The next step is to plug the SD card back into the SBC and expand the file system. Jump ahead to expanding your file system.

Command Line

NOTE: Flashing from command line is not recommended. Please consider using Etcher on Windows, macOS or Linux.

macOS

You should have already completed the first step, which is downloading the SD card image:

Next, make sure your SD card is plugged in, and enter the following into your terminal:

diskutil list

This will list all of the devices currently mounted on your system:

After verifying which device is your SD card, unmount it using the following command:

diskutil unmountDisk /dev/diskX

Warning: Ensure you are writing to the correct disk

Next, we can write the image file to the SD card:

if= path to your image file
of = where to write output (note using rdisk instead of disk will result in faster write times)

After writing, you are almost done. The next step is to plug the SD card back into the SBC and expand the file system. Jump ahead to expanding your file system.

Linux

You should have already completed the first step, which is downloading the SD card image:

Next, make sure your SD card is plugged in, and enter the following into your terminal:

dh -f

This will list all of the devices currently mounted on your system:

After verifying which device is your SD card, unmount it using the following command:

umount /dev/sdXX

Next, we can write the image file to the SD card:

if= path to your image file
of = where to write output (note: do not include partition number)

Warning: Ensure you are writing to the correct disk

After writing, you are almost done. The next step is to plug the SD card back into the SBC and expand the file system.

Expanding your File System

Note: PhidgetSBC4 SD card image version 3.0.0+ automatically expands the filesystem on first boot. For older SD card images, continue reading.

After writing the image file to your SD card, you will need to expand the file system size in order to take advantage of the full capacity of your card. In order to do this, you must run the expandfs.sh script which can be accessed at the / directory as shown here:

Note: if you plan on using SSH in order to run this script, you will need to enable SSH first (as it is turned off by default). Enabling SSH was covered above in the SSH section.

Next, simply run the script:

The SBC will automatically reboot, and your file system will be expanded. You can confirm that it has expanded by checking the file system size report.

Checking System Logs

The SBC maintains two logs: a kernel log and a system log.

The kernel log is for low-level occurrences, such as devices attaching and leaving the USB hub, recording what drivers are being used, and so on.

The system log (syslog) is for normal chatter from the operating system. Any program with the right permissions can use it (though you need to know the method to write to it, information all around the Internet can help) and it contains everything from the Ethernet going up and down, to webserver requests, and so on. If you don't run many programs or services on the SBC, the syslog will essentially be a mirror of the kernel log, because the kernel is the only thing talking.

You can check these logs by using the web interface in the System → Logs tab.

Or you can perform more powerful filtering and displaying via an SSH terminal. For example, dmesg is the command to display the kernel log, and tail prints the last ten lines of input. So, if you are trying to see if you can get a device to be detected on USB, you can run dmesg | tail to print the latest ten lines of kernel log data.

The actual locations of the log files (for filtering and reading) are:

/var/log/syslog
/var/log/dmesg

But don't edit them directly! Always follow the advice and procedures around the Internet on how to properly log items to syslog.

@@ Line 1: / Line 1: @@
+<metadesc>Communicate with sensors, controllers and relays with the PhidgetSBC! It uses Debian Linux and can run autonomous programs in C, Java, and Python.</metadesc>
 [[Category:OS]]
 __TOC__
@@ Line 4: / Line 5: @@
 ==Quick Downloads==
 Already know what you're doing? Here you go:
-*[{{SERVER}}/downloads/phidgetsbc/SBC3003/linux-4.8.3/phidgetsbc4.bin PhidgetSBC4 Firmware]
-*[{{SERVER}}/downloads/phidgetsbc/SBC3003/linux-4.8.3/phidgetsbc4-kerneldev.tar.gz PhidgetSBC4 Kernel Development Package]
-*[{{SERVER}}/downloads/phidgetsbc/SBC3003/changelog changelog]
-Note: updates should normally be done via the System -> Packages page on your PhidgetSBC4 web interface. It is rarely necessary to completely re-flash your device.
+'''For PhidgetSBC (1070):'''
+*[{{SERVER}}/downloads/phidgetsbc/1070/changelog.txt changelog]
+*[{{SERVER}}/downloads/phidgetsbc/1070/phidgetsbc-minimal.bin Minimal Firmware]
+*[{{SERVER}}/downloads/phidgetsbc/1070/phidgetsbc-full.bin Full Firmware]
+*[{{SERVER}}/downloads/phidgetsbc/1070/buildroot-phidgetsbc.tar.gz Buildroot/Kernel Sources]
+'''For PhidgetSBC2 (1072):'''
+*[{{SERVER}}/downloads/phidgetsbc/1072/changelog.txt changelog]
+*[{{SERVER}}/downloads/phidgetsbc/1072/phidgetsbc2.bin SBC2 Firmware]
+*[{{SERVER}}/downloads/phidgetsbc/1072/phidgetsbc2-kerneldev.tar.gz SBC2 Kernel Development Package]
+'''For PhidgetSBC3 (1073) kernel version 3.6.3:'''
+*[{{SERVER}}/downloads/phidgetsbc/1073/changelog.txt changelog]
+*[{{SERVER}}/downloads/phidgetsbc/1073/linux-3.6.3/phidgetsbc3.bin SBC3 Firmware]
+*[{{SERVER}}/downloads/phidgetsbc/1073/linux-3.6.3/phidgetsbc3-kerneldev.tar.gz SBC3 Kernel Development Package]
+*[{{SERVER}}/downloads/phidgetsbc/1073/linux-3.6.3/phidgetsbc3-upgrade_3.6.3_3.14.27.tar.gz SBC3 Kernel upgrade package (3.6.3 -> 3.14.27)]
+'''For PhidgetSBC3 (1073) kernel version 3.14.27:'''
+*[{{SERVER}}/downloads/phidgetsbc/1073/changelog.txt changelog]
+*[{{SERVER}}/downloads/phidgetsbc/1073/linux-3.14.27/phidgetsbc3.bin SBC3 Firmware]
+*[{{SERVER}}/downloads/phidgetsbc/1073/linux-3.14.27/phidgetsbc3-update_3.14.27.tar.gz SBC3 Kernel update package (3.14.27)]
+*[{{SERVER}}/downloads/phidgetsbc/1073/linux-3.14.27/phidgetsbc3-kerneldev.tar.gz SBC3 Kernel Development Package]
+'''For PhidgetSBC4 (SBC3003):'''
+*[{{SERVER}}/downloads/phidgetsbc/SBC3003/changelog.txt changelog]
+*[{{SERVER}}/downloads/phidgetsbc/SBC3003/phidgetsbc4.zip SBC4 SD Card Image] | [{{SERVER}}/downloads/phidgetsbc/SBC3003/phidgetsbc4.md5 md5]
+*[{{SERVER}}/downloads/phidgetsbc/SBC3003/SBC3003_upgrade.tar.gz SBC4 Kernel/Bootloader Upgrade Package]
-==Getting Started with the Phidget SBC==
+==Getting Started With the Phidget SBC==
 Welcome to using the Phidget SBC. If you haven't already, check out the [[SBC3003 User Guide#Getting Started | user guide]] in order to set up the following:
 * Networking
@@ Line 21: / Line 41: @@
-'''Warning''': Regardless of how you decide to use the SBC, you will be running on the SBC as root (super-user). This means you are able to overwrite important system files without the system asking for additional permissions.
+If you are using an external computer, there are videos available to help you get started, here is a video for Java:
+<center>{{#ev:youtube|InbY-Ui1tg0}}</center>
+We also have videos for [https://www.youtube.com/watch?v=y7XhShmhiEU&list=PLwPK-C9lEEc0iciKTiWSWZ74tQysd2lsS&index=4 Python] and [https://www.youtube.com/watch?v=8vv8kx4743c&list=PLwPK-C9lEEc0iciKTiWSWZ74tQysd2lsS&index=2 C].
-If you will not be using an external computer, jump ahead to learn about [[#Installing packages for development|installing packages for development]], otherwise, keep reading!
-===Developing with an external computer===
+If you will not be using an external computer, jump ahead to learn about [[#Installing packages for development|installing packages for development]], otherwise, keep reading!
+===Developing with an External Computer===
 There are two main ways in which you can access your SBC from an external computer:
 *SBC Web Interface
@@ Line 37: / Line 60: @@
 In order to use SSH, you need to know the following things about the SBC:
-*IP address (e.g. 192.168.1.123) or the link local address (e.g. phidgetsbc.local)
+*IP address (e.g. 192.168.3.195) or the link local address (e.g. phidgetsbc.local)
 *The administrator password
@@ Line 66: / Line 89: @@
 Or, something like this (you will need to know the IP address of your SBC):
 <syntaxhighlight lang=bash>
-ssh root@168.254.3.0
+ssh root@192.168.3.195
 </syntaxhighlight>
@@ Line 82: / Line 105: @@
 </syntaxhighlight>
-===Installing packages for development===
+===Installing Packages for Development===
 At this point you have connected to the SBC through one or more these three options:
 *SBC Web Interface
@@ Line 88: / Line 111: @@
 *Directly via monitor and keyboard
-Now that you are connected, you may want to start developing on/for the SBC. Before you do this, you need to install some packages. Let's start with C/C++ and Java.
+Now that you are connected, you may want to start developing on/for the SBC. Before you do this, you need to install some packages. Let's start with C and Java.
-====C/C++ and Java====
+====C and Java====
-The simplest way to install C/C++ and Java support on the SBC is via the install buttons on located on the SBC Web Interface (System->Packages). Check ''Include full Debian Package Repository'' before installing.
+The simplest way to install C and Java support on the SBC is via the install buttons on located on the SBC Web Interface (System->Packages). Check ''Include full Debian Package Repository'' before installing.
@@ Line 112: / Line 135: @@
 ====Installing Python====
 Installing support for Python has three steps:
-*Ensure ''Include full Debian Package Repository'' is checked on the SBC Web Interface (System->Packages)
+#Ensure ''Include full Debian Package Repository'' is checked on the SBC Web Interface (System->Packages)
-*Install Python
+#Install Python
-*Install Phidget Python module
+#Install Phidget Python module
 You will need to run commands on the SBC to install support for Python. You can either use SSH to issue the commands, or you can connect directly to the SBC via a monitor and keyboard.
@@ Line 133: / Line 156: @@
 </syntaxhighlight>
-Next, copy the web link address for the [{{SERVER}}/downloads/libraries/PhidgetsPython.zip Python Libraries] and use it in the following command (right click to copy into a terminal):
+Next, copy the web link address for the [{{SERVER}}/downloads/phidget22/libraries/any/Phidget22Python.zip Python Libraries] and use it in the following command (right click to copy into a terminal):
 <syntaxhighlight lang=bash>
 wget http://copied_link
@@ Line 156: / Line 179: @@
 =====Method 2: Use a USB Key=====
-Copy the [{{SERVER}}/downloads/libraries/PhidgetsPython.zip Python Libraries] onto a USB key.  Unpack the zip file into a folder on the USB key.  Insert the key into the SBC.
+Copy the [{{SERVER}}/downloads/phidget22/libraries/any/Phidget22Python.zip Python Libraries] onto a USB key.  Unpack the zip file into a folder on the USB key.  Insert the key into the SBC.
 You will have to figure out where the USB key (and the Phidget Python library folder) is now located.  We describe how in the general [[#Using USB Data Keys | Using USB Data Keys]] section. Next, run the following commands (be sure to modify the usb directory number if necessary):
@@ Line 166: / Line 189: @@
 You're now ready to begin programming! Continue through this guide for code examples and directions on where to go next.
-==Programming with the Phidget SBC==
+==Developing Applications==
-===Writing a Phidget Program===
+If you are interested in developing on an external computer, keep reading. If you are planning on developing directly on the SBC, you can jump ahead to [[#Developing directly on the Phidget SBC | developing directly on the SBC]].
+===Developing with an External Computer===
+When developing on an external computer, you will write, compile, and test your programs on that machine. When you are ready, you will then upload your programs to the SBC to run them. To demonstrate, we will use the Hello World example for Java. Download the following on your development machine before we get started:
+*[{{SERVER}}/downloads/phidget22/examples/java/Manager/Phidget22_HelloWorld_Java_Ex.zip Java HelloWorld Example]
+*[{{SERVER}}/downloads/phidget22/libraries/any/Phidget22Java.zip phidget22.jar]
-There are three ways to write and upload a Phidget program:
-#Using the SBC Web Interface:
+Next, follow these steps:
-#*This is useful for simple projects written in C or Java that you want to start at boot.
-#Using SSH '''OR''' Using the SBC via keyboard and monitor
-#*Useful for projects that run at scheduled times (e.g. once per minute).
-#*Useful for projects that use languages other than Java or ARM-compiled C.
-#*Can also be used to start programs at boot, however, a startup script is needed. See [[OS - Linux#As A Service|this example]].
-If you aren't sure which method you prefer, keep reading. Otherwise, you can jump ahead here:
+. Place phidget22.jar on your development machine in a directory that you will use to compile your Java files.
-*Using SSH to run a program? Jump ahead to [[#Program with SSH|programming with SSH]].
-*Developing directly on the SBC? Jump ahead to [[#Developing Code on the SBC|developing code on the SBC]].
-*Using the Web Interface with your Java/C program? Keep reading!
-====Program in Java with the Web Interface====
+. Copy the HelloWorld.java file from the example package to the same directory.
-To show how to write, compile, and install Java programs on the SBC, we'll use the Hello World example for Java. Download the [{{SERVER}}/downloads/examples/JavaJNI.zip Java example package] and make sure you have the same version of Java on both your development machine and on the SBC (how to check your version number was covered [[#Installing C/C++ and Java| above]]).
-The first step to getting the HelloWorld code running on on your SBC starts with your external development machine:
+. Compile the HelloWorld.java file. If you are using a Windows machine, type the following into the command prompt:
-#Download [{{SERVER}}/downloads/examples/phidget22.jar phidget22.jar]
+<syntaxhighlight lang=bash>
-#Place the SBC version of phidget22.jar on your development machine in the directory that you will use to compile the Java files.
+javac -classpath .;phidget22.jar HelloWorldExample.java
-#Copy the HelloWorld.java file into that working directory.
-#Compile the HelloWorld.java file from within that working directory. From the command line prompt on Windows, this will be:
-#:<syntaxhighlight lang=bash>
-javac -classpath .;phidget22.jar HelloWorld.java
 </syntaxhighlight>
-#:In a terminal on Linux or Mac OS, this will be:
+If you are using a Linux or macOS machine, type the following into the terminal:
-#:<syntaxhighlight lang=bash>
+<syntaxhighlight lang=bash>
-javac -classpath .:phidget22.jar HelloWorld.java
+javac -classpath .:phidget22.jar HelloWorldExample.java
 </syntaxhighlight>
-#You should now have three compiled class files:
-#*HelloWorld.class
-#*HelloWorld$1.class
-#*HelloWorld$2.class
-#Using the SBC Web Interface, create a new project called HelloWorld:
-#:[[File:sbc_create_project.png|link=|alt=|center]]
-#On the next screen, you will be prompted to upload your files. We will upload the three Java class files, and then click the Start button:
-#:[[File:sbc_web_run_project.png|link=|alt=|center]]
-#You'll note that as it runs, there are two links below the Stop button:
-#*stdout: view the program output like you would in a terminal or command prompt
-#*stderr: view the program error output
+You should now have the following class file:
+*HelloWorldExample.class
-Success! The HelloWorld example is running on your SBC. If you aren't interested in programming with SSH, or developing directly on the Phidget SBC, jump ahead to [[#Running a program automatically|running a program automatically]].
-====Program with SSH====
+. Using the SBC Web Interface, create a new project called HelloWorld:
-To show how to write, compile, and install Java programs on the SBC, we'll use the Hello World example for Java. Make sure you have Java installed before starting (this was covered [[#Installing C/C++ and Java| above]]).
-#Connect to the SBC using SSH.
-#Download the [{{SERVER}}/downloads/examples/JavaJNI.zip Phidget Java Examples] to the SBC.
-#:<syntaxhighlight lang=bash>
-wget http://copied_link
-</syntaxhighlight>
-#Unpack the examples
-#:<syntaxhighlight lang=bash>
-unzip filename
-</syntaxhighlight>
-#phidget22.jar is located at:
-#:{{Code|/usr/share/java/phidget22.jar}}
-#Compile the HelloWorld.java example:
-#:<syntaxhighlight lang=bash>
-javac -classpath .:/usr/share/java/phidget22.jar HelloWorld.java
-</syntaxhighlight>
-#To run the HelloWorld program, use:
-#:<syntaxhighlight lang=bash>
-java -classpath .:/usr/share/java/phidget22.jar HelloWorld
-</syntaxhighlight>
-Success! The HelloWorld example is running on your SBC. If you aren't interested in developing directly on the Phidget SBC, jump ahead to [[#Running a program automatically|running a program automatically]].
+[[File:Phidgetsbc_createproject.PNG|link=|alt=|center]]
-====Developing Code on the SBC====
-When you're developing directly on the SBC, you will need to use a terminal editor:
-*nano - ''recommended for beginners''
-*vi
-*emacs - ''needs to be installed''
-To install emacs, run this command on the SBC (ensure ''Include full Debian Package Repository'' is checked on the SBC Web Interface in System->Packages):
-<syntaxhighlight lang=bash>
-apt-get install emacs
-</syntaxhighlight>
-Other than creating/editing files directly on the terminal, your experience will be identical to someone using SSH, so if you haven't read the section directly above, do so now.
+. On the next screen, you will be prompted to upload your files. We will upload the Java class file, and then click the Start button:
-===Running a Program Automatically===
-After testing your program, you will likely want it to run on boot, or on a schedule, without your input.
-Running on boot:
+[[File:Phidgetsbc_runprogram.PNG|link=|alt=|center]]
-*Never miss an event. As long as the SBC is running, your code will be running.
-Running on a schedule:
-*Perform your task once a week, or once a minute without worrying about memory management issues or instability problems that may arise. It executes, and then gets cleaned up.
-If you have made your choice and want to run your program on a schedule, jump ahead to [[#Run on a schedule| running on a schedule]]. Otherwise, keep reading to learn how to run on boot!
+. You'll note that as it runs, there are two links below the Stop button:
+*stdout: view the program output like you would in a terminal or command prompt
+*stderr: view the program error output
-====Run on boot====
-This section deals with programs written in either Java or ARM-compiled C. If you are using a different type of program, jump ahead to [[#Via a Boot Script|using a boot script]].
-To have your program run on boot, navigate to Projects->Startup Settings in the SBC Web Interface. After selecting your project, copy the settings from the image below:
+Success! The HelloWorld example is running on your SBC. If you aren't interested in developing directly on the Phidget SBC, jump ahead to [[#Running a program automatically|running a program automatically]].
+===Developing Directly on the Phidget SBC===
+When developing directly on the SBC, you will do so in one of the following ways:
+*Access the terminal by connecting directly to the SBC using a keyboard and monitor.
+*Access the terminal by using SSH.
-[[File:phidgetsbc_runonstartup.PNG|link=|alt=|center|826x755px]]
+Regardless of how you choose to access the terminal, the process is the same. First, you will need to pick a terminal editor in order to write and edit your files. Here are some options we recommend:
+*nano - ''recommended for beginners, already installed''
+*vi  - ''advanced, already installed''
+*emacs - ''advanced, needs to be installed''
-We will review some of the options that are shown in the image above:
+Next, follow these steps:
-*Startup Order: lower numbers boot first. Booting later means more programs are available for use, booting earlier means other programs can use your program.
-*Run as a daemon: starts the program as a daemon. Unless you have explicitly written your program as a daemon, leave this checked, or else your SBC may hang on boot.
-*Executable/Class name: your main Java class or C file
-*Arguments: any command line arguments the program needs
-'''Warning:''' Ensure your program is stable before taking the above steps. A program that is unstable (i.e. has memory leaks or similar) will cause your SBC to crash after running for days, or months on end.
+. If you haven't already, connect to the SBC using SSH or a keyboard and monitor.
-====Run on a schedule====
+. Download the [{{SERVER}}/downloads/phidget22/examples/java/Manager/Phidget22_HelloWorld_Java_Ex.zip Phidget Java HelloWorld Example] to the SBC.
-To run your program on a schedule, we recommend using Cron. Cron can automatically schedule programs (known as ''jobs'', or ''cron jobs''). Cron simply reads a ''crontab file'' and runs whatever programs are listed, with whatever timing they are listed with. Cron runs continuously in the background, but the cron jobs only run as long as they naturally would, and then they exit.
+<syntaxhighlight lang=bash>
+wget http://examples_link
+</syntaxhighlight>
+. Unpack the examples
+<syntaxhighlight lang=bash>
+unzip examples_filename
+</syntaxhighlight>
-Let`s set up your first cron job. We will use nano to edit the crontab file, but feel free to use whatever editor you prefer!
+. Compile the HelloWorldExample.java example:
+<syntaxhighlight lang=bash>
-#Set your editor to nano:
+javac -classpath .:/usr/share/java/phidget22.jar HelloWorldExample.java
-#:<syntaxhighlight lang=bash>
-export EDITOR=nano
-</syntaxhighlight>
-#Edit your crontab file:
-#:<syntaxhighlight lang=bash>
-crontab -e
-</syntaxhighlight>
-#Schedule your cron job
-#:<syntaxhighlight lang=text>
-minute hour dayOfMonth month dayOfWeek  YOUR_COMMAND
 </syntaxhighlight>
-Done! Here is an example of a cron job that will run at 5 AM every week:
+.Run the HelloWorldExampleprogram:
-<syntaxhighlight lang=text>
+<syntaxhighlight lang=bash>
-5 * * 1 /root/code/myprogram argument1
+java -classpath .:/usr/share/java/phidget22.jar HelloWorldExample
 </syntaxhighlight>
-====Run using a boot script====
+Success! The HelloWorld example is running on your SBC. Now that you have a program running on your SBC, you may be interested in having it run automatically when the SBC boots, or maybe even on a schedule. Keep reading for more information.
-If you want your program to run on boot, you can install your program into the boot order using a script. This process is covered [[OS - Linux#As A Service|here]].
-===Programming Languages===
+===Running a Program Automatically===
-Ready to write some code? Select one of the programming languages below:
+After testing your program, you will likely want it to run on boot, or on a schedule, without your input.
-*[[Language - C/C++|C/C++]]
-*[[Language - Java | Java]]
-*[[Language - Python | Python]]
-*[[Language - JavaScript | JavaScript]]
-*[[Language - C_Sharp | C#]] - ''not recommended, but possible using Mono''
-==Network Server==
-The SBC comes with the [[Phidget Network Server]] installed, and the SBC automatically starts the Network Server at boot.
+====Run on Boot====
+Running on boot ensures that your program will never miss an event. As long as the SBC is running, your code will be running. This section assumes you have written and compiled your program on an external computer, and have uploaded it to the SBC Web Interface. If you are not using the SBC Web Interface, jump ahead to [[#Via a Boot Script|using a boot script]].
-To practice using the Network Server, and to learn more about it, check out [[OS - Linux#Using the Network Server|the Network Server section]] of the Linux page.
-==Advanced Information==
+To have your program run on boot, navigate to Projects->ProjectName->Startup Settings in the SBC Web Interface. After selecting your project, copy the settings from the image below:
-===Shutting off USB ports to save power===
-The SBC3 has an on-board USB hub that can control power to the ports. To do this unbind and rebind the USB drivers.
-To turn off the ports {{code|echo "1-1" >/sys/bus/usb/drivers/usb/unbind}}
+[[File:phidgetsbc_runonboot.PNG|link=|alt=|center]]
-To turn on the ports {{code|echo "1-1" >/sys/bus/usb/drivers/usb/bind}}
-These will also cause detach and attach events for the Phidget devices, respectively. While the drivers are unbound, you will not get any hot plug events for any devices on USB.
+We will review some of the options that are shown in the image above:
+*Startup Order: lower numbers boot first. Booting later means more programs are available for use, booting earlier means other programs can use your program.
+*Run as a daemon: starts the program as a daemon. Unless you have explicitly written your program as a daemon, leave this checked, or else your SBC may hang on boot.
+*Executable/Class name: your main Java class or C file.
+*Arguments: any command line arguments the program needs.
-===Using a Different Wireless Adapter===
+After saving your changes, your program will run automatically whenever your SBC boots.
-The support for the wireless adaptor that Phidgets sells is written into the SBC kernel.  Hence, we do not support using other adaptors.
+=====Automatically Running Python Code=====
-However, Linux is very flexible, and it is possible (though not easy) to write a custom kernel for the SBC and add support for a new wireless adaptor.  We can't help you with this, but we do provide some basic guidelines for [[#Custom Kernel and Filesystem|building your own kernel]].  You can also have a look at our thoughts on our own experience with choosing a Wifi adapter: [[Alternative Wi-Fi Adapters on the SBC]].
+To run a Python script as a standalone application, you will need to add a line called a "shebang" to the top of the script, with the path to your Python executable. If you have followed the steps in this guide, the line will be:
-===Using a Different Webcam===
+<syntaxhighlight lang=python>
+#!/usr/bin/python
+</syntaxhighlight>
-In addition to the webcam that Phidgets sells, you have the option to use many different webcams with the SBC.  There is a [http://www.ideasonboard.org/uvc/#devices long list] of compatible webcams.
+====Run on a Schedule====
+Running your program on a schedule allows you to perform your task once a week, or once a minute without worrying about memory management issues or instability problems that may arise. It executes, and then gets cleaned up. To run your program on a schedule, we recommend using Cron. Cron can automatically schedule programs (known as ''jobs'', or ''cron jobs''). Cron simply reads a ''crontab file'' and runs whatever programs are listed, with whatever timing they are listed with. Cron runs continuously in the background, but the cron jobs only run as long as they naturally would, and then they exit.
-The common thread for these webcams is that they use UVC - the USB Video Class - drivers for Linux.  You can then use [[#mount|mount]] to find out what video device your webcam is mounted under.
-===Taking Pictures With the Webcam===
+Let`s set up your first cron job. We will use nano to edit the crontab file, but feel free to use whatever editor you prefer.
-Probably the most straightforward way to use a webcam for pictures rather than video is to use the {{Code|opencv}} library.  You can get it by:
-<div class="source">
+First, set your editor to nano:
 <syntaxhighlight lang=bash>
-apt-get install libcv2.1
+export EDITOR=nano
 </syntaxhighlight>
-</div>
+Next, edit your crontab file:
-If there is no {{Code|libcv2.1}} package, you can perform {{Code|apt-cache search libcv}} to find the current version.
-The opencv libraries can also be used within Python, by installing the link between them:
-<div class="source">
 <syntaxhighlight lang=bash>
-apt-get install python-opencv
+crontab -e
 </syntaxhighlight>
-</div>
+Finally, schedule your cron job:
+<syntaxhighlight lang=text>
-Then taking pictures from within code becomes quite simple.  For example, in Python, taking and saving an image is four lines:
+#cron job that will run at 5AM every week:
+5 * * 1 /root/code/myprogram argument1
-<div class="source">
-<syntaxhighlight lang=bash>
-#! /usr/bin/python
-import cv
-# The webcam is located at /dev/video0
-# OpenCV only needs the number after video
-webcam = cv.CaptureFromCAM(0)
-frame = cv.QueryFrame(webcam)
-cv.SaveImage("image.jpg", frame)
 </syntaxhighlight>
-</div>
-For the complete OpenCV documentation, see [http://opencv.willowgarage.com/documentation/index.html The OpenCV Reference], and specifically the section on [http://opencv.willowgarage.com/documentation/reading_and_writing_images_and_video.html Reading and Writing Images].
+[[File:phidgetsbc_cronjob.PNG|link=|alt=|center]]
-'''Note:''' The SBC is probably not as powerful for image processing and transport when compared to your desktop computer.  Try running your image processing code on the SBC from an early point in development.  During those test runs, you can visit the first System page of the [[#SBC Web Interface|SBC Web Interface]] to check the processor and memory use.  For more information on processor power, check the specification for your SBC (on the product page on [{{SERVER}} our main website]) as well as our discussion of [[#Pushing Processor Limits|pushing processor limits]] below.
-===Checking System Logs===
+After entering your task, simply save and exit the file.
-The SBC maintains two logs: a kernel log and a system log.
+====Run Using a Boot Script====
+If you want your program to run on boot, you can install your program into the boot order using a script. This process is covered [[OS - Linux#As A Service|here]].
-The kernel log is for low-level occurrences, such as devices attaching and leaving the USB hub, recording what drivers are being used, and so on.
+===Programming===
+Ready to write some code? Select one of the programming languages below:
+*[[Language - C|C]]
+*[[Language - Java | Java]]
+*[[Language - Python | Python]]
+*[[Language - JavaScript | JavaScript]]
+*[[Language - C_Sharp | C#]]
-The system log (syslog) is for normal chatter from the operating system.  Any program with the right permissions can use it (though you need to know the method to write to it, information all around the Internet can help) and it contains everything from the Ethernet going up and down, to webserver requests, and so on.  If you don't run many programs or services on the SBC, the syslog will essentially be a mirror of the kernel log, because the kernel is the only thing talking.
+==Phidget Network Server==
+The Phidget Network Server is an extremely useful feature of Phidgets that allows you to remotely control Phidgets over your network. If you haven't already, check out the  [[Phidget Network Server]] page for a complete overview.
-You can check these logs by using the web interface in the {{Code|System &rarr; Logs}} tab.
+===Try it Out!===
+The Phidget SBC comes with the Phidget Network Server installed, and the SBC automatically starts the Network Server on boot. In order to change any of this default behaviour, navigate to Phidgets->phidget22NetworkServer using the SBC Web Interface:
-Or you can perform more powerful filtering and displaying via an SSH terminal.  For example, {{Code|dmesg}} is the command to display the kernel log, and {{Code|tail}} prints the last ten lines of input.  So, if you are trying to see if you can get a device to be detected on USB, you can run <code>dmesg | tail</code> to print the latest ten lines of kernel log data.
-The actual locations of the log files (for filtering and reading) are:
+[[File:phidgetsbc_networkserver.PNG|link=|alt=|center]]
-* {{Code|/var/log/syslog}}
-* {{Code|/var/log/dmesg}}
-But don't edit them directly!  Always follow the advice and procedures around the Internet on how to properly log items to syslog.
-===X Forwarding===
-Although most tasks can be done using the [[#SBC Web Interface|SBC Web Interface]] or [[#SSH|SSH]], you can also set up X11 forwarding on the SBC.  X11 is the window manager base, which provides a graphical windowing system on the SBC.  Although you probably won't connect directly to the X11 manager (i.e. by plugging a screen directly into the SBC), X11 also gives a user the ability to forward graphical windows over SSH.  You will need the following packages installed:
-* {{Code|x11-common}}
-* {{Code|xbase-clients}}
-After installing, make sure that the line in {{Code|/etc/ssh/sshd_config}} has a line that says:
-:{{Code|X11Forwarding yes}}
-Then log out and log back into the SBC.  This second time you log in, use the {{Code|-X}} switch to turn on X forwarding for that connection:
-:{{Code|ssh -X root@phidgetsbc.local}}
-Then you should be able to run programs that launch a window, and it will launch remotely and appear on the computer you have the SSH connection from.
-===Pushing Processor Limits===
-The SBC, though more powerful than many embedded computers out there, is probably about as powerful as your smartphone.  If you hook up 1 ms Phidget sampling devices to all six of its USB ports, events and packets will probably get lost.  The exact data rates you can accomplish depend on:
-* What else is running on the SBC
-* How efficient your code is for external operations (like File I/O)
-* Other minor details (e.g. the temperature of the SBC, etc)
-If you want to achieve data rates as fast as possible, try these tips:
+In order to try the Phidget Network Server out, you will need a host computer, and a client computer:
-* Program in C, not in an interpreted language (Python, Java, .NET)
+*Host computer: the computer that is physically connected to the Phidgets via USB and is running the Phidget Network Server.
-* Perform file I/O as little as possible.  Locally cache data, manage your writing to a file in a separate thread, and use low-level write calls.
+*Client computer: a computer running a Phidgets application that accesses Phidgets connected to the host computer.
-* Change the [[#Custom Kernel and Filesystem|filesystem]] to a faster, non-compressed file system.
-** Alternatively, use a high-data-rate USB key.
-* Keep other running processes to a minimum.
-** If you are running code locally right on the SBC, turn off the Phidget Network Server.
-===Saving a file system to flash to multiple SBC's===
-You may want to create a complete backup of your SBC root filesystem, which can then be flashed to other SBCs. This is how it could be done:
-You will need a USB drive - we have had issues using cheap flash drives, so a real USB drive is recommended. Make sure it's empty, as it will be reformatted.
+For this example, we will use the Phidget SBC as the host computer. The next step is setting up your client computer. If you are using a Windows computer as your client, keep reading, otherwise, you can jump ahead here:
+*[[#macOS Client | macOS Client]]
+*[[#Linux Client | Linux Client]]
-All of these commands are executed on your SBC, while logged in over SSH.
-First, re-format the USB drive as ext3. Assuming the USB drive is sda and has a single partition:
+====Windows Client====
+In order to remotely access Phidgets on your SBC, you should get your client computer set up. Follow the Getting Started guide for Windows below before continuing:
+*[[OS - Windows#Getting started with Windows| Getting started with Windows]]
-<div class="source">
-<syntaxhighlight lang=bash>
-umount /dev/sda1
-mkfs.ext3 /dev/sda1
-mount -t ext3 /dev/sda1 /media/usb0
-</syntaxhighlight>
-</div>
-Then, remount / as readonly, so it doesn't change as we're copying it. To do this, we need to kill all running processes except sshd:
+Now that you have Phidget drivers and libraries installed on your client computer, we can test the Phidget Network Server by following the steps below:
-<div class="source">
+. Open the Phidget Control Panel on your client computer. You will see something like this:
-<syntaxhighlight lang=bash>
-service udev stop
-service ifplugd stop
-service rsyslog stop
-service avahi-daemon stop
-service phidgetNetworkserver stop
-service ntp stop
-service busybox-httpd stop
-service dbus stop
-service cron stop
-pkill dhclient
-mount -o remount,ro /
-</syntaxhighlight>
-</div>
-If the remount says that / is busy, do a 'ps auxww' and 'pkill' anything else that may be running until it remounts properly.
-Then, copy / to the flash drive:
+[[File:Phidgetsbc_networkserver_windows.PNG|link=|alt=|center|]]
-<div class="source">
-<syntaxhighlight lang=bash>
-mkdir /media/usb0/root
-mount --bind / /mnt/
-cp -a /mnt/* /media/usb0/root/
-</syntaxhighlight>
-</div>
-Then, clean up the copy - removing files specific to this board. We also remove the APT cache to save space.
+. You now have access to the Phidgets that are connected to your Phidget SBC. Try double-clicking one of them to bring up an example.
-<div class="source">
+====macOS Client====
-<syntaxhighlight lang=bash>
+In order to remotely access Phidgets on your SBC, you should get your client computer set up. Follow the Getting Started guide for macOS below before continuing:
-find /media/usb0/root/var/log -type f -print0 | xargs -0 rm -f
+*[[OS - macOS#Getting started with macOS| Getting started with macOS]]
-rm -rf /media/usb0/root/var/lib/apt/lists/*
-mkdir /media/usb0/root/var/lib/apt/lists/partial
-rm -f /media/usb0/root/var/cache/apt/*.bin
-rm /media/usb0/root/etc/udev/rules.d/70-persistent-net.rules
-rm /media/usb0/root/etc/ssh/ssh_host_*
-</syntaxhighlight>
-</div>
-then, create the ubinize.cfg file:
-For SBC3:
-<div class="source">
+Now that you have Phidget drivers and libraries installed on your client computer, we can test the Phidget Network Server by following the steps below:
-<syntaxhighlight lang=bash>
-cd /media/usb0
-cat > ubinize.cfg << EOF
-[rootfs]
-mode=ubi
-image=/media/usb0/system_ubifs.img
-vol_id=0
-vol_size=83MiB
-vol_type=dynamic
-vol_name=rootfs0
-vol_flags=autoresize
-EOF
-</syntaxhighlight>
-</div>
-For SBC2:
+. Open the Phidget Control Panel on your client computer. You will see something like this:
-<div class="source">
+[[File:Phidgetsbc_networkserver_macos.PNG|link=|alt=|center|]]
-<syntaxhighlight lang=bash>
-cd /media/usb0
-cat > ubinize.cfg << EOF
-[rootfs]
-mode=ubi
-image=/media/usb0/system_ubifs.img
-vol_id=0
-vol_size=64128KiB
-vol_type=dynamic
-vol_name=rootfs
-vol_flags=autoresize
-EOF
-</syntaxhighlight>
-</div>
-NOTE: you may need to increase vol_size if your filesystem is larger.
+. You now have access to the Phidgets that are connected to your Phidget SBC. Try double-clicking one of them to bring up an example.
-then, create the UBI image from the copy:
+====Linux Client====
+In order to remotely access Phidgets on your SBC, you should get your client computer set up. Follow the Getting Started guide for Linux below before continuing:
+*[[OS - Linux#Getting started with Linux| Getting started with Linux]]
-For SBC3:
-<div class="source">
+Now that you have Phidget drivers and libraries installed on your client computer, we can test the Phidget Network Server by following the steps below:
-<syntaxhighlight lang=bash>
-mkfs.ubifs -F -m 4KiB -e 248KiB -c 4000 -r /media/usb0/root /media/usb0/system_ubifs.img
-ubinize -o /media/usb0/system_ubi.img -m 4KiB -p 256KiB ubinize.cfg
-</syntaxhighlight>
-</div>
-For SBC2:
+. From the terminal, type in the following command:
-<div class="source">
 <syntaxhighlight lang=bash>
-mkfs.ubifs -m 2KiB -e 126KiB -c 4050 -r /media/usb0/root /media/usb0/system_ubifs.img
+ phidget22admin -s
-ubinize -o /media/usb0/system_ubi.img -m 2KiB -p 128KiB -s 512 ubinize.cfg
 </syntaxhighlight>
-</div>
-then, unmount the drive to ensure everything is written out properly:
-<div class="source">
+You will now see something like this:
-<syntaxhighlight lang=bash>
-umount /dev/sda1
-</syntaxhighlight>
-</div>
-Then, you can remove the /root/ folder and system_ubifs.img. system_ubi.img can be flashed to other SBCs using the recovery system.
-===Software Details===
+[[File:Phidgetsbc_linuxphidgetadmin.PNG|link=|alt=|center|]]
-For even more advanced uses of the SBC, it may help to know the gritty details of the SBC software system.
-;Operating System
+As shown in the image above, the server running on your SBC can now be seen over the network. You will now be able to remotely access any Phidgets connected to your SBC.
-:Debian/GNU Linux
-:Kernel 2.6.X or higher (generally kept up to date with latest releases, use {{Code|uname -r}} to check the kernel version)
-;Main Filesystem (rootfs)
-:UBIFS (a raw flash type of file system)
-:Mounted in a 460 MB Nand partition (in Read/Write mode)
-;Kernel
+===What's Next?===
-:uImage format
+Now that you have seen the Network Server in action, you may be interested in implementing an application that takes advantage of all it's features. Luckily, every programming language we support comes with example code on how to do this! Jump to [[#Programming|programming languages]] above.
-:Has its own 3MiB partition on bare Nand
-;Web Interface Scripts and Configuration Data
+==Advanced Information==
-:Located in {{Code|/etc/webif}}
+===Writing Image to SD Card===
-:Modifying these scripts can be done; however, it is very easy to enter invalid data that could cause the system to behave unexpectedly or not boot.
+{{SDCardImage}}
-;User Applications uploaded through Web Interface
+===Checking System Logs===
-:Located in {{Code|/usr/userapps}}
-;Webcam Device Location
+The SBC maintains two logs: a kernel log and a system log.
-:{{Code|/dev/video0}}
-:Numbers increase with more webcams
-;Date and Time
+The kernel log is for low-level occurrences, such as devices attaching and leaving the USB hub, recording what drivers are being used, and so on.
-:Set using ntp (network time protocol) at boot
-:The ntp daemon continues to run in the background and will periodically update the clock
-:The network keeps the SBC very close to real time
-:Also there is a real-time clock with battery backup which will preserve date/time across reboots, power removal
-:The real-time clock is synced to system time during reboot/shutdown
-:If power is unplugged suddenly, and the network not restored, the real-time clock may not have the correct time
-;Wireless Networking System
+The system log (syslog) is for normal chatter from the operating system.  Any program with the right permissions can use it (though you need to know the method to write to it, information all around the Internet can help) and it contains everything from the Ethernet going up and down, to webserver requests, and so on.  If you don't run many programs or services on the SBC, the syslog will essentially be a mirror of the kernel log, because the kernel is the only thing talking.
-:Wireless adapter support for the wireless adapter that Phidgets sells is written into the kernel
-:It supports WEP and WPA
-:It is best configured through the configuration interface.
-;Nand Layout
+You can check these logs by using the web interface in the {{Code|System &rarr; Logs}} tab.
-:The board contains 512MiB on Nand. This nand is split into 7 partitions as follows:
-:0: u-boot		 size: 256K		 Read Only
-:1: u-boot_env		 size: 128K		 Read Only
-:2: recovery_kernel	 size: 2M		 Read Only
-:3: kernel		 size: 3M		 Writable
-:4: flashfs	 	 size: ~3.625M	 	 Read Only
-:5: recovery_fs		 size: ~ 43M		 Read Only
-:6: rootfs		 size: ~ 460M		 Writable
-: The final size of flashfs/recovery_fs/rootfs depends on the image size at production, and on the number/location of bad blocks in the NAND.
-: '''Note''': U-Boot and recovery kernel and filesystem cannot be written from Linux - this is a safety measure.
-;Boot Loader
+Or you can perform more powerful filtering and displaying via an SSH terminal.  For example, {{Code|dmesg}} is the command to display the kernel log, and {{Code|tail}} prints the last ten lines of input.  So, if you are trying to see if you can get a device to be detected on USB, you can run <code>dmesg | tail</code> to print the latest ten lines of kernel log data.
-:U-Boot is used for setting up the processor and booting Linux, and is only accessible via a serial connection.
-:Normal users will not need to use or modify it.
-:Be very careful when modifying the u-boot partition. If it is damaged or overwritten, it is difficult to fix.
-:When using U-Boot, a prompt will appear via serial shortly after power on.
-:The environment variables will help you determine how to boot Linux on the SBC
-:You can also refer to the [http://www.denx.de/wiki/DULG/Manual U-Boot documentation]
-;Boot Process
+The actual locations of the log files (for filtering and reading) are:
-:From power on...
+* {{Code|/var/log/syslog}}
-:1. Processor loads first 4 bytes from NAND into Steppingstone and runs it.
+* {{Code|/var/log/dmesg}}
-:2. Steppingstone sets up RAM, copies u-boot from NAND into RAM and runs U-Boot.
+But don't edit them directly!  Always follow the advice and procedures around the Internet on how to properly log items to syslog.
-:3. U-Boot initializes the processor, sets GPIO state, etc., copies the linux kernel into RAM, sets up the kernel command line arguments, checks that the kernel image is valid, and boots it.
+==Further Reading==
-:4. Linux boots, bringing up USB, Networking, NAND, etc. and then mounts the rootfs NAND partition on /.
-:5. init gets run as the parents of all processes, as uses the /etc/inittab script to bring up the system. This includes mounting other filesystems, settings the hostname, and running the scripts in /etc/init.d, among other things.
-:6. inittab then turns the green LED on.
-:7. inittab then sets up a getty on the first serial port, ready for interfacing using the debug board.

OS - Phidget SBC: Difference between revisions

Revision as of 20:19, 11 June 2018

Quick Downloads

Getting Started With the Phidget SBC

Developing with an External Computer

SSH

SSH on Windows

SSH on Linux and macOS

Installing Packages for Development

C and Java

Installing Python

Basic Python

Method 1: Use the Internet

Method 2: Use a USB Key

Developing Applications

Developing with an External Computer

Developing Directly on the Phidget SBC

Running a Program Automatically

Run on Boot

Automatically Running Python Code

Run on a Schedule

Run Using a Boot Script

Programming

Phidget Network Server

Try it Out!

Windows Client

macOS Client

Linux Client

What's Next?

Advanced Information

Writing Image to SD Card

Command Line

Expanding your File System

Checking System Logs

Further Reading

Navigation menu