https://github.com/chris00/ocaml-mindstorm

Library to drive Lego mindstorm NXT bricks from OCaml. Communication with the NXT brick is done through bluetooth.
https://github.com/chris00/ocaml-mindstorm

lego mindstorms robotics

Last synced: 15 days ago
JSON representation

Library to drive Lego mindstorm NXT bricks from OCaml. Communication with the NXT brick is done through bluetooth.

• Host: GitHub
• URL: https://github.com/chris00/ocaml-mindstorm
• Owner: Chris00
• License: other
• Created: 2014-04-14T08:31:13.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2023-07-25T10:26:13.000Z (over 1 year ago)
• Last Synced: 2024-05-09T23:22:26.489Z (6 months ago)
• Topics: lego, mindstorms, robotics
• Language: OCaml
• Size: 17.8 MB
• Stars: 17
• Watchers: 5
• Forks: 4
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![Continuous Integration](https://github.com/Chris00/ocaml-mindstorm/actions/workflows/main.yml/badge.svg)

Mindstorm

=========

Installation

------------

The easier way to install this library is by using [OPAM][]:

    opam install mindstorm

for the standard version and

    opam install mindstorm-lwt

for the LWT one.  If you prefer to compile and install by hand, make

sure you have [dune][] and the dependencies listed in

[src/dune](src/dune) and [lwt/dune](lwt/dune), then run

    dune build @install

    dune install mindstorm

    dune install mindstorm-lwt

[OPAM]: https://opam.ocaml.org/

[dune]: https://github.com/ocaml/dune

Usage

-----

Two modules are available: `Mindstorm` and `Mindstorm_lwt` with

essentially the same signatures, except that the second one—as its

name indicates—is to be used with `Lwt`.

Prerequisite under Unix

-----------------------

You need the package `libbluetooth-dev` (under Debian) or equivalent.

For the USB connection, you must install the package `libusb-1.0-0-dev`

(its presence should be automatically detected).

Prerequisite under Windows

--------------------------

Do not install the LEGO® fantom drivers.  (If you know how to make

this library work with the LEGO® drivers installed, submit a patch!)

Prerequisite under Mac OS X

---------------------------

At the moment, the package is not compatible with OSX.

Documentation

-------------

You can compile the HTML doc with

    make doc

and then point your browser to `_build/default/_doc/index.html`.

Alternatively, you can

[read it online](https://Chris00.github.io/ocaml-mindstorm/doc/).