This repository contains a litle Python package that can communicate with real xylophone. The communication follows a Client-Server model. A client sends notes to the server and afterwards it sends a command to start playing the music sheet. A server listen for the client and when the play command arrives, it processes the notes. There are two servers, one that communicates with a hardware xylophone, and one that mocks its behaviour.

In order to use this library in another project it must be installed. This is fairly straightforward as it can be installed with pip. Execute the following steps:

1. Clone the repository.

$ git clone https://github.com/udesa-ai/xylophone.git

1. Get in the local repository.

$ cd /path/to/xylophone

1. Install the dependencies.

$ pip install -r requirements.txt

1. Install it with pip

$ pip install .

The usage is also quite easy as it requires to interact with just a few classes. First we'll show you how to write a xylophone client that can send commands to the xylophone server.

The supported notes are:

from xylophone.client import XyloClient
from xylophone.xylo import XyloNote

# Create and store all the notes in a single list.
notes = [
    XyloNote('A4', 1.5, 90),
    XyloNote('A4', 2.3, 90),
    XyloNote('G#6', 5.33333, 90),
    XyloNote('A4', 10.01, 90),
    ]

# Instantiate the client with the IP address or host, and the port.
# Take a look at the server you spun up or ask someone else for this info.
client = XyloClient(host='localhost', port=8080)

# Load the notes
client.load(notes)

# Play the song
client.play()

You can use the example in here.

This tiny library provides two servers:

• A server that connects to a real xylophone by USB.
• A mock server that has the same interface as the real one but just acknowledges the sent message.

To instantiate a mock server it's also very easy as it requires to import only one class from this library.

# Import the mock server
from xylophone.server.server import MockXyloServer

# Instantiate the mock server and specify the IP/host and port that it's going to be using.
server = MockXyloServer(host='localhost', port=8080)

# Just start the server
server.start()

It's the same but it must be connected to a real robotic xylophone by USB.

# Import the xylo server
from xylophone.server.server import XyloServer

# Instantiate the xylo server and specify the IP/host and port that it's going to be using.
server = XyloServer(host='localhost', port=8080)

# Just start the server
server.start()

Note: Keep in mind that these scripts won't terminate unless you do it.