AM is in desperate need of better documentation
Posted: 29 Jun 2016 20:10
While I love AM, I am often frustrated by its lack of documentation and, as importantly, examples, examples, and more examples. Please take this message as a plea for better documentation and not a rant.
Since one cannot see the flows that are discussed in the forum, it is very difficult to decrypt some of the logic.
Here are a few of the issues that I have run across lately. Some I have resolved (at a loss of some head hair) and some remain a mystery.
• The trigger “WiFi Scan Results Available,” is described this way: “The trigger WiFi Scan Results Available is executed when the results of a WiFi access point scan are available.” What does that mean? What triggers this trigger? Totally lost as to how to use this.
• Functions are found only under Actions-Script. That implies that such functions can only be used in scripts. If I am not mistaken, one can include functions in notifications, both on screen and on the statusbar. This is not really made clear anywhere, nor are there examples that I can find showing how this might be done. Under notifications, it says that variables are supported, but does not mention functions. (I like notifications like this: “Stopped at {GetDate(),dateformat,HH:mm:ss}”. There is no documentation about this and many other helpful things.
• Glob pattern are never defined not could I find a single example of them. Can they be used in the contains() function? Can they be used in matches()? When can they be used? What are the restrictions on their use?
• It is not clear that (apparently) all variables except those declared global, are static. For example, variables like location_name, ssid, etc. are static. They only exist in the current flow. I guess that if you want to save a variable like ssid you need to create a global variable like global_ssid=ssid. Examples like this are immensely helpful! If an action creates a variable like ssid, can it be used several actions/conditions later in the same flow?
• What are maps? I could not find any definition for them. How can I use them if I don’t know what they are?
AM would be open to a vastly larger audience if users had a better idea of what thing did in AM. I suspect that my frustration is shared by many and that many have given up because of lack of direction. Please help those of us who are still struggling.
Since one cannot see the flows that are discussed in the forum, it is very difficult to decrypt some of the logic.
Here are a few of the issues that I have run across lately. Some I have resolved (at a loss of some head hair) and some remain a mystery.
• The trigger “WiFi Scan Results Available,” is described this way: “The trigger WiFi Scan Results Available is executed when the results of a WiFi access point scan are available.” What does that mean? What triggers this trigger? Totally lost as to how to use this.
• Functions are found only under Actions-Script. That implies that such functions can only be used in scripts. If I am not mistaken, one can include functions in notifications, both on screen and on the statusbar. This is not really made clear anywhere, nor are there examples that I can find showing how this might be done. Under notifications, it says that variables are supported, but does not mention functions. (I like notifications like this: “Stopped at {GetDate(),dateformat,HH:mm:ss}”. There is no documentation about this and many other helpful things.
• Glob pattern are never defined not could I find a single example of them. Can they be used in the contains() function? Can they be used in matches()? When can they be used? What are the restrictions on their use?
• It is not clear that (apparently) all variables except those declared global, are static. For example, variables like location_name, ssid, etc. are static. They only exist in the current flow. I guess that if you want to save a variable like ssid you need to create a global variable like global_ssid=ssid. Examples like this are immensely helpful! If an action creates a variable like ssid, can it be used several actions/conditions later in the same flow?
• What are maps? I could not find any definition for them. How can I use them if I don’t know what they are?
AM would be open to a vastly larger audience if users had a better idea of what thing did in AM. I suspect that my frustration is shared by many and that many have given up because of lack of direction. Please help those of us who are still struggling.