Susan online help

Author: T Street

Help version 1.5

For Susan version: 1.1.0.42 or newer.

 

CONTENTS:

Getting started

Searching the web

Setting the news and weather feeds

Changing where Susan stores my data

Running Susan from OneDrive

Running Macros

Running Scripts

Making Susan say stuff

Opening resources

Sending email

Doing Mathematics

List of Commands

 

Getting started

Susan is a personal digital assistant.  Type commands directly into the blue bar.

Susan will suggest commands in the space below.  Use the cursor keys to highlight one of the suggestions and use the up/down keys to select.

Separate multiple commands with a semi-colon.

Searching the web

To open an online resource simply type the full URI.

For example:

     http://www.superdecadegames.com

     www.superdecadegames.com

You can also use the Google or Bing search engines.

For example:

     google cat pictures

Susan will search the web for any input that doesn’t make sense to her. 

For example:

     cat pictures

You can change the default search engine to either Google, or Bing, using the commands ‘google’ or ‘bing’ respectively.  This will NOT affect your default search engine in your browser.

 

Setting the news and weather feeds

Susan gets the news and weather from RSS feeds.  By default these are set to the BBC in the UK.  You can change these with the following commands.

     setNewsfeed

     setWeatherfeed

     setPrimaryfeed

Type the command followed by a valid RSS feed.  For example to set the news feed to BBC technology news:

     setNewsfeed http://feeds.bbci.co.uk/news/technology/rss.xml?edition=uk

The news and primary feed are displayed on Susan’s main page and update regularly.  The weather feed is accessed through the ‘weather’ command.

Changing where Susan stores my data

By default Susan stores your data in your documents folder.  It may be that you want to store this data onto OneDrive or another cloud syncing folder so you can use multiple instances of Susan on different devices.

Making Susan save to OneDrive:

1.       Create a new file called exactly “userpath.dat” and save this is the same folder as the Susan executable file.

2.       Edit this file in Notepad so that there is only line that is the path you want to use for saving.  For example:

c:\users\username\onedrive\susanSaveFile\

3.       Press return so that there is a new blank line below this line and save the file.

4.       Susan will now look in the folder you specified for her save data.

Running Susan from OneDrive

If you place the Susan executable into your OneDrive folder, she will save user data locally to your documents folder. To change this so your settings are synchronised across your devices follow these steps.

1.       Create a new file called exactly “userpath.dat” and save this is the same folder in OneDrive as the Susan executable file.

2.       Edit this file in Notepad so that it contains exactly:

none

3.       Press return so that there is a new blank line below this line and save the file.

4.       Susan will now look in your OneDrive folder for save data.

The previous methods will work in DropBox and Google Drive as well, provided you have the desktop apps installed.

Running Macros

Macros are sequences of commands that can be bound to the function keys F2 through F10.  It is not possible to bind a macro to F1 as this is reserved for ‘help’ (this file).

To record a macro type:

     macro N <command> ; <command list >

Where N is a number between 2 and 10 inclusive, and <command> is a valid Susan Command, or a chain of semi-colon separated commands.

For example, to set a Macro that sends an email to myself:

     macro 2 mail me@myemail / important

To create a macro that tells me the current date, time, news and weather:

     macro 3 time; date; news; weather

To run a previously recorded macro, just press the corresponding function key.

To get information on a macro, type:

     viewMacro 3

Running Scripts

Susan can run commands from a text file rather than the keyboard.  Create a text file with a list of commands separated by semi-colons.

To load and run a script file, use the ‘exec’ command.

Making Susan say stuff

Use the ‘say’ command followed by the text you want Susan to say.

Opening resources

You can open any resource on your machine with the ‘open’ command.

For example:

                open c:\users\me\docs\cat3.jpg

To open your Windows file explorer window use the command ‘files’.

Sending email

You can compose an email using Susan’s ‘mail’ command.

For example:

Mail someone@somewhere

Mail someone@somewhere / subject

Mail someone@somewhere / subject / message body

All of these commands will open your default mail program before sending.

Doing Mathematics

Type a mathematical expression followed by an equals (=) symbol.

For example:

                5 + 6 / 3 =

You should return the answer ‘7’.

Variables

You can set variables to be used in expressions by using the equals sign before a value or expression.

 

For example:

                X = 5.72

     mass = 0.0234

     y = 4 + 5

Variables can be used as placeholders in expressions.

For example:

                y = <x> + 23

 

Variable identifiers cannot be numeric, however they can have spaces.

Assigning expressions to variables

You can assign an expression to a variable.  For example, if you want y to be a function of x, use:

     y := <x> * 2

 

Mathematical operators

+         Addition.

-         Subtraction.

*         Multiplication.

/         Division.

^         Raise to power.

div       Integer division.

mod       Remainder of division.

and       Bitwise logical AND operation.

or       Bitwise logical OR operation.

eor       Bitwise logical EXCLUSIVE OR operation.

abs A function which returns the absolute value of its numeric argument.

acs A function which returns, in radians, the arc-cosine of its numeric argument. The permitted range of the argument is –1 to +1.

asn A function which returns, in radians, the arc sine of its numeric argument. The permitted range of the argument is –1 to +1.

atn A function which returns, in radians, the arc tangent of its numeric argument. The permitted range of the argument is from minus infinity to plus infinity.

cos A function giving the cosine of its radian argument.

deg A function which converts radians to degrees.

exp A function returning 'e' to the power of the argument.

int A function truncating a real number to the lower integer.

inv A function which returns the inverse 1/x of the argument.

ln This function gives the logarithm to the base 'e' of its argument. The 'natural' number, 'e', is approximately 2.71828183.

