com-chilipeppr-widget-touchplate

This widget helps you use a touch plate to create your Z zero offset.

ChiliPeppr Widget / GRBL Touch Plate

All ChiliPeppr widgets/elements are defined using cpdefine() which is a method that mimics require.js. Each defined object must have a unique ID so it does not conflict with other ChiliPeppr widgets.

Item	Value
ID	com-chilipeppr-widget-touchplate
Name	Widget / GRBL Touch Plate
Description	This widget helps you use a touch plate to create your Z zero offset.
chilipeppr.load() URL	http://raw.githubusercontent.com/johnlauer/widget-grbl-touchplate/master/auto-generated-widget.html
Edit URL	http://ide.c9.io/johnlauer/widget-grbl-touchplate
Github URL	https://github.com/johnlauer/widget-grbl-touchplate
Test URL	https://preview.c9users.io/johnlauer/widget-grbl-touchplate/widget.html

Example Code for chilipeppr.load() Statement

You can use the code below as a starting point for instantiating this widget inside a workspace or from another widget. The key is that you need to load your widget inlined into a div so the DOM can parse your HTML, CSS, and Javascript. Then you use cprequire() to find your widget's Javascript and get back the instance of it.

// Inject new div to contain widget or use an existing div with an ID
$("body").append('<' + 'div id="myDivWidgetTouchplate"><' + '/div>');

chilipeppr.load(
  "#myDivWidgetTouchplate",
  "http://raw.githubusercontent.com/johnlauer/widget-grbl-touchplate/master/auto-generated-widget.html",
  function() {
    // Callback after widget loaded into #myDivWidgetTouchplate
    // Now use require.js to get reference to instantiated widget
    cprequire(
      ["inline:com-chilipeppr-widget-touchplate"], // the id you gave your widget
      function(myObjWidgetTouchplate) {
        // Callback that is passed reference to the newly loaded widget
        console.log("Widget / GRBL Touch Plate just got loaded.", myObjWidgetTouchplate);
        myObjWidgetTouchplate.init();
      }
    );
  }
);

Publish

This widget/element publishes the following signals. These signals are owned by this widget/element and are published to all objects inside the ChiliPeppr environment that listen to them via the chilipeppr.subscribe(signal, callback) method. To better understand how ChiliPeppr's subscribe() method works see amplify.js's documentation at http://amplifyjs.com/api/pubsub/

Signal	Description
(No signals defined in this widget/element)

Subscribe

This widget/element subscribes to the following signals. These signals are owned by this widget/element. Other objects inside the ChiliPeppr environment can publish to these signals via the chilipeppr.publish(signal, data) method. To better understand how ChiliPeppr's publish() method works see amplify.js's documentation at http://amplifyjs.com/api/pubsub/

Signal	Description
(No signals defined in this widget/element)

Foreign Publish

This widget/element publishes to the following signals that are owned by other objects. To better understand how ChiliPeppr's subscribe() method works see amplify.js's documentation at http://amplifyjs.com/api/pubsub/

Signal	Description
(No signals defined in this widget/element)

Foreign Subscribe

This widget/element publishes to the following signals that are owned by other objects. To better understand how ChiliPeppr's publish() method works see amplify.js's documentation at http://amplifyjs.com/api/pubsub/

Signal	Description
(No signals defined in this widget/element)

Methods / Properties

The table below shows, in order, the methods and properties inside the widget/element.

Method / Property	Type	Description
id	string	"com-chilipeppr-widget-touchplate"
url	string	"http://raw.githubusercontent.com/johnlauer/widget-grbl-touchplate/master/auto-generated-widget.html"
fiddleurl	string	"http://ide.c9.io/johnlauer/widget-grbl-touchplate"
githuburl	string	"https://github.com/johnlauer/widget-grbl-touchplate"
testurl	string	"http://widget-grbl-touchplate-johnlauer.c9users.io/widget.html"
name	string	"Widget / GRBL Touch Plate"
desc	string	"This widget helps you use a touch plate to create your Z zero offset."
publish	object	Please see docs above.
subscribe	object	Please see docs above.
foreignPublish	object	Please see docs above.
foreignSubscribe	object	Please see docs above.
isInitted	boolean
offset	number
width	number
height	number
init	function	function ()
gcodeCtr	number
isRunning	boolean
onRun	function	function (evt)
probeResponse	function	function (position)
onresize	function	function ()
dispatch	function	function ( array, event )
request	object
isHidden	boolean
unactivateWidget	function	function ()
activateWidget	function	function ()
options	object
setupUiFromLocalStorage	function	function ()
saveOptionsLocalStorage	function	function ()
showBody	function	function (evt)
hideBody	function	function (evt)
btnSetup	function	function ()
statusEl	object
status	function	function (txt)
forkSetup	function	function ()

About ChiliPeppr

ChiliPeppr is a hardware fiddle, meaning it is a website that lets you easily create a workspace to fiddle with your hardware from software. ChiliPeppr provides a Serial Port JSON Server that you run locally on your computer, or remotely on another computer, to connect to the serial port of your hardware like an Arduino or other microcontroller.

You then create a workspace at ChiliPeppr.com that connects to your hardware by starting from scratch or forking somebody else's workspace that is close to what you are after. Then you write widgets in Javascript that interact with your hardware by forking the base template widget or forking another widget that is similar to what you are trying to build.

ChiliPeppr is massively capable such that the workspaces for TinyG and Grbl CNC controllers have become full-fledged CNC machine management software used by tens of thousands.

ChiliPeppr has inspired many people in the hardware/software world to use the browser and Javascript as the foundation for interacting with hardware. The Arduino team in Italy caught wind of ChiliPeppr and now ChiliPeppr's Serial Port JSON Server is the basis for the Arduino's new web IDE. If the Arduino team is excited about building on top of ChiliPeppr, what will you build on top of it?