TR-064 Thing Action phonebookLookup not working

Tallman · January 9, 2021, 2:43pm

Despite the current version, the Ruhle does not work as it should.
In the string anruferNummer or angerufeneNummer there is not only one phone number but both separated by commas. So they cannot be resolved by the phone belly.
How can you split the string into two separate phone number strings?

mstehle · January 9, 2021, 2:51pm

Hi,

I do it like this:

	var String ownNumber = ""
	var String extPartyNumber = ""

	logInfo("CALL:", "Incoming call: Getting caller name and number...")
	ownNumber = (fboxIncomingCall.state as StringListType).getValue(0) // get own number called
	extPartyNumber = (fboxIncomingCall.state as StringListType).getValue(1) // get caller number

Then you can use the extPartyNumber to resolve the Name.

var String callerName = tr064Actions.phonebookLookup(extPartyNumber, 8) // if no matching entry is found, number is returned

Tallman · January 9, 2021, 4:29pm

Thanks for the solution, it works.

Juschi66 · January 9, 2021, 5:25pm

Hi, could you please also post the items?

Thanks

mstehle · January 9, 2021, 5:43pm

sure:
Call fboxActiveCall “Acive call: [%1$s]” { channel=“avmfritz:fritzbox:UID:active_call” }
Call fboxIncomingCall “Incoming call: [%2$s to %1$s]” { channel=“avmfritz:fritzbox:UID:incoming_call” }
Call fboxOutgoingCall “Outgoing call: [%2$s to %1$s]” { channel=“avmfritz:fritzbox:UID:outgoing_call” }

cweitkamp · January 9, 2021, 5:43pm

Hi,

Beside the lookupPhonebook actions the TR-064 binding provides a profile which does the math for you. See my example

mstehle · January 9, 2021, 5:55pm

Hi Christoph,

even easier, thanks for sharing

Matt

cweitkamp · January 9, 2021, 6:02pm

You are welcome.

That is what profiles are made for: reducing the number of rules and the effort to get them running.

schup011 · January 10, 2021, 9:41pm

Thanks guys.
Yes, I still had to decompose the string generated from the incoming_call CALL item. In the meanwhile, I have done that.
But, besides from being new to JSR223, I am not sure whether I understood Christphs example correctly. I see the TR064 actions also there, so what is the profile for?

Chrishab · January 11, 2021, 1:50pm

This is how I have done it:

Thing channel: avmfritz:fritzbox:192_168_0_1:incoming_call
Linked item: FRITZBox7560IncomingCall_Resolved
Profile: Phonebook

Then new settings show up: “Profile Configuration”
Here I can select the “Phone Number Index” = 1 (0 = my number, 1 = caller-number)

My rule (script-part):

val telegramAction = getActions("telegram","telegram:telegramBot:xxx")
logInfo("Fritzbox", "Incoming Call: " +FRITZBox7560IncomingCall_Resolved.state)
telegramAction.sendTelegram("☎️ Incoming Call @home: %s",FRITZBox7560IncomingCall_Resolved.state)

Not sure if this is the correct way, but it works

muelli1967 · January 14, 2021, 8:43am

sometimes it is too easy. works perfect with me as well-. No rules needed for phonebook lookup beside that I rule the last caller into an item so that it is saved until the next call comes. Thanks Christian.

schup011 · January 14, 2021, 8:27pm

OK, this nearly works for me.

I define the item via UI, String item, phonebook profile, I can select the phonebook. Now there is one remaining problem: It resolves correctly the name, but tells in the log:

Exception while formatting value 'Philipp' of item FRITZBox_AusgehenderAnruf with format '%1$s to %2$s': Format specifier '%2$s'

I have not defined this format specifier, somehow it seems to have been predefined.

(If I define a Call item from the same channel, without phonebook profile, it correctly shows “phonenumber1 to phonenumber2”.)

I am using OH 3.0 Stable. Should I update to 3.1 Snapshot?

muelli1967 · January 14, 2021, 9:25pm

I updated the binding to 3.1.0, ( deleted the binding from OH3 and placed the snapshot 3.1.0 jar file to addons )

can you double check that your item is really a string? I struggled with that as well and I created a call item by mistake first.
i have added meta data to my string item, state description pattern %s . Not sure if this solves the issue

schup011 · January 14, 2021, 11:18pm

The meta data state description %s did the trick! Is working now, still with avmfritz 3.0.0.
Thank you!

maihacke · January 21, 2021, 4:42pm

I might have discovered a bug. I tried the following item definition

Call Fritz_Incoming_Call “Anrufende Nummer [$1$s an %2$s]” { channel=“avmfritz:fritzbox:192_168_178_1:incoming_call” [profile=“transform:PHONEBOOK”, phonebook=“dca2683d47:Google”, phoneNumberIndex=1]}

This gives following error:

Cannot initialize PHONEBOOK transformation profile: UID must have at least 3 segments… Profile will be inactive.

Setting the item definition to

