COM API

Andy Bell said:

What I haven't got my head around is opening a resource, say a Bible, at a particular place - Book, chapter and verse. Also, can the API be used to issue commands - Update Now, Update Resources, etc?

Anyone worked these out yet?

Andy,

Sorry for the delay. I was going to send an answer earlier, but then forgot about it when something else got my attention.

Well, I'm still learning what works well, and have been focused on other non-Logos portions of what I need to get working.

Firstly, print out the current COM API docs if you like working off paper. Also have a look at the sample that Bradley wrote up. It gives a few good hints, but I don't know if its static, or if its had updates. I've not been back to look.

There are a few ways to open something to specific locations. The simple way is to open something manually, paste the link into a word doc, and then use that as a starter for some code. This aspect does not even need the COM API. You could just make calls to the Windows Shell API.

However, using the Logos4 COM API, calls to the following for example, using VIsual Basic 2010 (.NET).

Dim uri as string
uri = "logosres:esv;ref=BibleESV.Mt5.13" ' REM ESV to "SALT and LIGHT"
'uri = "logos4:Guide;t=Passage_Guide;ref=BibleESV.Jn1.1-18" REM Passage Guide on John 1:1-18
'uri = "logosres:bdag;hw=$CE$BB$CE$BF$CC$81$CE$B3$CE$BF$CF$82" ' Opens BDAG to logos
app.ExecuteUri(uri)

(Making each of these a new post, as they touch on different aspects.)

Re calling any command, such as running "Update Now" or "Rebuild Bible Index" is something I'm still unsure of. It does not seem to work as a call to the ExecuteUri, but its not a URI, so that seems fair. Not sure about passing it to the command-line, with the Launcher.LaunchApplication("Some command"), as I have not tried that one.

My hope is that one of the Logos guys might speak to this please.

J. Morris said:

Apparently the COM API is intended for more advanced users of some type...  I'll admit it all seems WAY over my head. 

Question:  What is it intended for exactly?  What will it help?

Could one of you production genius' create a video to help people like me (doubt I'm the lone wolf) see how to use it?

Its mostly for programmers creating some kind of tool or application that works with Logos Bible Software.

My hope is, that in time, Andy, myself or someone, will release little modules already built, that can be used by others.

One good idea I got from someone earlier today, is something to start a download just after 2 am, when his internet traffic is not charged for (until 7 am).

I'm also playing with getting my ESV bible in Logos4 to track along by verse, as some MP3s of the ESV play in WIndows Media Player (it works a bit so far).

All kinds of useful things might be possible. And if the COM API gets additional functions in due course, who can say what someone might think of.

Don't be surprised to see some commercial (or free) products at some time, that uses the COM API to work with Logos Bible Software, to do something interesting or useful. Maybe some kind of teaching software, or Bible Study course, where it "automatically" opens things to the right place as you work thru the course-work. I'm only guessing, but I look forward to what people might do with it once it becomes known what it can do.

Andy Bell said:

Thanks for the info - I look forward to the Navigate information - I think that's what I'm after.

Again, in VB, and only a portion of a whole "something" that might be useful.

Call this with "Gold" and it will open something with "Gold" as a Headword. Just as if you double-click "gold" in some text somewhere. In my case, it opens to an entry in the "Baker encyclopedia of the Bible".

In short, get a nav object, fill it in, use it ==> jumps to location.

The calls are all Subs, not Functions. So you get no direct feedback. Its impossible to know if something worked, except if it DOES WORK, you get events fired for the new panel if there is an open or movement. I've not messed with this part yet, but I think I can "ask" a panel where it is, and in what resource. Also, asking what panels there are, and which is the current one.

For the example here, I got:

app.Event: PanelOpened [panel.Title: Baker Encyclopedia of the Bible] [panel.Kind: Resource] [panel.LinkSet: None]

Sample code for nav to a headword in whatever resource Logos4 feels like (it uses your resource priorities)

