h3{ margin-bottom:0; } .centered{ padding: 0px; margin-left:5vw; margin-right:5vw; } .box{ border-style: solid; border-width: 1px; border-color: #999999; padding: 5px; border-radius: 3px; background-color:white; } .red{ color: #CF256D; } mark{ background-color: #F9F2F4; color:#CF256D; border-style: solid; border-width: 1px; border-color: gray; border-radius: 3px; } a.green{ text-decoration: none; color:#4B8C2A; } a.green:visited{ text-decoration: none; color:#4B8C2A; } a.green:hover{ color:#84BD00; }

API Documentation

All of the functionality of all of the Newbound Network apps is available through a simple API that you can access via Javascript or Java.

Sending a command to your local machine via Javascript using JQuery:

$.getJSON('http://localhost:5773/botname/cmd?param1=val1¶m2=val2', function(result){
// callback
});

Sending a command to a remote device via Javascript using JQuery:

$.getJSON('http://localhost:5773/peerbot/remote/remote-universal-id/botname/cmd?param1=val1¶m2=val2', function(result){
// callback
});

Invoking a command on the local machine using Java:

Object o = BotBase.sendCommand(String bot, String cmd, Hashtable params);

Invoking a command on a remote machine using Java:

JSONObject o = BotBase.sendCommand(String uuid, String bot, String cmd, Hashtable params);

App Manager

ID: "botmanager"
View the list of apps installed on this system. The settings panel provides some additional system-wide options.

Command	Permissions	Parameters	Description
asset	include: anonymous		Return the given asset from the given library Usage: http://localhost:5773/botmanager/asset/LIBNAME/ASSETNAME.ext
compile		db, id, cmd, java, python, js, params, import, returntype, readers, writers, sessionid	Compile the given command.
convertdb	include: admin	db, readers, writers, encryption, sessionid	Convert the permissions and on-disk encryption for this library. Currently supported encryption types are AES and NONE.
delete	include: anonymous	db, id, sessionid	Delete the given record from the given library.
discover			Return the list of peers available on the local network.
execute	include: anonymous	db, id, args, sessionid	Execute the given command.
getsettings		issetup, defaultbot, discovery, machineid, portnum, requirepassword, syncapps, password	All parameters are optional. Get or set basic system settings.
jsearch	include: anonymous	db, id, java, imports, json, javascript, readers, writers, delete, sessionid, sessionlocation	Search the given library with the given saved search ID. If the java parameter is specified, it will replace the saved search algorithm with the given code.
listbots	include: anonymous		List all currently running apps.
newdb	include: admin	db, readers, writers, encryption, sessionid	Create a new library with the given name, encryption and permissions. If permissions are not specified, admin access will be required to access the library. Currently supported encryption types are AES and NONE.
primitives	include: anonymous		List the primitive functions installed on this device.
read	include: anonymous	db, id, sessionid	Read the given record from the given library.
restart			Restart the Newbound Network on this device.
savejava		db, id, cmd, java, python, js, params, import, returntype, readers, writers, sessionid	Save the given command.
savepython		db, id, cmd, java, python, js, params, import, returntype, readers, writers, sessionid	Save the given command.
setdeviceinfo			Deprecated. Do not use.
startbot			Deprecated. Do not use.
timer		id, mode, params	Administer timer rules. Supported modes are 'get', 'set' and 'kill'.
write	include: anonymous	db, data, id, readers, writers, sessionid, sessionlocation	Write the data to the given library with the given permissions. If no record ID is provided, a unique one will be assigned and returned. The user who writes the record has default read access. If permissions are not specified, admin access will be required to access this record otherwise.

Blockchain

ID: "blockchain"
The Blockchain application provides a drop-your-code-in-here approach to writing blockchain apps.

Command	Permissions	Parameters
deletechain		chainid
getblock	include: anonymous	chainid, index, convert
gethash	include: anonymous	chainid, index
init		blockchain
joinchain		peer, chainid, name, block0
latestblock	include: anonymous	chainid, convert
listblocks	include: anonymous	chainid, index
listchains	include: anonymous
mineblock		chainid, data
newchain		name, work, proof, imports, ctlid
processblocks	include: anonymous	blocks, sessionid, chainid

Controlchecker

ID: "controlchecker"
The Controlchecker application

There are no commands for this app

Cyborgro Website

ID: "cyborgrowebsite"
The Cyborgro Website application

There are no commands for this app

DiscordBot

ID: "discord"
The Toaster Simple™ way to build Discord bots. Requires the latest stable shaded discord4j jar file in your Newbound/lib folder and JDK 1.8 or higher.

Command	Permissions	Parameters	Description
startbot		id

Email

ID: "emailbot"
Send secure private email over the Newbound Network with the built-in webmail or your favorite email client application.

Command	Permissions	Parameters	Description
accounts			List all of the email account information that this device receives mail for.
addaccount		id, userid, email, server, port, username, password, status, type	Add new email account to receive email.
attachment	include: trusted, email		Retrieve email attachment as a file. Usage: http://localhost:5773/emailbot/attachment/attachmentid/filename.ext
available	include: trusted, email		List all of the email addresses that this device receives mail for.
currentuser	include: trusted, email		Retrieve current account information for webmail.
delete	include: trusted, email	id	Delete an email.
deliver	include: anonymous		Deprecated. Do not use.
fromrelay	include: anonymous		Deprecated. Do not use.
getemails			Get the list of email addresses this device can send to over the Newbound Network and their device ids.
getmessage	include: trusted, email	id	Retrieve an email message.
getrelay	include: trusted, email		Returns the primary email gateway for this device.
messages	include: trusted, email	page, pagesize	Returns email message metadata from the current account.
nnrelay	include: trusted, email		Deprecated. Do not use.
pop3	include: trusted, email	stream, sessionid	Accept an incoming POP3 request from the connected peer via the given stream ID.
receive	include: anonymous	to, len, msg, sessionid	Receive message from peer via new stream. Returns stream ID.
savesettings		id, userid, email, server, port, username, password, status, type, smtpport, pop3port, smtprelay, pop3relay	Update email server settings.
send	include: trusted, email	from, to, subject, text, html, attach	Send an email.
setemails		emails	Update list of email addresses this device can send to over the Newbound Network and their device ids.
settings			Retreive email server settings.
smtp	include: trusted, email	stream, sessionid	Accept an incoming SMTP request from the connected peer via the given stream ID.
switchuser	include: trusted, email	user, pass	Switch the current account for webmail.
updateaccount		id, userid, email, server, port, username, password, status, type	Update email account to receive email.
upload	include: trusted, email	name, file	Upload attachment file. Returns attachment id used when sending the email.

feedbot

ID: "feedbot"
Use the Feed Bot to monitor app events on your local device. Add custom Java code to transform the event data or send commands to other apps over the Newbound Network.

Command	Permissions	Parameters	Description
feed		last, count
geteventcode		bot, event
listevents
newevent		bot, event
seteventcode		bot, event, code
subscribe		bot, event
unsubscribe		bot, event

File Bot

ID: "filebot"
Share files with anyone on the local network and with other devices you are connected to over the Newbound Network.

Command	Permissions	Parameters	Description
createfile	include: trusted, files	path	Create new empty file at specified path.
createfolder	include: trusted, files	path	Create new folder at specified path.
deletefile	include: trusted, files	path	Delete file at specified path.
deletefolder	include: trusted, files	path	Delete folder at specified path and all of its contents.
fileinfo	include: trusted, files	path, children	Returns metadata about a file. NOTE: default is children=true. If you do not want metadata for content, pass: children=false
listcommonfolders	include: trusted, files		Returns a list of folders on the local device that people often share.
local	include: trusted, files		Retrieve a file from a local share. usage: http://localhost:5773/filebot/local/sharename/relative/path/filename.ext
newfolder	include: trusted, files	name, path	Create new folder with specified name inside the folder at the specified path.
retr	include: trusted, files	stream, path, sessionid	Download a file asynchronusly from the given path over the given stream.
rnto	include: trusted, files	opath, path	Rename the file from opath to path.
stor	include: trusted, files	stream, path, sessionid	Upload a file asynchronusly to the given path with the contents coming from the given stream.
updatefileshare		v	Update the list of directories to share. usage: http://localhost:5773/filebot/updatefileshare?v=share1 path1 share2 path2
uploadfile	include: trusted, files	name, path, filename, files[]	Upload a file to the given path. NOTE: Requires enctype="mime/multipart" in the form tag.
zipdir	include: trusted, files	path	Returns a ZIP archive of the folder at specified path and all of its contents. usage: http://localhost:5773/filebot/zipdir/archive.zip?path=/files/archive

Index

ID: "index"
The Index application

There are no commands for this app

MetaBot

ID: "metabot"
The app builder that built itself. It's totally meta.

Command	Permissions	Parameters	Description
activate		botmanager, classname	Activate the given app
appdetail	include: anonymous	id, botmanager	Return detail about the given app
apps	include: anonymous	botmanager	List the apps installed on this device
autoupdate		val, metabot
buildjsapi		lib, id
call		db, name, cmd, args, sessionid	Call the given command in the given library/control (db/name)
deactivate		botmanager, classname	Deactivate the given app
deletelibrary		lib, botmanager
installapp		metabot, appinfo	Deprecated. Do not use.
installlib		metabot, peer, lib, guid, sessionid	Install the given library from the given peer
libraries	include: anonymous		List the libraries installed on this device
libstatus	include: anonymous	lib, metabot	Return the status of the given library or comma delimited list of libraries
rebuildassets		botmanager, lib
sendlib	include: anonymous	lib, peer, metabot	Send the given library to the given peer
uninstall		botmanager, appid	Uninstall the given app
update		metabot, sessionid	Update all libraries installed on this device

Newbound Web Site

ID: "site"
You're looking at it.

The Newbound web site was built, deployed, and is hosted by the MetaBot and the Newbound Network. Connect to the Newbound Network, download the Newbound Web Site app, and check it out for ideas for your own web site!

There are no commands for this app

Newbound.IO

ID: "protocol"
The Newbound.IO website

There are no commands for this app

Notraspberrypi

ID: "notraspberrypi"
The Notraspberrypi application

Command	Permissions	Parameters	Description
despace		s
update

Peer Bot

ID: "peerbot"
Connect this device to other devices on the Newbound Network with a direct encrypted peer-to-peer connection. Choose other devices on your local network or anywhere else on the internet via a Universal Identifier.

Command	Permissions	Parameters	Description
accesscode	include: anonymous	uuid, code	Grant the permissions defined by the given access code to the given peer.
accesscodes			List all access codes for connecting to this device.
addaccesscode		code, groups, delete	Define a new access code. Access code will be single-use if delete=true.
allowanon		allow	Allow or disallow anonymous incoming peer connection requests.
available	include: anonymous	uuid	Returns an error if the given peer is not responding.
brokers		brokers	Get/set the list of connection brokers
connect		uuid, addr, port, code, groups	Connect to a remote device. Optionally, you may pass a suggested IP Address and port number. You can also specify an access code and/or the groups you want to assign the device to. All parameters other than uuid are optional.
connections	include: anonymous		List all of the devices the local device knows how to connect to.
connectionstatus	include: anonymous	uuid	Returns the connection status of the remote device.
deleteaccesscode		code	Delete an existing access code.
deletepeer		uuid	Delete an existing peer connection.
disconnect		uuid	Disconnect from a remote device.
getmachineid	include: anonymous		Returns the name of this device.
getpeerid	include: anonymous		Returns the universal ID of this device.
getpeerinfo	include: anonymous		Returns the connection information about this device.
listzeroconf			Deprecated. Do not use. Use botmanager/discover instead.
local	include: anonymous		Execute a command or http request on the local device. Used internally by the remote command.
lookup	include: anonymous	uuid	Returns the connection information for a specific device.
newconnection		uuid, addr, port, code, groups	Connect to a remote device. Optionally, you may pass a suggested IP Address and port number. You can also specify an access code and/or the groups you want to assign the device to. All parameters other than uuid are optional.
noop	include: anonymous		Do nothing.
pubkey	include: anonymous	uuid	Returns the public key for the given peer.
register	include: anonymous	uuid, local, addresses, port, name	Send information on how to locate yourself to another peer.
remote	include: trusted		Send a command or http request to a remote device. Usage: http://localhost:5773/peerbot/remote/remote-universal-id/botname/cmd?param1=val1¶m2=val2
setpubkey		uuid, pub	Set the public key for the given peer.
setreadkey		uuid, key	Set the read key for the given peer.
stream	include: anonymous	peer, stream, connect	Accepts a bidirectional data stream request with the remote device if connect=true, otherwise disconnects the specified stream.
subscribe	include: anonymous	bot, channel, sessionid	Add the requesting peer to the websocket subscriptions for the given bot and channel.
tempfile	include: anonymous	id, sessionid	Send the temporary file with the given ID to the requesting peer via a new stream. Returns the new stream ID.
togglekeepalive		uuid, keepalive	Specify whether or not this device should attempt to remain connected to the given peer.
websocket	include: anonymous	peer, bot, stream	Open a websocket connection on the remote device and attach it to the given stream.

Port Forwarding

ID: "portforwarding"
Toaster Simple™ secure private networking. Share your Desktop, printer, Minecraft server or anything else with an IP address and port number over the Newbound Network.

Command	Permissions	Parameters	Description
addlocal		ipaddr, port, name	Share a local service.
addremote		peer, id, name, port, ipaddr, peername	Start sharing a remote service.
deletelocal		id	Stop sharing a local service.
deleteremote		id	Stop sharing a remote service.
list	include: trusted, portforward		Returns a list of local and remote shared services.
portforwarding	include: trusted, portforward	id, stream, sessionid	Begin portforwarding the given local share via the given stream with the requesting peer.

Powerstrip

ID: "newboundpowerstrip"
Manage real world sensors and controls with the built-in dashboard interface, or create your own rich HTML5 apps with our powerful JSON API.

Command	Permissions	Parameters	Description
availablecontrols			List the powerstrip-compatible controls in all libraries installed on this device

PushToTalk

ID: "pushtotalk"
Toaster Simple™ secure direct confidential audio between devices.

Command	Permissions	Parameters
noop	include: trusted, talk
peerstatus		uuid
start		uuid
startvoip	include: trusted, talk	stream, sessionid
stop		uuid
stopvoip	include: trusted, talk	sessionid

Raspberrypi

ID: "raspberrypi"
The Raspberrypi application

Command	Permissions	Parameters	Description
detect
diskfree
dl_pi4j		raspberrypi
dlpi4j		raspberrypi
free
ifconfig
info
ipconfig
temp
top
update
upgrade

Security Bot

ID: "securitybot"
Add users and devices to groups, and specify which groups have access to individual apps or app functions.

Command	Permissions	Parameters	Description
currentuser			Return information about the current user.
deleteuser		username	Delete a user.
deviceinfo		requirepassword, syncapps	All parameters are optional. Get or set basic security parameters. Turn security on or off, turn permission synching to defaults for apps on or off.
listapps	include: anonymous		List all apps and their current security settings.
listgroups			List all security groups.
listusers			List all users and peers. The "local" attribute is true for users and false for peers.
newuser		username, realname, password, groups	Create a new user.
resetapps			Reset all apps to their default security settings.
updateapp		include, exclude, id, cmd	Update the security settings for an app. All parameters are optional except id, which is the ID of the app you are updating. The include and exclude parameters are comma separated lists of groups. If the cmd parameter is passed, the include and exclude settings will be applied to that command. Otherwise, the settings will be applied to the app itself.
updateuser		username, displayname, password, groups	Set basic information about the user.

Toolbar

ID: "toolbar"
The Toolbar application

There are no commands for this app

Webcrawler

ID: "webcrawler"
Just type in a website and click the button- The Webcrawler will download any files it can find there. Pull files from a page, part of a website, or the whole site. Use it in conjunction with the Feedbot and you can add any additional processing you like to the files as they come in.

Command	Permissions	Parameters	Description
startjob		url, dir, scope, types, includeothersites	Begin crawling the given website asynchronously.

Yogapose

ID: "yogapose"
The Yogapose application

There are no commands for this app

Newbound Network Architecture
Java and Javascript API
Building Apps with the MetaBot
Building Apps with an IDE
Instructions on how to install the Newbound Network on a Raspberry Pi
Build a Raspberry Pi DVR with noise cancelling motion detection
More...
$("#56c2ffc7-1ed5-4915-8978-3392de0efb32")[0].api = new function() { this.UUID = "56c2ffc7-1ed5-4915-8978-3392de0efb32"; };