Call Fritz_Incoming_Call “Anrufende Nummer [$1$s an %2$s]” { channel=“avmfritz:fritzbox:192_168_178_1:incoming_call” [profile=“transform:PHONEBOOK”, phonebook=“tr064:fritzbox:dca2683d47:Google”, phoneNumberIndex=1]}

Cannot initialize PHONEBOOK transformation profile: Cannot split ‘phonebook’ parameter. Profile will be inactive.

I think the problem is in PhonebookProfile.java. If I understood correctly it tries to parse the thing UID from the phonebook param. But it splits the param by : Since the thinguid itself contains : this won’t work.

gittyhub2 · January 25, 2021, 11:23pm

Here’s how I finally got it to work: when looking at the “comprehensive example”, don’t get distracted by the <PHONEBOOK_NAME> voodoo.

When your name for the Thing (Bridge) is

tr064:fritzbox:1

then your PHONEBOOK profile in your item must be exactly the same name, just with the colons URL-encoded (3A), so it should say

[profile="transform:PHONEBOOK", phonebook="tr064_3Afritzbox_3A1"]

So, full example would be:

tr064.things

Bridge tr064:fritzbox:1 "FRITZ!Box 7590" [
    host="fritz.box", 
    user="USER",
    password="PASSWORD",
    phonebookInterval="86400"
    ]

avm.items

// Call Monitor Equipment

Group gCALLMONITOR "Call Monitor" ["Equipment"]

Call fritzIncomingCall "Incoming Call [from %2$s to %1$s]" (gCALLMONITOR) ["Status"] { channel="avmfritz:fritzbox:1:incoming_call" }

Call fritzActiveCall "Active Call [from %1$s]" (gCALLMONITOR) ["Status"] { channel="avmfritz:fritzbox:1:active_call" }

Call fritzOutgoingCall "Outgoing Call [from %2$s to %1$s]" (gCALLMONITOR) ["Status"] { channel="avmfritz:fritzbox:1:outgoing_call" }

String fritzCallRinging "Status [%s]" (gCALLMONITOR) ["Status"] { channel="avmfritz:fritzbox:1:call_state" }

// resolved numbers (only if TR-064 binding is installed)

String fritzIncomingCallCallee "Incoming Call - Callee [%s]" (gCALLMONITOR) ["Status"] { channel="avmfritz:fritzbox:1:incoming_call" [profile="transform:PHONEBOOK", phonebook="tr064_3Afritzbox_3A1"] }

String fritzIncomingCallCaller "Incoming Call - Caller [%s]" (gCALLMONITOR) ["Status"] { channel="avmfritz:fritzbox:1:incoming_call" [profile="transform:PHONEBOOK", phonebook="tr064_3Afritzbox_3A1", phoneNumberIndex=1, matchcount="8"] }

String fritzActiveCallCaller "Active Call - Caller [%s]" (gCALLMONITOR) ["Status"] { channel="avmfritz:fritzbox:1:active_call" [profile="transform:PHONEBOOK", phonebook="tr064_3Afritzbox_3A1"] }

String fritzOutgoingCallCallee "Outgoing Call - Callee [%s]" (gCALLMONITOR) ["Status"] { channel="avmfritz:fritzbox:1:outgoing_call" [profile="transform:PHONEBOOK", phonebook="tr064_3Afritzbox_3A1"] }

String fritzOutgoingCallCaller "Outgoing Call - Caller [%s]" (gCALLMONITOR) ["Status"] { channel="avmfritz:fritzbox:1:outgoing_call" [profile="transform:PHONEBOOK", phonebook="tr064_3Afritzbox_3A1", phoneNumberIndex=1, matchcount="8"] }

I appreciate the work put in this, but the existing documentation for caller number lookup is a complete guessing game.

And the README.md description in the binding is misleading. In the Bridge definition the term

tr064:fritzbox:rootuid

is used, and in the Item definition the example provided is

phonebook="tr064_3Afritzbox_3AfritzboxTR064"

With rootuid and fritzboxTR064, this will not work.

Intenos · January 26, 2021, 3:01pm

Hi Alexander,

Thanks for finding this out as well as describing it so detailed. With having this change applied, I also don´t get any failure message anymore and the items are responding well. But it always shows me the telephone number, not a name.

Did you test it with the standard binding of openHAB 3.0 or a 3.1 snapshot?

And is it OK to have a space in the phonebook name or might this limit the binding to look into it? As I understood with the code you stated it should look in all ponebooks, or?

gittyhub2 · January 26, 2021, 8:46pm

Hi Tobias,

here’s my log - getting the names from numbers.

Call initiation (outbound):

2021-01-26 20:52:38.290 [INFO ] [openhab.event.ItemStateChangedEvent ] - Item 'fritzOutgoingCall' changed from UNDEF to 012345678,0987654321

2021-01-26 20:52:38.290 [INFO ] [openhab.event.ItemStateChangedEvent ] - Item 'fritzOutgoingCallCaller' changed from UNDEF to Doe John

2021-01-26 20:52:38.290 [INFO ] [openhab.event.ItemStateChangedEvent ] - Item 'fritzOutgoingCallCallee' changed from UNDEF to Miller Jane

