diff --git a/README.md b/README.md new file mode 100644 index 0000000..074bf84 --- /dev/null +++ b/README.md @@ -0,0 +1,61 @@ +# Yealink Dialer +This utility provides a interface for handling CALLTO links and forwarding them to Yealink SIP Phones.
+ +![image](https://github.com/DJFPaul/yealink_dialer/assets/35642602/868973ba-d89e-45eb-b88a-e67ee1ad97fd) +
+
+# How to use +Download the latest version from Releases.
+https://github.com/DJFPaul/yealink_dialer/releases
+
+Unzip folder to a directory of choice.
+It is recommended not to use a directory that required admin write permissions.
+If you choose such, you will need to launch the utility as admin when ever you change settings.
+
+To registers the application for the first time, run `register.bat`.
+ +![image](https://github.com/DJFPaul/yealink_dialer/assets/35642602/d146a6ff-914f-4717-aea5-1f7a56bba78f) +
+This will setup all nesseary registry entries to handle the callto links
+If you ever move the folder, run this again to update the paths.
+
+After running register.bat, Yealink Dialer should open it self.
+When launching the application without a callto link, it will present the cofing interface.
+ +![image](https://github.com/DJFPaul/yealink_dialer/assets/35642602/0079859b-43bb-420e-8a45-8b1c9a188362) +
+Change these settings to reflect the correct settings of your Yealink device.
+
+`PHONEIP` Specify the IP of the YeaLink Phone that the calls should be dialed with.
+`SIPACCOUNT` Specify the SIP account the call should be made with. The format is USERNAME@SIPSERVERIP
+`USERNAME` The username used to login to your Yealink phone's web interface.
+`PASSWORD` The password used to login to your Yealink phone's web interface.
+
+You can now hit save.
+
+For this utility to work, you need to enable the CSTA control on your Yealink Device.
+You can find it here.
+ +![image](https://github.com/DJFPaul/yealink_dialer/assets/35642602/0dfcd5dd-3de8-424e-99c6-eb58cade41d5) +
+You can either specify your PC IP and limit it to just you, or use a wildcards in the IP field.
+
+After this step is done, you can hit the test button.
+It will ask you to confirm the test and will try to make a call to 012345767890 once you do.
+The first time you do this, or when ever you change the CSTA settings, your Yealink Phone will ask you for permission.
+Look at your phones screen and confirm that you want to allow remote access.
+
+If you do not see any message on your Yealink Device, and it does not dial anything, check your settings again.
+
+If everything is setup correctly, you should now be able to click on callto: and tel: links and it should open up Yealink Dialer.
+ +![image](https://github.com/DJFPaul/yealink_dialer/assets/35642602/868973ba-d89e-45eb-b88a-e67ee1ad97fd) +
+ +# Optional Options +In the data folder, you can find a `config.ini` with some additional options.
+
+`autoclose=true` The dial window will auto close after a set time.
+`closedelay=8` Specifies the delay after which to auto close.
+`autodial=false` Setting this to true will automatically try to call any number you click.
+`dialdelay` Specifies the time to way until autodial will forward the call request.