Hi,
I just started using an OBI202 with
voip.ms. So far it is exceeding my expectations.
It's disappointing people aren't sharing their scripts openly so we can all have better experiences. Especially when we use other peoples' software (e.g., xbmc) Oh, well.
Here's my crappy caller ID to xbmc and YAC Listener script! It's not pretty, but it seems to work (with very little testing!) I hope somebody takes this and improves it! You'll need a linux server for this to work. I'm using Ubuntu 12.04 and the following instructions are for that.
~/YourScript.sh:
#!/bin/bash
##############
## lockfile ##
##############
exec 9>/tmp/callerid-lockfile
if ! flock -n 9 ; then
exit 1
fi
# this script now runs under the lock until 9 is closed. it will be closed automatically when the script ends.
####################
## Configuration ##
####################
LOGLOCATION="/var/log/obi202.log" # the location of your syslog log
IPADDRESSSTART="192.168.0." # only the first 3 values and dots for your LAN IP Address
XBMCIPs=(116 115 112) # the last value(s) of the ip address(es) of your xbmc devices(s)
XBMCPORT="8080" # default port for xbmc webserver
XBMCPOPUPDURATION="7000" # in msecs (i.e., 7000 = an xbmc popup for 7 seconds)
YACIPs=(234 190) # the last value(s) of ip address(es) for computer you want YAC popups
YACPORT="10629" # default port for YAC is 10629.
####################################
## Extract string from the log ##
####################################
sleep 0.1 # allow a bit of time for log messages to complete.
STRINGFROMLOG=$(tac $LOGLOCATION | grep -B 1 -m1 'Command: 1, 3, 0, 0, 4, 1086133200,' | tac) # invert log to find first line before "Command: 1, 3, 0...". This is the last Caller ID entry.
STRINGFROMLOG=$(sed -n -e 's/^.*1086133200, //p' <<< $STRINGFROMLOG) # Strip off everything after "1086133200, " to leave just the CID info.
DATE=${STRINGFROMLOG:0:15}
UNIXDATE=$(date --date "$DATE" +%s)
NOW=$(date +%s)
TIMEDIFF=$(($NOW-$UNIXDATE))
if [ "$TIMEDIFF" -gt "10" ] # if the current date/time and the date/time from the log are more that 10s apart, then the log updated from something other than an incoming call. exit.
then exit
fi
NAME=$(sed "s/.*'\(.*\)'[^']*$/\1/" <<< $STRINGFROMLOG) # strip out the name between the single quotes
NAMEFORCURL=${NAME// /%20} # curl command doesn't like spaces so use %20 instead
NUMBER=$(sed 's/.*\ //' <<< $STRINGFROMLOG) # gets all characters after the last space (i.e., the number)
####################
## XBMC Portion ##
####################
MIDDLE='","message":"'
END='"\},"displaytime":'$XBMCPOPUPDURATION',"id":1\}'
for i in ${XBMCIPs[@]}; do
START='http://'$IPADDRESSSTART${i}':'$XBMCPORT'/jsonrpc?request=\{"jsonrpc":"2.0","method":"GUI.ShowNotification","params":\{"title":"'
URL=$START$NAMEFORCURL$MIDDLE$NUMBER$END # assemble the URL string for curl
curl --request GET $URL # send the notification request to xbmc
done
####################
## YAC Portion ##
####################
START="@CALL"
MIDDLE="~"
for i in ${YACIPs[@]}; do
MESSAGE=$START$NAME$MIDDLE$NUMBER # assemble the message string for netcat
echo $MESSAGE| nc -w 1 $IPADDRESSSTART${i} $YACPORT # send the message to the YAC Listeners
done
exit 0Change the configuration section of the script as required. Enable the webserver (Settings>Services>Webserver>Allow control of XBMC via HTTP) in xbmc. Install YAC on any computers you want Caller ID notification and put a YAC Listener shortcut in your start folder. If you have passwords set up in the xbmc webserver, you'll need to modify the START variable in the xbmc section accordingly (i.e., 'http://' becomes 'http://username:password@'.
Make the script executable:
sudo chmod 777 ~/YourScript.shMy syslog is going to /var/log/obi202.log. configure rsyslog to write the log file there:
sudo touch /var/log/obi202.log
sudo nano /etc/rsyslog.conf
->Add the following:
#
# Log from OBI202
#
local7.* /var/log/obi202.log
Add the '-r" switch as shown below:
sudo nano /etc/default/rsyslog
->change the last line to: RSYSLOGD_OPTIONS="-c5 -r"I changed ownership of the file while testing. I think you'll need to also, but I'm not sure. It doesn't hurt:
sudo chown yourusername:yourusername /var/log/obi202.logRotate the log occasionally so it doesn't get too big:
sudo nano /etc/logrotate.d/obi202.log
->Add the following:
/var/log/obi202.log monthly
{
rotate 4
missingok
notifyempty
compress
create }restart rsyslog:
sudo service rsyslog restartChange the ownership and permissions of the lockfile:
sudo chown yourusername:yourusername callerid-lockfile
sudo chmod 777 callerid-lockfileI monitor the log file and launch the script using incron:
sudo apt-get install incron
sudo nano /etc/incron.allow
->Add this: root
sudo incrontab -e
->Add this: /var/log/obi202.log IN_MODIFY /bin/bash /home/yourusername/YourScript.shI think that's everything. With the exception of the script, much of that was from memory or some simple notes. So I hope I got it all.
Enjoy!