2021-01-26 20:52:38.290 [INFO ] [openhab.event.ItemStateChangedEvent ] - Item 'fritzCallRinging' changed from IDLE to DIALING

2021-01-26 20:52:49.796 [INFO ] [openhab.event.ItemStateChangedEvent ] - Item 'fritzActiveCall' changed from UNDEF to 012345678,

2021-01-26 20:52:49.796 [INFO ] [openhab.event.ItemStateChangedEvent ] - Item 'fritzActiveCallCaller' changed from UNDEF to Miller Jane

2021-01-26 20:52:49.796 [INFO ] [openhab.event.ItemStateChangedEvent ] - Item 'fritzOutgoingCall' changed from 012345678,09876543211 to UNDEF

2021-01-26 20:52:49.796 [INFO ] [openhab.event.ItemStateChangedEvent ] - Item 'fritzOutgoingCallCaller' changed from Doe John to UNDEF

2021-01-26 20:52:49.797 [INFO ] [openhab.event.ItemStateChangedEvent ] - Item 'fritzOutgoingCallCallee' changed from Miller Jane to UNDEF

2021-01-26 20:52:49.797 [INFO ] [openhab.event.ItemStateChangedEvent ] - Item 'fritzCallRinging' changed from DIALING to ACTIVE

and hanging up:

2021-01-26 21:05:52.563 [INFO ] [openhab.event.ItemStateChangedEvent ] - Item 'fritzActiveCall' changed from 0621896949, to UNDEF
2021-01-26 21:05:52.563 [INFO ] [openhab.event.ItemStateChangedEvent ] - Item 'fritzActiveCallCaller' changed from Miller Jane to UNDEF
2021-01-26 21:05:52.563 [INFO ] [openhab.event.ItemStateChangedEvent ] - Item 'fritzCallRinging' changed from ACTIVE to IDLE

I’m on standard 3.0 binding:

openhab> bundle:list | grep TR-064
250 │ Active │  80 │ 3.0.0                   │ openHAB Add-ons :: Bundles :: TR-064 Binding

The example code in post #19 should to my best knowledge use all phonebooks available.

If you have a “space” character in your phonebook’s name, try substituting this (if you select it at all…) with _20, like in Google_20Telefonbuch. But you should not have to do this as the items (as shown above) can be used directly in rules, without translation.

gittyhub2 · January 26, 2021, 9:53pm

Bonus: rules to push the identified caller name / numbers via pushover binding:

fritzbox.rules

rule "Incoming Call"
when
    Item fritzCallRinging changed to RINGING 
then
    // dissect the calling numbers with avmfritz binding

    val incCall = fritzIncomingCall.state as StringListType
    val ourNumber = incCall.getValue(0)
    val callerNumber = incCall.getValue(1)

    // do something with callerNumber
    val actions = getActions("pushover", "pushover:pushover-account:account")	
    var String msg = "Eingehender Anruf: " + fritzIncomingCallCaller.state + " (" + callerNumber + ") auf " + ourNumber
    logInfo("FRITZ!Box", msg)
	actions.sendMessage(msg, "openHAB")
end

rule "Outgoing Call"
when
    Item fritzCallRinging changed to DIALING 
then
    // dissect the calling numbers with avmfritz binding

    val outCall = fritzOutgoingCall.state as StringListType
 
    var String calledNumber = outCall.getValue(0)
    var String ourNumber = outCall.getValue(1)
 
    val actions = getActions("pushover", "pushover:pushover-account:account")	
    var String msg = "Ausgehender Anruf: " + fritzOutgoingCallCallee.state + " (" + calledNumber + ") über " + ourNumber
    logInfo("FRITZ!Box", msg)
	actions.sendMessage(msg, "openHAB")
end

rule "Connection established - outgoing"
when
    Item fritzCallRinging changed from DIALING to ACTIVE
then
    logInfo("FRITZ!Box", "Outgoing call: Connection established")
end

rule "Connection established - incoming"
when
    Item fritzCallRinging changed from RINGING to ACTIVE
then
    logInfo("FRITZ!Box", "Incoming call: Connection established")
end


rule "Connection dropped"
when
    Item CallStatfritzCallRinging changed from ACTIVE to IDLE
then
    logInfo("FRITZ!Box", "Active call: Connection dropped")
end

Intenos · January 27, 2021, 2:54pm

Hi Alexander,

I tried several things, but still don´t get any name.

What I changed/resolved:

By reading in the phonebook, a warning was raised “Scheduled runnable ended with an exception: java.lang.IllegalStateException: Duplicate key …”
I removed the empty space in the name of the phonebook in the Fritz!Box
I changed “matchCount” into “matchcount” as I found this difference compared to your example. But actually with “machtcount” it didn´t show me the defined value in the UI, therefore I changed it back. Also in this regard, I added the quotes to the number, but thereby I did also not get it working
I activated the DEBUG logging for the TR-064 binding. It proves me the following info “Number ‘’ not found in phonebook ‘null’ from provider ‘tr064:fritzbox:1’”. Does this tell that it can´t refer to a phonebook?
When I set the binding to TRACE logging, I can see that it retrieves the list of calls with all the names