XChat physical notify

As I said before, I wanted to hook up my Arduino to work with XChat. I wrote a plug-in to raise a flag attached to my computer monitor when my nick is mentioned in the channel.

This is very simple and requires not a whole lot of code. So I am just going to post the code and tell only a little about it.


#include <Servo.h>

Servo leflag;
int pos = 0;
int buffbyte = 0;

void setup()

void loop()
    //If we have something to read, then read it
    if (Serial.available() > 0)
       buffbyte = Serial.read();
       //If ascii A, move servo
       if (buffbyte == 65)
       //If ascii B, move servo
       else if (buffbyte == 66) //ascii B

And the XChat plugin to communicate with the Arduino. Your serial port my be different, use the Arduino IDE or the shell command “dmesg | grep tty” to see which one the Arduino is on:

import xchat, serial, os, time

__module_name__ = "ArduNotify"
__module_version__ = "1.0"
__module_description__ = "Turns a servo to let you know when somone said your name in channle. Uses Arduino."

s = serial.Serial("/dev/ttyUSB0")

#Check if file exists, if not, create it
#We use checkFile to ensure we get no errors incase we remove le logs
def checkFile():
        f = open("said.txt", "r")
        f = open("said.txt", "w")

def checkForName(words, words_eol, userdata):
    if "techb" in words[1].lower() or "techb_away" in words[1].lower():
        f = open("said.txt", "a")
        f.write("%s %s" % (time.strftime("%I:%M", time.localtime()), words_eol[0][0:-1]+'\n\n'))

def acceptNotify(words, words_eol, userdata):
    return xchat.EAT_ALL

def checkNotify(words, words_eol, userdata):
    os.system("gedit said.txt")
    return xchat.EAT_ALL

def rmNotify(words, words_eol, userdata):
    os.system("rm said.txt")
    return xchat.EAT_ALL

def unloadHandler(userdata):
    #try close the serial port handle when this script gets unloaded
    #not really needed, but good for cleaning up and testing

xchat.hook_print("Channel Message", checkForName)
xchat.hook_print("Channel Msg Hilight", checkForName)
xchat.hook_command("gotit", acceptNotify)
xchat.hook_command("check", checkNotify)
xchat.hook_command("rm", rmNotify)

The Arduino code is self explanatory, so I wont go over it.

The plugin on the other hand has more going on with it. We have a function to check if there is a log file. If not, we create one. We do this check because there is a command I built-in to remove the log file.

The next function is to check if our nick was mentioned. We attach it to the channel highlight and channel message hooks because I use two different names, one for away and one for when I’m active. We want to check for both. If either name is mentioned, we log the message along with the time it was said, and send ASCII “A” to the Arduino to raise the flag.

The next function will lower the flag.

To check the log file, we simply use Python’s built-in module os and then send a shell command for Gedit to open the log file.

Next, the remove function does just like the check command, but removes the log file from the system. Again using the os module.

The last function is to handle an unload. If the plugin is unloaded, we will want to close the handle to the serial port. This isn’t ‘really’ needed, but is good practice incase XChat crashes or something.

Here is a bad quality video of the setup. Sorry for the bad quality, I have no money for a real cam, so I have to use my phone.


About Tech B.

I am currently employed as a tech support rep for Frontier DSL internet and Dail-Up service. If you live on the East Coast and have Frontier or the old Verizon, you may have spoken with me at one point. I do side jobs programming and building things for people. I know Python better than any language in my toolbox. I can also develop Android Apps, which are Java based. Other languages include C , VB/VB.NET, some C#, PBASIC, Batch, Javascript, and some PHP. I love microcontrollers and interfacing with the outside world. I am currently working with Arduinos, which are amazing. Also I can work with the Basic Stamp family of microcontrollers; future development includes FPGA and embedded Linux. I was going to school, but have financial issues at the moment that are keeping me from the books. I plan on going back in the next couple semesters and finishing up my Associates in IT, then perusing a BS in computer science.
This entry was posted in Uncategorized. Bookmark the permalink.

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s