AP
This command allows you to configure and manage multiple Access Points.AP
Usage: AP function [parameters...]
This command allows you to configure and manage multiple Access Points.
It exposes the following functions:
AP LIST
AP SCAN
AP STATUS
AP ADD
AP USE
AP PRIO
AP DEL
AP SETIP
To learn more, type HELP AP function
See also: TXPW, PREW, PRE, POST
AP SETIP
This function sets a static IP address on a specific AP.AP SETIP
Usage: AP SETIP ssid ip netmask gateway dnsip
This function sets a static IP address on a specific AP.
At this time, if you configure a static IP on a single AP and have multiple APs listed, you must enter a static IP for all other APs, as the SiB™ cannot switch to a static IP and then back to DHCP at present.
Example: AP SETIP myHomeRouter 192.168.0.22 255.255.255.0 192.168.0.1 8.8.8.8
AP STATUS
This function shows the status of the connected AP.AP STATUS
Usage: AP STATUS
This function shows the status of the connected AP.
The function shows the connection status, including SSID, IP address, mask, gateway and DNS IP address used.
Example: AP STATUS
AP LIST
This functions lists all of the Access Points configured on your SiB™. AP LIST
Usage: AP LIST
This functions lists all of the Access Points configured on your SiB™.
They are listed in order of connection attempt.
The APs are numbered, and the priority value is also listed. The numbers assigned to each AP can be used in other functions, like AP DEL
AP SCAN
This function performs a scan of available Access Points and outputs the result.AP SCAN
Usage: AP SCAN
This function performs a scan of available Access Points and outputs the result.
The output includes only the Access Point SSID and signal strength.
AP ADD
This function adds an Access Point configuration to the SiB™.AP ADD
Usage: AP ADD ssid password [priority]
This function adds an Access Point configuration to the SiB™.
This function only adds and saves a configuration, it does not test nor connect to the newly connected Access Point.
The [priority] value can be any number from 0 to 127; 0 being most important and 127 being least important.
If [priority] is omitted, the AP will automatically receive a priority of 0 and will become the first AP on the list.
If a priority is given and an AP already exists with that priority, the new AP will take priority but will not overwrite the previous AP.
AP DEL
This function deletes an Access Point from the list of configured APs.AP DEL
Usage: AP DEL number|ssid
This function deletes an Access Point from the list of configured APs.
You cannot delete the currently used Access Point.
You can provide either a number or an SSID for deletion. The number provided is the index number given on the AP LIST command output.
For example, the first AP on a list will have an index of 1. If you enter an SSID instead, all configured Access Points matching the given
SSID will be deleted.
AP USE
This function disconnects from the current Access Point and connects to the specified AP. You can either enter an SSID or an index number here. AP USE
Usage: AP USE number|SSID
This function disconnects from the current Access Point and connects to the specified AP. You can either enter an SSID or an index number here.
The index numbers are provided by the command AP LIST. If an SSID is specified and multiple AP's exist with the same SSID, each will be tried
in order from most important to least important priority.
If this function fails, it will attempt to reconnect to any AP by going through the list in order of priority.
AP PRIO
This function changes the priority of an Access Point. AP PRIO
Usage: AP PRIO number|ssid|auto|manual prio
This function changes the priority of an Access Point.
The SiB™ can automatically connect to the best access point in signal strength; this is called 'automatic' mode. This mode (TODO in future) will be on by default. To enable this mode manually, enter AP PRIO AUTO.
To switch back to manual mode, enter AP PRIO MANUAL.
To specify a manual order:
You can specify either an index number or an SSID. The index numbers are provided by the function AP LIST. If you enter an SSID and more than one Access Points are configured with the same SSID, the command will return an error.
If a priority is set that matches another AP, the specified AP will take priority over the existing AP, but will not overwrite the existing AP.
This function allows you to re-order the configured Access Points.
AUTH
This function allows you to managed authorized users for your SiB™.AUTH
Usage: AUTH function [parameters]
This function allows you to managed authorized users for your SiB™.
The authorized users will be able to issue commands to your SiB™ directly via IM.
The following functions are available:
AUTH ADD
AUTH DEL
AUTH LIST
To learn more, type HELP AUTH function
AUTH ADD
This function adds an authorized user to your SiB™.AUTH ADD
Usage: AUTH ADD number
This function adds an authorized user to your SiB™.
The number entered must be the mobile number of the SiMP™ user you wish to authorize,
in international format, without any formatting symbols such as +, -, ( and ).
AUTH DEL
This function deletes an authorized user from accessing your SiB™.AUTH DEL
Usage: AUTH DEL number
This function deletes an authorized user from accessing your SiB™.
The number entered must be the mobile number of a SiMP™ user.
AUTH LIST
This function lists the authorized users to your SiB™.AUTH LIST
Usage: AUTH LIST
This function lists the authorized users to your SiB™.
BUTTON
This function allows a long-running SiD or SiB program to monitor and take actions when a button press is detected. The first parameter is the letter S (for short click) or L (for long click). The second parameter is a function name. After this command is issued in a PROG, the SiB, until the next power cycle, will monitor the button for presses. When a button press is detected, the SiB will call the appropriate function.BUTTON
Usage: BUTTON S|L functionName
This function allows a long-running SiD or SiB program to monitor and take actions when a button press is detected. The first parameter is the letter S (for short click) or L (for long click). The second parameter is a function name. After this command is issued in a PROG, the SiB, until the next power cycle, will monitor the button for presses. When a button press is detected, the SiB will call the appropriate function.
NOTE that if you are already running a function, that function will be interrupted for the button-press function and will NOT return.
If a short (s) function is setup but not a long (l) function, the short function will be called for presses of any length.
A short and long function can be added in the same running program by calling the BUTTON function twice.
CALIB
The CALIB function provides calibration for time and temperature for your SiB™.CALIB
Usage: CALIB function
The CALIB function provides calibration for time and temperature for your SiB™.
Calibration can be done on three functions: time, temperature, and voltage.
To calibrate the clock, issue CALIB TIME. This command will put your SiB™ to sleep for 10 minutes and measure
the offset or delay of the clock. Some commands can be enhanced by adding a + symbol, as described in HELP.
These commands will use the CALIB result in their calculations of time.
To calibrate the temperature, issue CALB TEMP temperature - where 'temperature' is the current temperature in Celcius, without decimal values.
For example. CALIB TEMP 26 will calibrate the temperature sensor to 26 degrees. Like CALIB TIME, this will put your SiB™ to sleep for some time as the calibration needs to measure the temperature after a cold-boot.
To calibrate the voltage read-out for the command RV, issue CALIB POWER gpio# referenceVoltageMV.
For example, CALIB POWER 36 3000 will read the voltage on pin 36 and calibrate the SiB™ to read 3000mV (3V)
To view current calibration values, enter CALIB STATUS
See also: TEMP, RV
CONF
CONF is the primary function to apply configuration changes to the SiB™.CONF
Usage: CONF setting value
CONF is the primary function to apply configuration changes to the SiB™.
Issue CONF LIST to view all available settings and their current value.
Settings:
cpu.speed: Can be set to 40 or 240 (in MHZ)
safeties: Can be set to on or off. Set to OFF to disable safeties that prevent accidental battery drainage.
DEBUG
This command enables or disables debug messaging.DEBUG
Usage: DEBUG on|off
This command enables or disables debug messaging.
When enabled, you will receive extra information via IM about operations on your SiB™. Disabled by default.
DL
This command pauses your SiB™ program for the amount of time specified.DL
Usage: DL[+] time
This command pauses your SiB™ program for the amount of time specified.
The time parameter is by default a value in milliseconds; however the following suffixes are permitted:
s = seconds, m = minutes, h = hours. For example, DL 1h will delay execute for one hour.
Your SiB™ continues to operate during that time and unless notifications are disabled, your SiB™ will accept and queue commands received by IM.
This command can be enhanced with the + symbol, for example: DL+ 1h. This symbol instructs your SiB™ to use calibrated time. See
HELP CALIB for more information.
See also: CALIB TIME, SL, SLB
DRIVE
Sets the maximum drive capability of a given GPIO. The default value is 2.DRIVE
Usage: DRIVE gpio 0-3
Sets the maximum drive capability of a given GPIO. The default value is 2.
EN
This statement breaks a FOR loop.EN
Usage: EN
This statement breaks a FOR loop.
Use this statement to exit a FOR loop before the loop reaches it's exit condition.
See FOR for more information.
EX
This command enables Exclusive mode.EX
Usage: EX
This command enables Exclusive mode.
This command can only be used inside of a PROGRAM block. It wwill have no effect otherwise.
Exclusive mode instructs the SiB™ to queue any notifications received, other than STOP, while a program is running.
When not in exclusive mode, the SiB™ will execute instructions received via IM while a program is running.
You can stop a running exclusive program by issuing the STOP command.
FL
This command returns a GPIO to floating.FL
Usage: FL gpio
This command returns a GPIO to floating.
This command will return a given GPIO to floating.
See also: HOLD, WD, WA
FN
This command allows you to create and manage functions.FN
Usage: FN name|function [parameters...]
This command allows you to create and manage functions.
Functions are blocks of code that can be called inside of a program.
The following commands are possible:
FN LIST
FN PRINT
FN DEL
To learn more, enter HELP FN function
To create a new function, enter FN followed by the function name, and, on new lines, the code for the function, in a single IM.
For example:
FN myFunction
[code]
will create a new function called myFunction and that function will contain the code [code].
FN LIST
This command lists all currently configured functions.FN LIST
Usage: FN LIST
This command lists all currently configured functions.
FN PRINT
This command outputs the program code stored for the given function.FN PRINT
Usage: FN PRINT function_name
This command outputs the program code stored for the given function.
FN DEL
This function deletes the specified function. FN DEL
Usage: FN DEL function_name
This function deletes the specified function.
FN DEL * will delete all stored functions.
Neither of these commands provide a confirmation prompt prior to deletion; functions are immediately deleted and the operation cannot be undone.
FOR
Creates a loop with a counter and incrementer.FOR
Usage:
FOR var start end increment
...
NEXT
Creates a loop with a counter and incrementer.
This function creates a FOR loop, allowing you to repeat a step multiple times or increment a variable.
Example:
FOR myVar 1000 0 -100
IM Step myVar
RD button 35
IF button=1
EN
EI
NEXT
The above program will loop and run the block with a value of 1000, then 900, then 800, up to and including 0. The block will send a message with the current step value, then check the status of GPIO 35. IF GPIO 35 is high, the loop is ended early with EN. Otherwise, it continues until its end.
PLEASE NOTE that FOR cannot be used within a FN (function); only within a PROG (program).
See also: NEXT, EN
FORMAT
This command foramts your SiB™. It effectively performs a factory reset.FORMAT
Usage: FORMAT PLEASE
This command foramts your SiB™. It effectively performs a factory reset.
There is no confirmation prompt when this command is issued. This command executes immediately and all content on your SiB™ is lost.
Your SiB™ will enter provision mode on the next power-on or reset.
See also: RENEW
FREQ
This command pulses a square frequency on any given pin, for the specified duration.FREQ
Usage: FREQ pin frequency duration
This command pulses a square frequency on any given pin, for the specified duration.
The frequency parameter is given in HZ, and the duration is given in milliseconds.
The duration paremeter accepts the suffixes s = seconds, m = minutes, h = hours.
For example: FREQ 8 200 1m
See also: WA
HALL
This function reads the HALL sensor's value and stores it into a given variable.HALL
Usage: HALL variable
This function reads the HALL sensor's value and stores it into a given variable.
This function will RELEASE all GPIO's set with HOLD prior to execution.
HALT
Shuts down a SID as though it had reached the end of a SiB™ (button-mode) program. HALT
Usage: HALT
Shuts down a SID as though it had reached the end of a SiB™ (button-mode) program.
See also: RESET
HM
Sends a hidden "diagnostics" message back to SiMP™.HM
Usage: HM message and variables to send
Sends a hidden "diagnostics" message back to SiMP™.
This function works exactly as the IM function, except it suppresses the notification audio.
IMs received in SiMP™ from this function will not be visible in any conversation, unless the user enables the "Include Diagnostics Messages" Filter.
See also: SM, IM, SMTO, IMTO
HOLD
This function holds a pin output to high or low even during deep sleep.HOLD
Usage: HOLD pin 0|1
This function holds a pin output to high or low even during deep sleep.
NOTICE: This command will briefly reset the state of the GPIO and render it floating.
This function only works on RTC pins. An error will be returned if an invalid pin is given.
Specify 1 for HIGH, and 0 for LOW.
When deep sleep ends, the HOLD value is lost and the PIN will reset to its default state.
HOLD+
If you wish to carry a held value after a reset or deep sleep, issue HOLD+ instead of HOLD.
HOLD+ may only be used on RTC GPIOs.
See also: FL
HR
Sets the frequency at which, in SID mode, the SiB™ will poll for updates, in milliseconds.HR
Usage: HR value_in_milliseconds
Sets the frequency at which, in SID mode, the SiB™ will poll for updates, in milliseconds.
The default is 10 seconds (10000). The minimum value is 200ms. The maximum value is 10000 (10 seconds).
IF
This function executes code conditionally, depending on a given variable's value.IF
Usage:
IF variable =|>|>=|<|<=|!= value
[code]
ELSE
[code]
EI
This function executes code conditionally, depending on a given variable's value.
A variable can be any string used in functions that output to variables; for example:
TEMP temp_var
IF temp_var > 30
IM The temperature is over 30, it's temp_var C
EI
The above code reads the current temperature value, stores it in a variable named temp_var
and executes the code only if temp_var is greater than 30.
IM
This function sends an IM to your SiMP™, in your SiB™'s main conversation. IM
Usage: IM message to send and variables to send
This function sends an IM to your SiMP™, in your SiB™'s main conversation.
The SiB™ will automatically replace variable names with the given values. For example:
TEMP temp_var
IM The temperature is temp_var C
This example will read the current temperature and output it in an IM.
IMTO
This function sends an IM to the given number(s) - that is, being a SiMP™ user's mobile number, an API ID or a SiB™ ID.IMTO
Usage: IMTO number[,number,number] message to send and variables to send
This function sends an IM to the given number(s) - that is, being a SiMP™ user's mobile number, an API ID or a SiB™ ID.
The message sent can contain variables. Variables are automatically substituted for their values. For example:
IMTO 12345678 The temperature is temp_var C
This example will read the current temperature and output it in an IM sent to 12345678
INIT
This function initializes a variable to the given value if the variable does not already exists.INIT
Usage: INIT variable=value
This function initializes a variable to the given value if the variable does not already exists.
This function should always be used at the beginning of a program (after PREW for pre-wifi programs, which must be the first line).
If a variable with the given name already exists, it's value will not be modified.
See also: SET
IO
This function allows you to toggle the SiB™'s default LED use on or off.IO
Usage: IO LED ON|OFF
This function allows you to toggle the SiB™'s default LED use on or off.
This function must be followed by a reset in SID mode. When the LED is ON, the SiB™ will animate the LED to provide feedback. When the LED is OFF, the SiB™ will not make use of it. However, you may still access it via WA.
LOOP
This function should only be used in a PROG or FUNCTION block.LOOP
Usage: LOOP
This function should only be used in a PROG or FUNCTION block.
Outside of a program, this function resets the current running program back to the first line, even if the running program is paused.
This function, when execute, loops back to the beginning of a program. It can be used to create long-running SID-mode programs.
MODE
Changes the SiB™ operation mode.MODE
Usage: MODE SiB™|SID
Changes the SiB™ operation mode.
The SiB™ supports two operation modes: SiB™ and SID.
IN SiB™ mode, at startup, a button click sequence is detected and the appropriate program is selected and executed.
If no program exists, the SiB™ goes back to sleep. If a program executes and the execution completes, the SiB™ goes back to sleep.
In SID mode, at startup, the button click sequence detection is skipped and the last running program resumes.
When a running program ends, the SID stays on and waits for it's next command.
NEXT
This statement marks the end of a FOR loop.NEXT
Usage: NEXT
This statement marks the end of a FOR loop.
See FOR for more information.
NOSAVE
This function disables the state saving of the SiB.NOSAVE
Usage: NOSAVE
This function disables the state saving of the SiB.
This function stops any future save operations on the SiB until the next power cycle (SL or HALT). There are many reasons this function might be used. The SiB saves it's state on each program line execution, and each variable change. These operations can add hundreds of milliseconds to a running program, and may be undesirable in a program where the state is not needed (i.e., in a SiB program that resets on each power cycle). Likewise, this reduces overall battery use.
NOTIFS
Enables and disables polling for new commands.NOTIFS
Usage: NOTIFS ON|OFF
Enables and disables polling for new commands.
This function enables or disables the polling for commands via IM.
This function should only be used in a program. The state of NOTIFS is not preserved after a power reset.
This function allows you to disable remote polling when performing time-critical operations such as IO reads and writes. This function
garantees that the SiB™ will not perform any other task during the execution of the code while NOTIFS is OFF.
This function should be used safely:
NOTIFS OFF
[code...]
NOTIFS ON
PAUSE
Pauses the execution of the current running program or function.PAUSE
Usage: PAUSE
Pauses the execution of the current running program or function.
When Pause is issued, the SiB™ stays powered on and awaits further instruction. The current line of execution is stored so the program can be resumed.
See also: STOP, RUN, RESUME
POWER
Allows you to tweak power consumption of specific devices.POWER
Usage: POWER device on|off|level
Allows you to tweak power consumption of specific devices.
This function can toggle the power for a few devices:
BT: Turns the BlueTooth radio on or off.
WIFI: Turns the WiFi radio on or off, or sets the power output level of the Wifi to the given value, where level is a number between 0 and 100
See also: TXPW
PRE
Example: PRE temp mytempPRE
Usage: PRE command
Example: PRE temp mytemp
This will execute a command on the next SiB™ reset, while the WIFI is connecting. It is useful to queue commands to run while the SiB™ is still cool.
See also: PREW, POST
PREW
This will execute a command on the next SiB™ reset, prior to WIFI starting. This is useful when accessing GPIO's on the ADC2.PREW
Usage: PREW [command]
This will execute a command on the next SiB™ reset, prior to WIFI starting. This is useful when accessing GPIO's on the ADC2.
It is also useful to execute entire programs without starting the WiFi component, preserving battery.
PREW can be used to queue a single [command] at the next startup, or it can be used to instruct the SiB™ to skip WiFi at startup in a program.
To use PREW in a program, PREW MUST BE the first line of the program.
In a PREW program, the command POST can be used to start WiFi.
Example:
PROG myprog
PREW
TEMP mytemp
IF mytemp<0
POST
IM The temperature is below freezing
EI
SL 1m
LOOP
This program will measure the temperature but keep WiFi off and power use at a minimum until the temperature reaches below 0 Celcius.
At that point, the POST command initiates WiFi.
See also: PRE, POST
POST
Instructs the SiB™ to connect to WiFi when used in a PREW program. See PREW for more details.POST
Usage: POST
Instructs the SiB™ to connect to WiFi when used in a PREW program. See PREW for more details.
See also: PRE, PREW
PROG
This function allows you to create or manage programs.PROG
Usage: PROG name|function [parameters]
This function allows you to create or manage programs.
To manage programs, you can execute the following:
PROG LIST
PROG DEL
PROG PRINT
PROG LOAD
To learn more, enter HELP PROG function.
To create a new program in SiB™ mode, you must name your program according to a click sequence, where
S = a short click, and L = a long click.
For example, to create a program that executes after two short clicks, enter the following:
PROG SS
[code...]
In SID mode, you can give any name to your program other than those keywords 'LIST','DEL','PRINT','LOAD', for example:
PROG daily reminder
[code...]
When a program is created, if the SiB™ is not in 'STOPPED' or 'PAUSED' mode, the program executes immediately.
PROG LIST
Lists all stored programs.PROG LIST
Usage: PROG LIST
Lists all stored programs.
PROG DEL
Deletes the specified program by name, or all programs if an asterisk * is specified. This function provides no warning or confirmation PROG DEL
Usage: PROG DEL name|*
Deletes the specified program by name, or all programs if an asterisk * is specified. This function provides no warning or confirmation
prompt and immediately deletes the specified program(s), with no option to undo. Use this function with care!
PROG PRINT
Outputs the program code for the named program, or, if no program is specified, for the current running program.PROG PRINT
Usage: PROG PRINT [name]
Outputs the program code for the named program, or, if no program is specified, for the current running program.
PROG LOAD
Loads the program specified.PROG LOAD
Usage: PROG LOAD name
Loads the program specified.
If the SiB™ is not in STOPPED or PAUSED mode, the program will execute immediately.
RA
Reads an analog value from a given pin into the given variable.RA
Usage: RA pin variable
Reads an analog value from a given pin into the given variable.
This function is only available on some specific pins. Entering a wrong pin will result in an error.
This function returns a value between 0 and 1024. The value is stored in the given variable.
For example:
RA 15 pin_15
will store the analog input from pin 15 at that specific time into a variable named pin_15
See also: WD, WA, HOLD, RD, FL
RAX
Reads a raw voltage value in MV from a given gpio into the given variable.RAX
Usage: RAX pin variable
Reads a raw voltage value in MV from a given gpio into the given variable.
This function reads an uncalibrated (raw) voltage reading from an ADC-enabled RTC GPIO.
If a GPIO from ADC2 is requested, this function must be used in PREW only. This function will return a maximum of approximately 3060, for 3V.
See also: RV
RC
Reads a capactive touch GPIO into the given variable.RC
Usage: RC pin variable
Reads a capactive touch GPIO into the given variable.
This function is only available on some specific pin. Entering an invalid pin will result in an error.
This function returns a value between 0 and 3000 (TODO). A floating GPIO will return anywhere above 1000. A GPIO under capacitance will read a lower value.
See also: WAKEC
RD
Reads a digital value from a given pin into the given variable.RD
Usage: RD pin variable
Reads a digital value from a given pin into the given variable.
This function returns either 0 for low, and 1 for high current. The value is stored in the given variable.
For example:
RD 15 pin_15
will store the digital input from pin 15 at that specific time into a variable named pin_15
See also: WD, WA, RA, RAX, FL, HOLD
RDH
Reads a digital value from a pin with a pull-up function.RDH
Usage: RDH pin variable
Reads a digital value from a pin with a pull-up function.
This function reads a digital 0 or 1 from the specified pin into a variable. If the pin is floating, a value of 1 (high) will be stored.
RDL
Reads a digital value from a pin with a pull-down function.RDL
Usage: RDL pin variable
Reads a digital value from a pin with a pull-down function.
This function reads a digital 0 or 1 from the specified pin into a variable. If the pin is floating, a value of 0 (low) will be stored.
RENEW
This function allows you to reset the SiB™s name and / or conversation without reprovisionning it.RENEW
Usage: RENEW all|convo new_name
This function allows you to reset the SiB™s name and / or conversation without reprovisionning it.
If ALL is specified, the SiB™ will reset and acquire a new name and control conversation, using the given name.
If CONVO is specified, the SiB™ will reset and create a new control conversation, using the given name.
RESET
This function resets the SiB™.RESET
Usage: RESET
This function resets the SiB™.
See also: HALT
RESUME
This function resumes a paused program.RESUME
Usage: RESUME
This function resumes a paused program.
See also: PAUSE, STOP, RUN
RUN
Runs a program.RUN
Usage: RUN [name]
Runs a program.
If [name] is specified, loads and runs the named program. Otherwise, this will run the current program in-memory.
If a program is in-memory and is in PAUSED mode, the program will be reset before running.
See also: PAUSE, RESUME, STOP
RUNEX
Runs a program in exclusive mode.RUNEX
Usage: RUNEX [name]
Runs a program in exclusive mode.
If [name] is specified, loads and runs the named program. This function operates exactly as the RUN function,
but runs any program in Exclusive mode. In Exclusive mode, commands issued via IM will be stored and will execute only when the program
finishes. A STOP command can exit exclusive mode.
RUNAT
Defines a program to run at a specific time of day.RUNAT
Usage:
RUNAT time
[code]
...
Defines a program to run at a specific time of day.
The time is given in HH:MM 24 hour format.
Example:
RUNAT 12:00
IM It is noon
RUNFN
Runs a function.RUNFN
Usage: RUNFN name
Runs a function.
Runs the named function.
See also: FN
RV
This function reads the voltage level of the power source attached to GPIO 35.RV
Usage: RV [variable]
This function reads the voltage level of the power source attached to GPIO 35.
This function should only be called after executing CALIB POWER.
If a variable is given, the result in millivolts will be stored. Otherwise, an IM will be sent.
See also: CALIB POWER, RAX
SET
Allows the execution of mathematical equations in running programs.SET
Usage: SET variable=equation
Allows the execution of mathematical equations in running programs.
Example:
INIT a=10
SET b=a*20
IM a b
This program will send an IM containing the message: 10 200
See also: INIT
SiB™EXT
Creates a SiB™ range extender.SiB™EXT
Usage: SiB™EXT on ssid pw | off
Creates a SiB™ range extender.
Using this command turns your SiB™ into a range extender.
This command does not persist after resets. If you wish to have this state persist on reset, enter this command into a PROGRAM with a LOOP in SID mode.
To enable the extension, enter
SiB™EXT ON ssid pw
Where SSID is an SSID you wish to assign to the SiB™ and the password is the password that other SiB™s will use to authenticate to your extension.
The SSID entered MUST begin with 'sibext'; this allows connecting SiB™ devices to identify and properly route requests.
To turn off the range extender, enter SiB™EXT OFF
SL
Sleeps for the given amount of time.SL
Usage: SL[+] time|off|button
Sleeps for the given amount of time.
If 'off' is supplied rather than a time, the SiB™ will go to sleep with NO MEANS of waking up.
If 'button' is supplied rather than a time, the SiB™ will go to sleep until a button press is detected.
When issuing this command, the SiB™ will go into a deep sleep state. It will sleep for the specified amount of time.
The time parameter is in milliseconds, however the following suffixes are permitted: s = seconds, m = minutes, h = hours.
If a sleep time longer than one hour is specified, the SiB™ will wake up every hour and check for new notifications until the time runs out.
This allows the sleep cycle to be interrupted; i.e., to run another program, to stop or reconfigure the SiB™, etc.
The SL command can be enhanced using the + symbol, where the time to sleep will be calculated using the result for CALIB TIME.
The deep sleep can also be interrupted by a button press.
If the button is in SiB™ mode, a button press will wake up the device and initiate the button-click sequence; the resulting program will
be loaded and the current running program will not resume.
See also: SLB, DL
SLB
By default (with no time specified), SLB will put the SiB™ to sleep until a button press is detected.SLB
Usage: SLB [time]
By default (with no time specified), SLB will put the SiB™ to sleep until a button press is detected.
If a time is provided in milliseconds, the SiB™ will go to sleep and wake up after the given time OR when a button press is detected.
See also: SL, DL
SMSTO
Sends an SMS to the specified mobile recipient.SMSTO
Usage: SMSTO number message and variables
Sends an SMS to the specified mobile recipient.
The message entered can contain variable names; these will automatically be replaced by each variable's value.
The SMS is sent from the mobile number that initially configured the SiB™. The sending mobile must be powered on and SiMP™ must be running for
this operation to succeed.
See also: IM, IMTO, SMTO, SM, HM
SM
Sends a silent message back to SiMP™.SM
Usage: SM message and variables to send
Sends a silent message back to SiMP™.
This function works exactly as the IM function, except it surpresses the notification audio.
See also: HM, IM, IMTO, SMTO
SMTO
Sends a silent message to a SiMP™ user without sounding a notification.SMTO
Usage: SMTO number[,number,number] message and variables to send
Sends a silent message to a SiMP™ user without sounding a notification.
'number' in this case must specify a SiMP™ API ID or a SiMP™ user's mobile number. Multiple numbers can be provided.
This command works exactly as IMTO except it supresses the notification audio on a SiMP™ mobile device.
See also: HM, IMTO, IM, SM
STATION
Enables or disables broadcast station mode.STATION
Usage: STATION on|off
Enables or disables broadcast station mode.
This command can only be used in mode SID and the device only broadcasts the station mode while the device is running (i.e., not sleeping).
This command is required in order to use TRIGGER functions, functions that trigger based on the proximity of a SiMP™ user.
STATUS
Echos back to SiMP™ the current status of the SiB™.STATUS
Usage: STATUS [extend]
Echos back to SiMP™ the current status of the SiB™.
Specify EXTEND to receive more information.
STOP
Stops the running function, program or sleep.STOP
Usage: STOP
Stops the running function, program or sleep.
This function will stop the execution of any program or function. It also exits from exclusive mode, and clears any queued items that were received but not executed.
See also: RUN, PAUSE, RESUME
SZ
Toggles a SimpZone action on the configuring SiMP™ mobile.SZ
Usage: SZ action on|off|reset|%
Toggles a SimpZone action on the configuring SiMP™ mobile.
The possible actions are: volume, vibrate, bt (for bluetooth), and brightness
For example:
SZ volume 80% sets the volume on your mobile to 80%
See also: TRIGGER, SZTO
SZTO
Toggles a SimpZone action on a remote device that has authorized your SiB™.SZTO
Usage: SZTO number actoin on|off|reset|%
Toggles a SimpZone action on a remote device that has authorized your SiB™.
The possible actions are: volume, vibrate, bt (for bluetooth), and brightness
For example:
SZ 12345678 volume 80% sets the volume on the mobile device #12345678 to 80%.
See also: SZ, SZTO
TEMP
Reads the current temperature.TEMP
Usage: TEMP [variable]
Reads the current temperature.
This function should only be used after the temperature sensor has been calibrated. See HELP CALIB for more information.
Without a variable, this command echos the current temperature in an IM back to SiMP™.
If a variable is specified, this command stores the current temperature in the named variable.
See also: CALIB TEMP
TRIGGER
In STATION mode, triggers an action when a user approaches or leaves your SiB™ range.TRIGGER
Usage: TRIGGER [after time] [enter x] [exit x] action [parameters]
In STATION mode, triggers an action when a user approaches or leaves your SiB™ range.
Parameters:
AFTER time - where time is a time value in seconds only. For example: TRIGGER AFTER 60
ENTER x - where X is the signal strength in % of your SiB™ as seen by the approaching device.
EXIT x - where X is the signal strength in % of your SiB™ as seen by the exiting device.
For example, an action that is to trigger 1 minute after a device is near your SiB™: TRIGGER AFTER 60 ENTER 90 ...
Action: Action can be any of the following:
BR on|off|reset|level - toggles brigthness on the remote device.
BT on|off|reset - toggles bluetooth on the remote device
VIB on|off|reset - toggles the vibrator
VOL on|off|reset|level - toggles the volume level in %
IM [message] - sends an IM to the entering device. Variables are not supported here.
IMTO number [message] - sends an IM to a specified device. Variables are not supported here.
SM [message] - sends a silent IM to the entering device. Variables are not supported here.
SMTO [messagse] - sends a silent IM to a specified device. Variables are not supported here.
CALLTO, CALLRTO, FILETO - to be determined
To delete all triggers, send TRIGGER CLEAR
See also: SZ, SZTO
TXPW
Sets the maximum power used in WiFi transmissions.TXPW
Usage: TXPW value_in_percentage
Sets the maximum power used in WiFi transmissions.
Example: TXPW 100
TZO
Sets the timezone offset for AT commands.TZO
Usage: TZO offset
Sets the timezone offset for AT commands.
The offset value can be any number of hours only. At this time, the firmware does not support fractional time zones.
UDL
This function sleeps for the given number of microseconds.UDL
Usage: UDL time_us
This function sleeps for the given number of microseconds.
The time parameter here is accepted only in microseconds.
UPDATE
Updates the SiB™ to the specified firmware version. If no version is specified, updates to the latest firmware.UPDATE
Usage: UPDATE [version]
Updates the SiB™ to the specified firmware version. If no version is specified, updates to the latest firmware.
WAKE
Remains in deep sleep with short WiFi scans and wakes if a specific SSID is found.WAKE
Usage: WAKE ssid time
Remains in deep sleep with short WiFi scans and wakes if a specific SSID is found.
This function will go to deep sleep and sleep for the specified time. The SiB™ will then wake and scan for nearby Access Points.
If the specified SSID is seen, the SiB™ will wake and the program code will continue to execute.
If the specified SSID is not seen, the SiB™ will go back to sleep for the given time, and try again.
The time is specified in milliseconds, however the following suffixes are permitted: s = seconds, m = minutes, h = hours
Waking the SiB™ via button press overrides the WAKE command.
WA
Outputs a pulse wave to the specified pin. WA
Usage: WA pin 0-1024
Outputs a pulse wave to the specified pin.
The accepted range is from 0% to 100%. This function can be used to toggle a LED brightness or buzzer tone. For a more precise square wave, use the FREQ command.
Both the GPIO # and the value can be represented by variables.
See also: RA, WD, WA, HOLD, FL
WAKEAT
Sleeps until the specified time(s).WAKEAT
Usage: WAKEAT 0:12 13:45
Sleeps until the specified time(s).
The WAKEAT function puts the SiB™ to sleep until the specified time. This command should be used in a SID mode program to trigger timed actions, such as reminders.
For example:
PROG reminder
WAKEAT 9:00
IM Time to go to work!
WAKEAT 17:00
IM Time to go home!
LOOP
Multiple times can be specified in a single command to create a repeating reminder:
WAKEAT 6:00 12:00 18:00
The time given must be in 24-hour format. Use the TZO command to set your timezone before using this command.
See also: WAKEATB, TZO
WAKEATB
Sleeps until the specified time(s) or until the SiB™ button is pressed.WAKEATB
Usage: WAKEATB 0:12 13:45
Sleeps until the specified time(s) or until the SiB™ button is pressed.
This command is identical to the WAKEAT command, but in addition, allows the SiB™ button to wake the SiB™ at any time.
See the WAKEAT command for usage details.
See also: WAKEAT, TZO
WAKEC
Goes to sleep until a capacitive touch GPIO threshold is reached.WAKEC
Usage: WAKEC gpio threshold
Goes to sleep until a capacitive touch GPIO threshold is reached.
This command will put the SiB™ to sleep and monitor a capacitive touch GPIO. A floating GPIO will read a value of 1000 or more; while a GPIO sensing some capacitance will read lower values. This command will wake your SiB™ when a capacitive touch GPIO reads a value below the requested threshold.
See also: RC
WAKEIO
Goes to sleep until a specific GPIO event is triggered.WAKEIO
Usage: WAKEIO gpio 1|0 timeout
Goes to sleep until a specific GPIO event is triggered.
This command will put the SiB™ to sleep until the specified GPIO reads the target level HIGH (1) or LOW (0).
When specifying a HIGH value, the sleep can also be interrupted by button press. When specifying a LOW value, the sleep will not be interrupted by button press.
The timeout value is optional. Specify a timeout (i.e., 20s, 10ms, 1h) to have the sleep end without the GPIO level being reached.
At the moment, there is no way to differentiate between a wake on timeout and a wake on IO
WD
Outputs High (1) or Low (1) to the specified pin.WD
Usage: WD pin 0|1
Outputs High (1) or Low (1) to the specified pin.
Both the GPIO # and the value can be represented by variables.
See also: WA, RA, FL, HOLD, RD
|