log A function giving the base-10 logarithm of its argument.

not A function return the opposite boolean value to its argument. All +ve/-ve numbers evaluate as -1 (true). Zero evaluates as 0 (false)

rad A function which converts degrees to radians.

rnd A function which returns a random number. The type and range of the number returned depends upon the optional parameter.

sgn A function returning –1 for negative argument, 0 for zero argument and +1 for positive argument.

sin This function returns the sine of an angle. The angle must be expressed in radians, not degrees.

sqr A function returning the square root of its argument.

tan This function returns the tangent of an angle. The angle must be expressed in radians, not degrees.

 

String variables

Susan can store values as strings. Simply append the variable identifier with a dollar sign.

For example:

     $my address = 23 Meteor Street

     $name = John

 

Using variables in command expressions

You can use a variable in any command expression.  Use angle brackets to identify the variable.

For example:

                google <$my address>

 

List of Commands

accountPics

Opens account pictures folder if available.

addPrograms

Opens add programs folder if available.

addRemoveApps

Opens add/remove programs folder if available.

adminTools

Opens Windows admin tools if available.

appData

Open the appData folder if available.

Apps

Opens the Windows applications folder if available.

appShortcuts

Open the Windows applications shortcuts folder if available.

appUpdates

Open the Windows app updates folder if available.

bing

Set Susan’s default search engine to Bing. This does not affect the default search in your browser.

blogger

Opens your blogger dashboard if available.

Cache

Opens windows net cache folder if available.

callMe

Sets the name Susan will use to address you.  Eg callMe John

cameraRoll

Opens the Windows camera roll folder if available.

cdBurning

Opens the Windows cd burning folder if available.

chat

Opens Chatbot.

Clock

Opens the Windows clock if available.

controlPanel

Opens Windows control panel

cookies

Opens Windows cookies folder if available.

copy

Copies Susan’s output to the Windows clipboard.

cortana

Opens Cortana if available.

cp

Opens the windows control panel.

date

Displays the current date.

desktop

Opens Windows desktop folder.

dictionary

Loads the superdecade dictionary.

docs

Opens your my documents folder.

downloads

Opens you downloads folder.

drive

Opens Google drive in your browser

dropbox

Opens DropBox in your browser.

exec

Runs a text file containing Susan commands separated by semi-colons.

facebook

Opens facebook.

favourites

Opens you favourites folder.

file

Opens a specific file.  Eg file c:\users\username\mystuff.docx

files

Opens your file explorer window

freespace

Displays the available space on a drive. Default is drive C:

g+

Opens you Google Plus page.

games

Opens Windows games folder if available.

google

Sets default search engine to Google. This does not affect the default search engine in your browser.

help

Loads this help file.

history

Opens the history folder if available.

home

Opens the superdecade homepage.

homeGroup

Opens your home group folder.

http

Open a URI

insta

Opens Instagram

internetFolder

Opens Windows internet folder.

libraries

Opens you Windows Libraries folder.

links

Opens your Windows links folder

macro

Assign a macro to function key 2 through 10 inclusive. See: Running Macros.

Magnify

Opens magnify tool if available.

mail

Opens you default email app.  See also Sending email

maps

Opens your default maps app.

myComputer

Opens you my computer folder.

news

Finds the lastest headline from the news RSS feed.

note

Opens Windows Notepad if available

onedrive

Opens OneDrive

onenote

Opens Microsoft OneNote if available.

open

Open a specific resource.  See also file.

paint

Opens MS-paint if available.

passwordWizard

Opens Windows password wizard.

pause

Pauses Susan for one second.

To pauses Susan for a specified number of centi-seconds, use pause N.  For example. Pause 300, will pause Susan for 3 seconds. 

pictures

Opens Windows Pictures folder.

pin

Opens your Pinterest homepage.

power

Displays the current power settings.

programs

Opens programs folder.

quickLaunch

Opens quicklaunch folder if available.

quit

Exits Susan.

recycleBin

Opens recycle bin folder.

rename

Changes the title bar of Susan’s output window.

rerun

Stops Susan and reboots.

restart

Restarts your computer.

say

Forces Susan to say the text specified.

screenshots

Opens your screenshots folder if available.

sendTo

Opens send to folder. If available.

Setdate

Opens Windows set date dialog,

setNewsfeed

changes the new feed RSS

setPrimaryfeed

changes the user defined RSS feed.

settime

Opens Windows set time dialog.

settings

Opens Windows settings if available.

setVoicePitch

Sets the voice pitch.  Pitch can have a value of between -10 to 10 inclusive.

setVoiceSpeed

Sets the voice speed. Speed can have a value of between -10 to 10 inclusive.

setWeatherfeed

Changes the RSS weather feed. Provide a valid RSS feed.  The default is BBC UK.

shell:

Run a Windows 10 shell command.

shutdown

Turns off your computer.

start

Starts the timer.

stop

Stop the timer.

startMenu

Opens Windows start menu folder if available.

status

Returns status of Susan including current RSS feeds.

Sticky

Opens sticky notes if available.

tasks

Opens task manager.

time

Displays the current time.

top

Forces Susan to stay on top of other windows.

tumblr

Opens your tumblr dashboard.

twitter

Opens your twitter feed.

user

Displays your current Windows session username.

version

Displays the current version number of Susan.

videos

Opens you videos folder.

viewMacro

Displays the code for macros 2-10.

voiceOff

Turns Susan’s voice off.

voiceOn

Turns Susan’s voice on.

weather

Displays the current weather information.

wiki

Sets search engine to Wikipedia.  Try ‘wiki <article>’

windowsComputerName

Displays your computer name.

windowsVersion

Displays your current verison of Windows.