Skip to content

PyroAVR/widget-super-touchplate

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

com-chilipeppr-widget-super-touchplate

This widget helps you use a touch plate to find the origin on your workpiece.

ChiliPeppr Widget / Super 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-super-touchplate
Name Widget / Super Touch Plate
Description This widget helps you use a touch plate to find the origin on your workpiece.
chilipeppr.load() URL http://raw.githubusercontent.com/PyroAVR/widget-super-touchplate/master/auto-generated-widget.html
Edit URL http://ide.c9.io/pyroavr/widget-super-touchplate
Github URL http://github.com/PyroAVR/widget-super-touchplate
Test URL https://preview.c9users.io/pyroavr/widget-super-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.

chilipeppr.load(
  "#myDivWidgetInsertedInto",
  "http://raw.githubusercontent.com/PyroAVR/widget-super-touchplate/master/auto-generated-widget.html",
  function() {
    // Callback after widget loaded into #myDivWidgetInsertedInto
    cprequire(
      ["inline:com-chilipeppr-widget-super-touchplate"], // the id you gave your widget
      function(mywidget) {
        // Callback that is passed reference to your newly loaded widget
        console.log("My widget just got loaded.", mywidget);
        mywidget.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
idstring"com-chilipeppr-widget-super-touchplate"
urlstring"http://raw.githubusercontent.com/PyroAVR/widget-super-touchplate/master/auto-generated-widget.html"
fiddleurlstring"http://ide.c9.io/pyroavr/widget-super-touchplate"
githuburlstring"http://github.com/PyroAVR/widget-super-touchplate"
testurlstring"http://widget-super-touchplate-pyroavr.c9users.io/widget.html"
namestring"Widget / Super Touch Plate"
descstring"This widget helps you use a touch plate to find the origin on your workpiece."
subscribeobjectPlease see docs above.
foreignPublishobjectPlease see docs above.
foreignSubscribeobjectPlease see docs above.
isInittedboolean
initfunctionfunction ()
audioobject
loaderobject
cameraobject
sceneobject
rendererobject
scriptsobject
domundefined
widthnumber
heightnumber
touchplateobject
spindleobject
lightobject
initUIfunctionfunction ()
init3dfunctionfunction ()
introAnimfunctionfunction ()
deltaxobject
deltayobject
deltafovobject
curVobject
curFovobject
curStepobject
stepsobject
introAnimStepfunctionfunction ()
gcodeCtrnumber
isRunningboolean
runZAxisfunctionfunction ()
runXAxisfunctionfunction ()
runYAxisfunctionfunction ()
onRunfunctionfunction (axis)
watchForProbeStartfunctionfunction ()
watchForProbeEndfunctionfunction ()
onRecvLineForProbefunctionfunction (data)
onAfterProbeDonefunctionfunction (probeData)
isAnimInfiniteRunningboolean
animInfiniteCallbackobject
animInfiniteStartfunctionfunction ()
animInfiniteEndfunctionfunction ()
animInfinitefunctionfunction ()
onresizefunctionfunction ()
loadfunctionfunction (json)
setCamerafunctionfunction (value)
setSizefunctionfunction (width, height)
dispatchfunctionfunction (array, event)
requestobject
animatefunctionfunction (time)
isHiddenboolean
unactivateWidgetfunctionfunction ()
activateWidgetfunctionfunction ()
isVidLoadedboolean
lazyLoadTutorialfunctionfunction ()
optionsobject
setupUiFromLocalStoragefunctionfunction ()
saveOptionsLocalStoragefunctionfunction ()
showBodyfunctionfunction (evt)
hideBodyfunctionfunction (evt)
btnSetupfunctionfunction ()
statusElobject
statusfunctionfunction (txt)
forkSetupfunctionfunction ()
threeObjobject

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?

About

A more sophisticated touchplate widget for Chilipeppr.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •