Skip to content

Commit

Permalink
New monoKiosk getting started guide
Browse files Browse the repository at this point in the history
  • Loading branch information
Kristoffer Andersen committed Jan 24, 2017
1 parent c1caccb commit 396dbdf
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 69 deletions.
Binary file added getting-started/monomake-ui.png
View file
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
98 changes: 29 additions & 69 deletions getting-started/using_monokiosk.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,102 +5,62 @@
In this guide we will show you how to download and install a pre-built application on Mono. Monokiosk is the *app store* where you can browse and download mono applications, built by makers from around the world.

```eval_rst
.. note:: In this early phase the number of applications on monokiosk is quite limited. We plan to add more applications to the kiosk ourselves, and hope that our community will submit their own creations to the site.
.. note:: We plan to add more applications to the kiosk ourselves, and hope that our community will submit their own creations to the site.
```

But until then, let us focus on the few apps we have in the kiosk right now. In this guide we shall install the *Tic Tac Toe* sample app.

## Visit monokiosk.com

First order of business, direct your favorite browser to **[monokiosk.com](https://monokiosk.com)**, and you will see this page like this:
First order of business, direct your favorite browser to **[monokiosk.com](https://kiosk.openmono.com)**, and you will see this page like this:

![Mono Kiosk landing page](monokiosk1.png "Mono Kiosk landing page")

Currently there are a simple *Clock* app and and a *Tic Tac Toe* app. But before you franticly click on one of these crazy mind blowing apps, you first need to install a tool called **monoprog**.
Currently there are a simple *Clock* app and and a *Tic Tac Toe* app. But before you franticly click on one of these crazy mind blowing apps, you first need to install our *MonoMake* tool to install the application onto Mono.

*Monoprog* is a programmer. A programmer is an application that transfers application files to mono, using the USB port. You need this tool to get the application from the computer to your Mono device. When you install applications from Monokiosk, the overall procedure is:
*MonoMake* is an application that _programs_ the application on Mono. Such a _programmer_ transfers application files to mono, using the USB port. You need this tool to get the application from your computer to your Mono device. When you install applications from Monokiosk, the overall procedure is:

1. Download the application from monokiosk. (An application is a file with the extension: *.elf*)
1. Use *monoprog* to transfer the downloaded *.elf* file to Mono.
1. There is no step 3!
1. Connect Mono to your computer using an USB cable
1. Make sure Mono is *on*
1. Click the *Install* button in MonoKiosk, for the app you wish to install.

First you must download monoprog itself, so click on *Get Started* in the menu bar. Nowyou will see this page:
However, **first** you must download *MonoMake* itself, so click on the button that suits your system:

![Monoprog download page](monokiosk2.png "Monoprog download page")
<table class="table wy-text-center" style="width: 100%;">
<tr><th>Windows</th><th>macOS</th><th>Debian/Ubuntu</th></tr>
<tr>
<td><a href="../downloads/windows.html" class="btn btn-neutral"><span class="fa fa-download"></span> Download </a></td>
<td><a href="../downloads/macos.html" class="btn btn-neutral"><span class="fa fa-download"></span> Download</a></td>
<td><a href="../downloads/linux.html" class="btn btn-neutral" target="_blank"><span class="fa fa-download"></span> Download</a></td>
</tr>
</table>
<br />

Choose the option that fits you or your OS. The downloads are installers that will install *monoprog* on your system.

```eval_rst
.. admonition:: Windows 8 and 10 Users:
We are working on a signed driver package to be a part of the installer, but until then Window 8 and 10 users must disable the driver signing requirement. If the device driver is not installed, Windows will not detect Mono's serial port as a COM device. See Sparkfuns tutorial on `How to Disable Signing Checks <https://learn.sparkfun.com/tutorials/disabling-driver-signature-on-windows-8/disabling-signed-driver-enforcement-on-windows-8>`_
.. admonition:: Linux Users:
We have compiled a debian package for you. You need to use the `dpkg` tool to install the package, and then run `apt-get install` to install any dependencies. Non-debian users: You are skilled enough to compile monoprog from `source <https://github.com/getopenmono/monoprog>`_.
.. note:: This software you have installed is the complete toolset for developing OpenMono applications. However, you dont need to use that. Here, we are just using the tool *MonoMake*.
```

## Download Tic Tac Toe

Now, go back to the frontpage and click on the *Tic Tac Toe* app. You will now see this page, where you need to scroll down to the download link at the bottom right:

![Tic Tac Toe app details page](monokiosk3.png "Tic Tac Toe app details page")

When you click the link, the file `ttt.elf` will be downloaded to your computer. This file is the application binary file and it is compatible with all present Mono models. Save the file in a folder, that you can easily reach from a terminal. Yes, now we must use terminal or command prompt.

## Transfer the app to Mono

```eval_rst
.. attention:: Since this is the first version of *monoprog*, it is a command line application. We have plan to wrap it inside a nice GUI - but for now bear with us.
```
## Install Tic Tac Toe

Open a terminal window:
After you have download and installed the OpenMono SDK on your system, let's continue.

* On Mac / Ubuntu: Open the Terminal application.
* On Windows: Press `Window-key + R`, type `cmd` and hit Enter.
Go to the frontpage and click on the *Tic Tac Toe* app. You will now see this page, where you will see the *install button* at the bottom right:

Type type this in the console, to verify monoprog is installed:

```
$ monoprog
Usage: monoprog [options]
Bootloadable Programmer for Mono board.
Options:
-h, --help Displays this help.
-V, --version Displays version information.
--license Displays licenses of software components.
-d, --detect Detects whether a Mono is connected via USB.
--mock <type> Simulates device to be in <type>.
-p, --program <app> Transfers <app> to Mono.
-v, --verbose <level> Set output verbosity level (default is 1).
-q, --quiet, --silent Set output verbosity level to 0.
```

If you see a message similar to this one, then everything is awesome! If your console brags about unknown command or application, then please run the installer again.

Connect Mono to your computer using a standard microUSB cable. Then, (from the terminal) navigate to the directory where you placed the file `ttt.elf`. Then write this *monoprog* command:
![Tic Tac Toe app details page](monokiosk3.png "Tic Tac Toe app details page")

```
$ monoprog -d
```
When you click the link, the *install* button, the *MonoMake* application will launch. *MonoMake* will automatically download the chosen application binary and install it on to Mono.

*Monoprog* will now try to find any connected Mono devices. If your device is found it returns: *Mono device detected*.
Now the application's binary code is loaded to Mono's internal flash memory. If everything goes well Mono will wake up and display the *Tic Tac Toe* app. Next, you can find a friend to play Tic Tac Toe with, you can install the other app or you could consider creating your own!

```eval_rst
.. note:: If *monoprog* does not detect any connected Mono device, please force Mono into bootloader with help from `this guide <../tutorials/resetting_mono.html#force-load-bootloader>`_.
```
## Manual installs

To transfer (program) the app to Mono write:
If, for some reason *MonoMake* does not launch when you click the *install* button - there are other options. Scroll down and click the *Download* button instead. This downloads the application binary file (*.elf*) to your computer. When the file is downloaded, launch *MonoMake* yourself.

```
$ monoprog -p ttt.elf
```
![MonoMake](monomake-ui.png "MonoMake application main window")

Now, *monoprog* programs the application binary code to Mono's internal flash memory. If everything goes well Mono will wake up and display the *Tic Tac Toe* app. Next, you can find a friend to play Tic Tac Toe with, you can download the other app or you could consider creating your own!
Make sure that *Monomake* can see your connected (and *running*) Mono device. This is indicated at the lower right corner. Now, click the blue *Install* button left of the center. A standard *Open file* dialog box will open. Navigate to the just downloaded application *.elf* file, and open it.

*MonoMake* installs the application onto Mono.



0 comments on commit 396dbdf

Please sign in to comment.