Public Sub NavigateByHeadword(ByVal inHeadword As String)

        app = launcher.Application
        Dim nav = app.CreateNavigationRequest()
        'nav.ResourceId = "LLS:COED11"                   REM Commented out
        nav.HeadwordLanguage = "en"                       REM English
        nav.Headword = inHeadword
        app.Navigate(nav)
End Sub

Paul Davey said:

It might be a bit off-topic but it took me a while to get this working ... 

Hi Paul,

No - not off-topic in my view. Its right where it needs to be for what Andy was asking.

I'm not done much with any scripting for a while now. I used to do a lot with SVR4 Unix, and some Perl and some wscript on NT etc at one time.

Mostly, I currently mess around with VB or sometimes C#.

Your above code is a great starter for anyone wanting to script something, and using the .GetActivePanel, does not depend on the Events to get any new status.

So: VB, C#, Delphi and Windows Power Shell already ...

Hi Rosie

The thing about Powershell is that you don't need a development environment - it's just that, a shell.  It's a free download from Microsoft.  You don't compile anything, just issue commands and see if it works or not.

Just to add, the following line also works (i.e. the Bible reference has some flexibility, but must start with "Bible."

$lga.DataTypes.LoadReference("Bible.1 Kings 8:62-66")

I suggest you remove the Logos Type Library from your VS Project, then re-add it.

There might have been some changes or whatever due to updates.

See http://wiki.logos.com/How_to_Use_the_COM_API

I tested both a VB Express 2010 and VC# Express 2010 projects just now, and both compile, link and run just fine. I have Logos 4.1 Beta 2 installed.

(I'm waiting and looking forward to when they add a few more things to the COM API so we can use it for things that can't be done better or as well using the URIs. It fact, for page locations, its possible to get more power from a link than the navigation controls of the API. Most strange!!!)

Hi David,

I don't know what your error is then. I don't have the full VS 2010 product. (I used to have VS 2005 installed on an older PC, but never upgraded te licenses due to the high costs, and using it little. I try and get by on the Express products for most of my current needs.)

Consider making yourself a new Windows Form project using VB or C#, or whatever. Add the Logos Type Library, then add a single Button, and make it so that is creates the base Logos Launcher object, then starts Logos4 running.

Once you have such a project, you can compair the one that works against the one that wont link/compile and work out whats going on with the Logos type library and how they resolve. I don't know what level of Logos4, Visual Studio or programming knowledge, so don't want to make this post too complex. See how this goes, and maybe I can say more, or others might speak up too. Consider posting a screen-capture of selected bits containing the errors or messages you get. The more you can make it easy, the better someone will be able to work out whats up I guess.

In C#, this can be little more than as follows:

using System.Data;
using System.Drawing;
using System.Linq;
using System.Text;
using System.Windows.Forms;
using Logos4Lib;

namespace Logos4Tester
{
    public partial class Form1 : Form
    {
        //int X;
        //LogosApplication app;
        LogosLauncher ll;
      
        public Form1()
        {
            InitializeComponent();
        }

        private void button1_Click(object sender, EventArgs e)
        {
            ll = new LogosLauncher();
            ll.LaunchApplication();
        }
    }
}

Re the Beta, I have only used the Beta since the start, and don't have a release install at present (disk space). I do have L3 as a backup plan, but its rare to every look there.

If you need Logos4 to be as close to 100% operational, with low risk, maybe Beta is not for you. Howver, with Printing now, there are enough goodies that mostly work to make it useful. Please read the warning and caution note posted to the top of the Logos4 PC Beta forum before you consider installing it.

OK, things are working great now. I'm not sure what happened, but I typed the command 'set update channel to beta', then immediately it said it was downloading updates. But it never installed it. I type 'update now' and it said there were no updates. I check the version of my Logos software and it is still 4.0d. I went into Visual Studio and tried to add the Logos COM reference and it did it successfully.

As I am typing this a text bubble just popped up from Logos telling me I have updates. It is probably the Beta. I'm going to install it now.

Thanks for your help.

-David