Home Automation Domotica Forum Europe, Bwired Forum

Code: Select all

' Gambas class file

' Description:
' FritzBox.class
' Provide support for Fritz!Box call monitoring. (via call log port)

' Development Status:
' Just started to build this one.
' Incoming call detection and Voicebox status implemented.
' Tested with Fritz!Box 7170 Annex A running Firmware 58.x.57

' DomotiGa - an open source home automation program.
' Copyright(C) 2008 Ron Klinkien

' Read file called COPYING for license details.

PROPERTY TCPHost AS String
PROPERTY FritzBoxDebug AS Boolean

PRIVATE sTCPHost AS String
PRIVATE bFritzBoxDebug AS Boolean

PUBLIC hFritzBox AS NEW Socket

'~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
' connect to the host:port
'~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
PUBLIC FUNCTION Connect() AS Boolean

  ' try to close the connection
  TRY hFritzBox.Close

  ' get a new one
  hFritzBox = NEW Socket AS "FritzBox"
  hFritzBox.Connect(sTCPHost, 1012)

  ' all ok
  RETURN TRUE

CATCH ' some errors
  Main.WriteLog("Fritz!Box Error: " & ERROR.Text)
  RETURN FALSE

END

PUBLIC SUB FritzBox_Ready()

  Main.WriteLog("Fritz!Box TCP socket connected.")

END

'~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
' disconnect from the host
'~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
PUBLIC FUNCTION Disconnect() AS Boolean

  ' try to close the connection
  TRY hFritzBox.Close
  Main.WriteLog("Fritz!Box TCP socket port close.")

  ' all ok
  RETURN TRUE

CATCH ' some errors
  Main.WriteLog("Fritz!Box Error: " & ERROR.Text)
  RETURN FALSE

END

PRIVATE SUB ParseLine(sStr AS String)

  DIM aScan AS String[]
  DIM rResult AS Result
  DIM iId AS Integer

  ' 20.01.09 20:29:10;RING;0;XXXXXXXXX;;POTS;
  IF InStr(sStr, ";RING;") THEN
    aScan = Scan(sStr, "*;RING;*;*;;*;")
    IF Main.bFritzBoxDebug THEN
       Main.WriteDebugLog("[Fritz!Box] Incoming call from " & aScan[2] & " on line " & aScan[3])
    END IF
    ' write data to cdr table
    Main.hDB.Begin()
    rResult = Main.hDB.Create("cdr")
    rResult!calldate = Now()
    rResult!clid = aScan[2]
    rResult!src = aScan[2]
    rResult!dcontext = "incoming"
    rResult!channel = aScan[3]
    rResult!disposition = "NO ANSWER"
    rResult.Update()
    Main.hDB.Commit()
  END IF
  ' 20.01.09 20:29:19;CONNECT;0;0;XXXXXXXXX;
  IF InStr(sStr, ";CONNECT;") THEN
    aScan = Scan(sStr, "*;CONNECT;*;*;*;")
    IF Main.bFritzBoxDebug THEN
      Main.WriteDebugLog("[Fritz!Box] Call to/from " & aScan[3] & " answered")
    END IF
    rResult = Main.hDB.Exec(Subst("SELECT * FROM cdr WHERE clid = &1 ORDER BY calldate DESC LIMIT 1", aScan[3]))
    IF rResult THEN
      IF rResult.Count THEN
        iId = rResult!id
        rResult = Main.hDB.Exec("UPDATE cdr SET disposition = 'ANSWERED', calldate = &1 WHERE id = &2", Now(), iId)
      END IF
    END IF
  END IF
  ' 20.01.09 20:50:11;DISCONNECT;0;1253;
  IF InStr(sStr, ";DISCONNECT;") THEN
    aScan = Scan(sStr, "*;DISCONNECT;*;*;")
    IF Main.bFritzBoxDebug THEN
      Main.WriteDebugLog("[Fritz!Box] Call duration was " & aScan[2] & " seconds")
    END IF
    rResult = Main.hDB.Exec("SELECT * FROM cdr ORDER BY calldate DESC LIMIT 1")
    IF rResult THEN
      iId = rResult!id
      rResult = Main.hDB.Exec("UPDATE cdr SET duration = &1, billsec = &1 WHERE id = &2", aScan[2], iId)
    END IF
  END IF
  ' 20.01.09 22:28:50;CALL;0;0;;0XXXXXXXXX;POTS;
  IF InStr(sStr, ";CALL;") THEN
    aScan = Scan(sStr, "*;CALL;*;*;*;*;*;")
    IF Main.bFritzBoxDebug THEN
      Main.WriteDebugLog("[Fritz!Box] Outgoing call to " & aScan[4] & " with line " & aScan[5])
    END IF
    ' write data to cdr table
    Main.hDB.Begin()
    rResult = Main.hDB.Create("cdr")
    rResult!calldate = Now()
    rResult!clid = aScan[4]
    rResult!dst = aScan[4]
    rResult!dcontext = "default"
    rResult!channel = aScan[5]
    rResult!disposition = "NO ANSWER"
    rResult.Update()
    Main.hDB.Commit()
  END IF

END

PUBLIC SUB FritzBox_Error()

  ' handle error
  SELECT CASE hFritzBox.Status
    CASE Net.CannotCreateSocket
      Main.WriteLog("Fritz!Box: The system does not allow to create a socket.")
    CASE Net.HostNotFound
      Main.WriteLog("Fritz!Box: Host not found.")
    CASE Net.ConnectionRefused
      Main.WriteLog("Fritz!Box: Unable to connect. Connection refused.")
    CASE Net.CannotRead
      Main.WriteLog("Fritz!Box: Error reading data.")
    CASE Net.CannotWrite
      Main.WriteLog("Fritz!Box: Error writing data.")
  END SELECT

END

PUBLIC SUB FritzBox_Read()

  DIM sData AS String

  IF hFritzBox.Status = Net.Connected THEN
    LINE INPUT #hFritzBox, sData
    IF Main.bFritzBoxDebug THEN Main.WriteDebugLog("[Fritz!Box] " & sData)
    ParseLine(sData)
  END IF

END

' implement properties
PRIVATE FUNCTION TCPHost_Read() AS String

  RETURN sTCPHost

END

PRIVATE SUB TCPHost_Write(Value AS String)

  sTCPHost = Value

END

PRIVATE FUNCTION FritzBoxDebug_Read() AS Boolean

  RETURN bFritzBoxDebug

END

PRIVATE SUB FritzBoxDebug_Write(Value AS Boolean)

  bFritzBoxDebug = Value

END