MLCallerID Plugin

From Cinemar Wiki
Jump to: navigation, search

Welcome to the MLCallerID Version 3 Plugin. This Plugin will create variables that enables MainLobby clients to display CallerID information.

For version 3.0.224 or later.


Requirements

•MLServer 3

•A compatible modem, Best Data 56k v.92/v.44 (#56HP) PCI Windows Internal Modem

•Or, NetCallerID hardware and MLNetCallerID Plugin

•MainLobby 3


Description

Most phone services provide telephone number and caller informtion with each call. A phone modem or NetCallerID can extract this data. The MLCallerID plugin can record this data and allows for mapping of the phone number to a caller's name that is maintained in the MLCallerID database.

Here is how the communication works:

Telephone company > Incoming phone call > CallerID data > Modem (on PC com port) > MLCallerID plugin > MLCallerID database > MainLobby3 Client


When you use the NetCallerID hardware and MLNetCallerID plugin instead of the Modem, here is the data chain:

Telephone company > Incoming phone call > CallerID data > NetCallerID hardware > PC Serial port > MLNetCallerID plugin > MLCallerID Plugin > MLCallerID database > MainLobby3 Client


Getting Started

Choose whether you will be using a Modem, or a NetCallerID hardware. If NetCallerID hardware, see MLNetCallerID Plugin

If using a modem, install the modem with the latest drivers for your operating system. Note what comport the modem is installed to.


Installation

1. Shutdown MLServer 3

2. Download and run the MLCallerID_Plugin.exe file on the Primary MLServer 3 PC

3. Start the MLServer 3 application.

4. Open the Plugins window and make sure that the MLCallerID plugin is Enabled. If not, select it and restart MLServer 3


Setup

1. Start MLServer if not already started.

2. Right click on MLCallerID plugin and click on Settings

3. If you are using MLCallerID with a PC modem ((Recommended model: US Robotics USR5633ACCS USB, Best Data 56k v.92/v.44 (#56HP) PCI Windows Internal Modem), then make sure the modem is installed properly with it’s software driver, and select the modem com port in the MLCallerID com port drop down. Click Connect on Startup.

4. If you are using a MLNetCallerID plugin and NetCallerID hardware in place of the modem DO NOT Select Connect on Startup. This is because the MLNetCallerID plugin will be talking to the NetCallerID assigned comport and sending the data directly to MLCallerID.

5. Echo is normally On, Flow Control is normally Xon/RTS, connection preferences are normally 8,None, 1. Click the Power On Startup box.


Importing Aliases from previous versions of MLCallerID

1. Open the MLCallerId plugin.

2. Click on the Aliases tab at the top.

3. Click on the Import button on the right side.

4. All of your aliases should now be in the list.


Adding an Alias

1. Open the MLCallerId plugin.

2. Click on the Aliases tab at the top.

3. Click the Add button on the right.

4. Enter the alias information in the popup window and click OK.

5. The new alias should now be in the list.


Editing an Alias

1. Open the MLCallerId plugin.

2. Click on the Aliases tab at the top.

3. Select the alias you wish to edit from the alias list

4. Click the Edit button on the right

5. Enter the new alias information in the popup window and click OK.


Deleteing an Alias

1. Open the MLCallerId plugin.

2. Click on the Aliases tab at the top.

3. Select the alias you wish to delete from the alias list

4. Click Delete on the right.

5. This should popup a window asking if you would like to remove the image associated with the alias as well. Make your selection.

6. The alias is now removed.


Testing an Alias

1. Open the MLCallerID plugin.

2. Click on the Aliases tab at the top.

3. Select the alias you wish to test form the list of aliases.

4. Click on the Test button on the right.

5. Verify that the information has been added to the call log by clicking on the Call Log tab at the top. The alias information should be the first one in the list.

6. Verify that the following MLServer varaibles where set:

mlcallerid_id

mlcallerid_time

mlcallerid_date

mlcallerid_day

mlcallerid_completename

mlcallerid_companyname

mlcallerid_newcalls

mlcallerid_totalcalls


Clear the call log

1. Open the MLCallerID plugin.

2. Click on the Call Log tab at the top.

3. Click on the Clear All button on the right.


Mark a call as viewed

1. Open the MLCallerID plugin.

2. Click on the Call Log tab at the top.

3. Click the check box next to the call you wish mark as viewed.

4. The call has now been marked as viewed


Delete a call from the call log

1. Open the MLCallerID plugin.

2. Click on the Call Log tab at the top.

3. Select the call you wish to delete from the call list.

4. Click on the Delete button on the right.


Change the image to show for known callers with no image

1. Open the MLCallerID plugin.

2. Click on the Image Settings tab at the top.

3. Click the browse button next to the text box for the known caller image.

4. Navigate to and select the image you wish to use.

5. Enter the width and height you would like the image to be.

6. Click Save Changes.

Note: The width and height you enter on this screen will determine the size that all images are saved as.


Change the image to show for private

1. Open the MLCallerID plugin

2. Click on the Image Settings tab at the top.

3. Click the browse button next to the text box for the private caller image.

4. Navigate to and select the image you wish to use.

5. Enter the width and height you would like the image to be.

6. Click Save Changes.

Note: The width and height you enter on this screen will determine the size that all images are saved as.


Change the image to show for unknown callers

1. Open the MLCallerID plugin

2. Click on the Image Settings tab at the top.

3. Click the browse button next to the text box for the unknown caller image.

4. Navigate to and select the image you wish to use.

5. Enter the width and height you would like the image to be.

6. Click Save Changes.

Note: The width and height you enter on this screen will determine the size that all images are saved as.


CallerID images should be created at 480x640 for optimimum resolution


MLCallerID Supported Commands

MLCallerID|Power

{MLServeCmd}Script Usage

MLServeCmd.MLCallerID|Power (Literal)

MLServeCmd.MLCallerID|Power

Parameters None.

Returns Nothing.

Description This command turns the power of to the callerid plugin. This stops the on call command from being fired when you receive a call


MLCallerID|FirstCaller

{MLServeCmd}Script Usage

MLServeCmd.MLCallerID|FirstCaller (Literal)

MLServeCmd.MLCallerID|FirstCaller

Parameters None

Returns Nothing.

Description Sets MLServer variables for the first caller in the list.


MLCallerID|LastCaller

{MLServeCmd}Script Usage

MLServeCmd.MLCallerID|LastCaller

(Literal) MLServeCmd.MLCallerID|LastCaller

Parameters None

Returns Nothing

Description Sets MLServer variables for the last caller in the list.

Notes


MLCallerID|Next

{MLServeCmd}Script Usage

MLServeCmd.MLCallerID|Next

(Literal) MLServeCmd.MLCallerID|Next

Parameters None

Returns Nothing


Description Sets MLServer variables for the next call in the list relative to the current caller being displayed.

Notes


MLCallerID|Previous

{MLServeCmd}Script Usage

MLServeCmd.MLCallerID|Previous

(Literal) MLServeCmd.MLCallerID|Previous

Parameters None

Returns Description Sets MLServer variables for the previous call in the list relative to the current caller being displayed.

Notes


MLCallerID|Delete

{MLServeCmd}Script Usage

MLServeCmd.MLCallerID|Delete~Call #

(Literal) MLServeCmd.MLCallerID|Delete~3 MLServeCmd.MLCallerID|Delete~1

Parameters Call # = The id of the call.

Returns Nothing

Description Deletes the specified call from the call log.

Notes


MLCallerID|FirstPage

{MLServeCmd}Script Usage

MLServeCmd.MLCallerID|FirstPage (Literal)

MLServeCmd.MLCallerID|FirstPage

Parameters None

Returns Nothing.

Description Sets the MLServer variables for the first page of callers. The number of callers per page is determined by user settings.

Notes


MLCallerID|LastPage

{MLServeCmd}Script Usage

MLServeCmd.MLCallerID|LastPage

(Literal) MLServeCmd.MLCallerID|LastPage

Parameters None

Returns Nothing.

Description Sets the MLServer variables for the last page of callers. The number of callers per page is determined by user settings.

Notes


MLCallerID|NextPage

{MLServeCmd}Script Usage

MLServeCmd.MLCallerID|NextPage

(Literal) MLServeCmd.MLCallerID|NextPage

Parameters None

Returns Nothing.

Description Sets the MLServer variables for the next page of callers. The number of callers per page is determined by user settings. This command works in a circular fashion; if you are on the last page of callers and issue this command it will go back to the first page of callers.

Notes


MLCallerID|PreviousPage

{MLServeCmd}Script Usage

MLServeCmd.MLCallerID|PreviousPage

(Literal)

MLServeCmd.MLCallerID|PreviousPage

Parameters None

Returns Nothing.

Description Sets the MLServer variables for the previous page of callers. The number of callers per page is determined by user settings. This command works in a circular fashion, if you are on the first page of callers and issue this command it will go back to the last page of callers.

Notes


MLCallerID|ClearLog

Starting with MLCallerID plugin version 3.0.224

{MLServeCmd}Script Usage

MLServeCmd.MLCallerID|ClearLog

(Literal)

MLServeCmd.MLCallerID|ClearLog

Parameters

None

Returns: Nothing.

Description: Clears the Call Log

Notes


MLCallerID MLServer Variables

The MLCallerID plugin will auto generate variables in MLServer based on the settings you have entered. It will also update and create variables based on certain modem events. If possible all variables are set on startup.

Mlcallerid_power

mlcallerid_active_page

mlcallerid_pagetotal

mlcallerid_lastcall_id_###

mlcallerid_lastcall_date_###

mlcallerid_lastcall_day_###

mlcallerid_lastcall_image_###

mlcallerid_lastcall_name_###

mlcallerid_lastcall_companyname_###

mlcallerid_lastcall_telephonenumber_###

mlcallerid_lastcall_time_###

mlcallerid_page_id_###

mlcallerid_page_date_###

mlcallerid_page_day_###

mlcallerid_page_name_###

mlcallerid_page_companyname_###

mlcallerid_page_time_###

mlcallerid_page_telephonenumber_###

mlcallerid_page_image_###

NOTE:


Extra:


Allows capture of telephone caller name, number, time of call and picture of caller (if setup). Homeseer can also send the caller ID information to the plugin.

MLServeCMD.MLCallerID|SendCID:Name~Number

hs.plugin("MLHSPlugin").MLServeCMD "MLServeCmd.MLCallerID|SendCID:" & cstr(CallName) & "~" & cstr(CallNMBR)

Must have at least one caller ID setup.


Bugs

Feature Requests

Ability to click a button and make the last call a Alias to simplify adding one. (GregoryX)

Integration with MLPhoneBook via contacts.mdb


Release Notes

Current Release: 3.0.239.0