summaryrefslogtreecommitdiff
path: root/index.mdwn
blob: 6d006afadff9b68fcbcdcd892b182a038d21a209 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
# Introduction

Pyfantom is a Python wrapper for the LEGO Mindstorms Fantom Driver. The Fantom
Driver is available for Mac OSX and Windows, from [LEGO website][].

 [LEGO website]: http://mindstorms.lego.com/en-us/support/files/default.aspx

Pyfantom exposes the routines for interfacing to the LEGO Mindstorms NXT using
python applications.

The Fantom API is documented in the Fantom SDK 1.0.x available from the same
site as the LEGO Fantom Drivers.

## Requirements (Mac OSX)
 
 * Python 2.6.x (Mac OSX default), or Python 2.7 Universal Build (MacPorts)
 * LEGO Mindstorms Fantom Drivers

## Requirements (Windows)

[TBD, not tested yet]

 * Python >= 2.6
 * LEGO Mindstorms Fantom Drivers

# Get sources

You can clone the git repository with:

    git clone http://git.ni.fr.eu.org/pyfantom.git/

Alternatively, you can download a [snapshot][] and extract it on your
computer.

You can also browse source online using [gitweb][].

 [snapshot]: http://git.ni.fr.eu.org/snapshots/pyfantom-master.tar.gz
 [gitweb]: http://git.ni.fr.eu.org/?p=pyfantom.git;a=summary

# Installation

If you're installing using the source package, first extract the source
package, then:

    # python setup.py install

inside the package directory. This should be run as root (or use sudo).

# Status

* The USB interface is working well.
* Bluetooth Interface partially works, e.g., send_direct_command(), but raw commands sent using NXT.write() fails since NXT.read() does not return any data.
* Not all Fantom API functions are exposed, e.g., high level iFile, iModule APIs (Patches are welcome).

# How to use this wiki?

This wiki is powered by [[ikiwiki]].

You are encouraged to make changes, you just have to register or login using
an already existing OpenID compatible account.

All wikis are supposed to have a [[SandBox]], so this one does too.

LEGO® is a trademark of the LEGO Group of companies which does not sponsor,
authorize or endorse this site.