Sphero API MATLAB SDK - Revision history

Mark: /* Simple Example Script */ change lexer

2016-04-24T04:07:11Z

Simple Example Script: change lexer

← Older revision		Revision as of 04:07, 24 April 2016
Line 316:		Line 316:

	;Example Script		;Example Script
	<~~pre~~>		<syntaxhighlight lang="matlab" line >
	% create bluetooth object		% create bluetooth object
	disp('Creating Bluetooth object ...');		disp('Creating Bluetooth object ...');
Line 383:		Line 383:
	delete(bt);		delete(bt);
	clear bt;		clear bt;
	</~~pre~~>		</syntaxhighlight>

	;Example Script Output		;Example Script Output

Mark: add link to preview video on youtube

2016-04-21T04:50:36Z

add link to preview video on youtube

← Older revision		Revision as of 04:50, 21 April 2016
Line 15:		Line 15:

	Source code can be found on Matlab File Exchange for my current project, Sphero API Matlab SDK, <ref name="sphero-api-matlab-sdk">Sphero API Matlab SDK; Author: Mark Tomaszewski; Source: [http://www.mathworks.com/matlabcentral/fileexchange/52746-sphero-api-matlab-sdk http://www.mathworks.com/matlabcentral/fileexchange/52746-sphero-api-matlab-sdk] </ref> as well as the original Sphero MATLAB Interface <ref name="sphero-matlab-interface"> Sphero MATLAB Interface; Author: Yi Jui Lee; Contributor: Mark Tomaszewski; Source: [http://www.mathworks.com/matlabcentral/fileexchange/48359-sphero-matlab-interface http://www.mathworks.com/matlabcentral/fileexchange/48359-sphero-matlab-interface] </ref> authored by Yi Jui Lee.		Source code can be found on Matlab File Exchange for my current project, Sphero API Matlab SDK, <ref name="sphero-api-matlab-sdk">Sphero API Matlab SDK; Author: Mark Tomaszewski; Source: [http://www.mathworks.com/matlabcentral/fileexchange/52746-sphero-api-matlab-sdk http://www.mathworks.com/matlabcentral/fileexchange/52746-sphero-api-matlab-sdk] </ref> as well as the original Sphero MATLAB Interface <ref name="sphero-matlab-interface"> Sphero MATLAB Interface; Author: Yi Jui Lee; Contributor: Mark Tomaszewski; Source: [http://www.mathworks.com/matlabcentral/fileexchange/48359-sphero-matlab-interface http://www.mathworks.com/matlabcentral/fileexchange/48359-sphero-matlab-interface] </ref> authored by Yi Jui Lee.

			Check out this [https://youtu.be/YohxMa_z4Ww video Preview on YouTube] to see a glimpse of what this package can do.

	== Overview ==		== Overview ==

Mark: Marktoma moved page Sphero API Matlab SDK to Sphero API MATLAB SDK

2016-04-18T03:15:01Z

Marktoma moved page Sphero API Matlab SDK to Sphero API MATLAB SDK

← Older revision	Revision as of 03:15, 18 April 2016
(No difference)

Mark at 07:30, 27 November 2015

2015-11-27T07:30:15Z

← Older revision		Revision as of 07:30, 27 November 2015
Line 3:		Line 3:

	'''[[#Overview\|Overview]] and [[#Bluetooth Communication Basics\|Bluetooth Communication Basics]] are complete!'''		'''[[#Overview\|Overview]] and [[#Bluetooth Communication Basics\|Bluetooth Communication Basics]] are complete!'''

			'''I'm actively working on [[#Writing Library Functions\|Writing Library Functions]]'''

	I'm planning to use this page to document the '''development''' of the Matlab code from the low-level binary communications API provided by Sphero. Other information about the code such as class documentation, release notes, and change logs ''might'' get it's own page on this site (it won't on this one), but most likely will be included only in the m-code itself.		I'm planning to use this page to document the '''development''' of the Matlab code from the low-level binary communications API provided by Sphero. Other information about the code such as class documentation, release notes, and change logs ''might'' get it's own page on this site (it won't on this one), but most likely will be included only in the m-code itself.

Mark: added full url to ext link display text in two refs

2015-11-27T07:28:28Z

added full url to ext link display text in two refs

← Older revision		Revision as of 07:28, 27 November 2015
Line 8:		Line 8:
	Readers may find it beneficial to read through my explanation of the [[Sphero API Tutorial\|low-level binary Sphero API]] before proceeding into the Matlab implementation development contained herein. Official documentation of Sphero API can be found in Sphero API Quick Reference at sphero.com <ref name="sphero-api-web">		Readers may find it beneficial to read through my explanation of the [[Sphero API Tutorial\|low-level binary Sphero API]] before proceeding into the Matlab implementation development contained herein. Official documentation of Sphero API can be found in Sphero API Quick Reference at sphero.com <ref name="sphero-api-web">
	Sphero Docs API Quick Reference;		Sphero Docs API Quick Reference;
	Source: [http://sdk.sphero.com/api-reference/api-quick-reference/]</ref> as well as Sphero API Developer Resources documentation on GitHub <ref name="sphero-api-github">		Source: [http://sdk.sphero.com/api-reference/api-quick-reference/ http://sdk.sphero.com/api-reference/api-quick-reference/]</ref> as well as Sphero API Developer Resources documentation on GitHub <ref name="sphero-api-github">
	Sphero Developer Resources (Orbotix) on GitHub;		Sphero Developer Resources (Orbotix) on GitHub;
	Source: [https://github.com/orbotix/DeveloperResources/tree/master/docs]</ref>		Source: [https://github.com/orbotix/DeveloperResources/tree/master/docs https://github.com/orbotix/DeveloperResources/tree/master/docs]</ref>

	Source code can be found on Matlab File Exchange for my current project, Sphero API Matlab SDK, <ref name="sphero-api-matlab-sdk">Sphero API Matlab SDK; Author: Mark Tomaszewski; Source: [http://www.mathworks.com/matlabcentral/fileexchange/52746-sphero-api-matlab-sdk http://www.mathworks.com/matlabcentral/fileexchange/52746-sphero-api-matlab-sdk] </ref> as well as the original Sphero MATLAB Interface <ref name="sphero-matlab-interface"> Sphero MATLAB Interface; Author: Yi Jui Lee; Contributor: Mark Tomaszewski; Source: [http://www.mathworks.com/matlabcentral/fileexchange/48359-sphero-matlab-interface http://www.mathworks.com/matlabcentral/fileexchange/48359-sphero-matlab-interface] </ref> authored by Yi Jui Lee.		Source code can be found on Matlab File Exchange for my current project, Sphero API Matlab SDK, <ref name="sphero-api-matlab-sdk">Sphero API Matlab SDK; Author: Mark Tomaszewski; Source: [http://www.mathworks.com/matlabcentral/fileexchange/52746-sphero-api-matlab-sdk http://www.mathworks.com/matlabcentral/fileexchange/52746-sphero-api-matlab-sdk] </ref> as well as the original Sphero MATLAB Interface <ref name="sphero-matlab-interface"> Sphero MATLAB Interface; Author: Yi Jui Lee; Contributor: Mark Tomaszewski; Source: [http://www.mathworks.com/matlabcentral/fileexchange/48359-sphero-matlab-interface http://www.mathworks.com/matlabcentral/fileexchange/48359-sphero-matlab-interface] </ref> authored by Yi Jui Lee.

Mark: fixed closing quote on sphero-matlab-interface ref name attribute

2015-11-27T07:26:36Z

fixed closing quote on sphero-matlab-interface ref name attribute

← Older revision		Revision as of 07:26, 27 November 2015
Line 12:		Line 12:
	Source: [https://github.com/orbotix/DeveloperResources/tree/master/docs]</ref>		Source: [https://github.com/orbotix/DeveloperResources/tree/master/docs]</ref>

	Source code can be found on Matlab File Exchange for my current project, Sphero API Matlab SDK, <ref name="sphero-api-matlab-sdk">Sphero API Matlab SDK; Author: Mark Tomaszewski; Source: [http://www.mathworks.com/matlabcentral/fileexchange/52746-sphero-api-matlab-sdk http://www.mathworks.com/matlabcentral/fileexchange/52746-sphero-api-matlab-sdk] </ref> as well as the original Sphero MATLAB Interface <ref name="sphero-matlab-interface> Sphero MATLAB Interface; Author: Yi Jui Lee; Contributor: Mark Tomaszewski; Source: [http://www.mathworks.com/matlabcentral/fileexchange/48359-sphero-matlab-interface http://www.mathworks.com/matlabcentral/fileexchange/48359-sphero-matlab-interface] </ref> authored by Yi Jui Lee.		Source code can be found on Matlab File Exchange for my current project, Sphero API Matlab SDK, <ref name="sphero-api-matlab-sdk">Sphero API Matlab SDK; Author: Mark Tomaszewski; Source: [http://www.mathworks.com/matlabcentral/fileexchange/52746-sphero-api-matlab-sdk http://www.mathworks.com/matlabcentral/fileexchange/52746-sphero-api-matlab-sdk] </ref> as well as the original Sphero MATLAB Interface <ref name="sphero-matlab-interface"> Sphero MATLAB Interface; Author: Yi Jui Lee; Contributor: Mark Tomaszewski; Source: [http://www.mathworks.com/matlabcentral/fileexchange/48359-sphero-matlab-interface http://www.mathworks.com/matlabcentral/fileexchange/48359-sphero-matlab-interface] </ref> authored by Yi Jui Lee.

	== Overview ==		== Overview ==

Mark: fixed missing closing ref tag for sphero-matlab-interface

2015-11-27T07:22:29Z

fixed missing closing ref tag for sphero-matlab-interface

← Older revision		Revision as of 07:22, 27 November 2015
Line 12:		Line 12:
	Source: [https://github.com/orbotix/DeveloperResources/tree/master/docs]</ref>		Source: [https://github.com/orbotix/DeveloperResources/tree/master/docs]</ref>

	Source code can be found on Matlab File Exchange for my current project, Sphero API Matlab SDK, <ref name="sphero-api-matlab-sdk">Sphero API Matlab SDK; Author: Mark Tomaszewski; Source: [http://www.mathworks.com/matlabcentral/fileexchange/52746-sphero-api-matlab-sdk http://www.mathworks.com/matlabcentral/fileexchange/52746-sphero-api-matlab-sdk] </ref> as well as the original Sphero MATLAB Interface <ref name="sphero-matlab-interface> Sphero MATLAB Interface; Author: Yi Jui Lee; Contributor: Mark Tomaszewski; Source: [http://www.mathworks.com/matlabcentral/fileexchange/48359-sphero-matlab-interface http://www.mathworks.com/matlabcentral/fileexchange/48359-sphero-matlab-interface], authored by Yi Jui Lee.		Source code can be found on Matlab File Exchange for my current project, Sphero API Matlab SDK, <ref name="sphero-api-matlab-sdk">Sphero API Matlab SDK; Author: Mark Tomaszewski; Source: [http://www.mathworks.com/matlabcentral/fileexchange/52746-sphero-api-matlab-sdk http://www.mathworks.com/matlabcentral/fileexchange/52746-sphero-api-matlab-sdk] </ref> as well as the original Sphero MATLAB Interface <ref name="sphero-matlab-interface> Sphero MATLAB Interface; Author: Yi Jui Lee; Contributor: Mark Tomaszewski; Source: [http://www.mathworks.com/matlabcentral/fileexchange/48359-sphero-matlab-interface http://www.mathworks.com/matlabcentral/fileexchange/48359-sphero-matlab-interface] </ref> authored by Yi Jui Lee.

	== Overview ==		== Overview ==

Mark at 07:20, 27 November 2015

2015-11-27T07:20:54Z

@@ Line 12: / Line 12: @@
 Source: [https://github.com/orbotix/DeveloperResources/tree/master/docs]</ref>
-Source code can be found on Matlab File Exchange for my current project, [http://www.mathworks.com/matlabcentral/fileexchange/52746-sphero-api-matlab-sdk| Sphero API Matlab SDK] as well as the original [http://www.mathworks.com/matlabcentral/fileexchange/48359-sphero-matlab-interface| Sphero MATLAB Interface], co-authored by Yi Jui Lee and myself.
+Source code can be found on Matlab File Exchange for my current project, Sphero API Matlab SDK, <ref name="sphero-api-matlab-sdk">Sphero API Matlab SDK; Author: Mark Tomaszewski; Source: [http://www.mathworks.com/matlabcentral/fileexchange/52746-sphero-api-matlab-sdk http://www.mathworks.com/matlabcentral/fileexchange/52746-sphero-api-matlab-sdk] </ref> as well as the original Sphero MATLAB Interface <ref name="sphero-matlab-interface> Sphero MATLAB Interface; Author: Yi Jui Lee; Contributor: Mark Tomaszewski; Source: [http://www.mathworks.com/matlabcentral/fileexchange/48359-sphero-matlab-interface http://www.mathworks.com/matlabcentral/fileexchange/48359-sphero-matlab-interface], authored by Yi Jui Lee.
 == Overview ==
@@ Line 396: / Line 396: @@
 The code examples presented in [[#Bluetooth Communcation Basics|Bluetooth Communcation Basics]] offer most of the critical functionality desired in a programmatic interface to Sphero. However, the scripting approach to program development is to write, maintain, and reuse when incorporating Sphero into larger programs. The next step of development involves writing self-contained functions that perform the core functionality of a Sphero interface based upon the previous [[#Bluetooth Communication Basics|examples]].
-Note that in writing this function library, we will adopt a data-oriented model for the function input parameters and output parameters. Since the Sphero device has data that requires bookkeeping, we'll pass a <code>struct</code> variable through function calls to keep track of Sphero's state.
+In writing this function library, we will adopt a data-oriented model for the function input parameters and output parameters. Since the Sphero device has data that requires bookkeeping, we'll pass a <code>struct</code> variable through function calls to keep track of Sphero's state.
-In this exercise, we'll begin with developing functions based upon the logic contained in Yi Jui's Sphero MATLAB Interface
+We'll begin with developing functions based upon the logic contained in Yi Jui's Sphero MATLAB Interface. <ref name="sphero-matlab-interface" />
 === Data Model and Initialization ===
@@ Line 404: / Line 405: @@
 Early on, we've chosen to consciously keep track of Sphero's device state and data in a <code>struct</code> that we'll call <code>s</code>, for Sphero. Although we're only writing a function library at this point, adopting the convention of passing <code>s</code> as the first input argument and returning it as the first output better sets us up for transitioning to a [[#Device Class Encapsulation|device class]] later on.
-Throughout development of the function library, it's a really good idea to keep track of the fields you're introducing in <code>s</code>. At this point, we may not necessarily know what these fields are going to be, but I will keep a running list here,
+Before really working on the core functionality of the function library, we'll begin by writing a function that constructs <code>s</code>. Here, we'll choose to name the function based upon the object that the data represents, i.e. Sphero.
 <pre>
-s.bt = []; % Bluetooth object
+s = Sphero();
 </pre>
 === Connection Utility ===
-{{Work In Progress|Section}}
+Once <code>Sphero</code> is used to create an empty Sphero object, we need a way to create and open a Bluetooth connection to Sphero.
 === Send and Receive ===

Mark: /* Writing Library Functions */

2015-11-27T06:44:35Z

Writing Library Functions

@@ Line 393: / Line 393: @@
 == Writing Library Functions ==
-{{Work In Progress|Section}}
+The code examples presented in [[#Bluetooth Communcation Basics|Bluetooth Communcation Basics]] offer most of the critical functionality desired in a programmatic interface to Sphero. However, the scripting approach to program development is to write, maintain, and reuse when incorporating Sphero into larger programs. The next step of development involves writing self-contained functions that perform the core functionality of a Sphero interface based upon the previous [[#Bluetooth Communication Basics|examples]].
 === Connection Utility ===

Mark at 02:29, 24 November 2015

2015-11-24T02:29:55Z

← Older revision		Revision as of 02:29, 24 November 2015
Line 2:		Line 2:
	{{Work In Progress\|Page}}		{{Work In Progress\|Page}}

	'''[[Overview]] and [[Bluetooth Communication Basics]] are complete!'''		'''[[#Overview\|Overview]] and [[#Bluetooth Communication Basics\|Bluetooth Communication Basics]] are complete!'''

	I'm planning to use this page to document the '''development''' of the Matlab code from the low-level binary communications API provided by Sphero. Other information about the code such as class documentation, release notes, and change logs ''might'' get it's own page on this site (it won't on this one), but most likely will be included only in the m-code itself.		I'm planning to use this page to document the '''development''' of the Matlab code from the low-level binary communications API provided by Sphero. Other information about the code such as class documentation, release notes, and change logs ''might'' get it's own page on this site (it won't on this one), but most likely will be included only in the m-code itself.