Giter VIP home page Giter VIP logo

t1-docs's Introduction

Tessel 1 Documentation

If you are looking for Tessel 2 documentation, go to tessel.io/docs.

This is Tessel. Think of it as a tiny server, or a tiny robot you can control from the internet.

Tessel is programmed in JavaScript, and comes with Wifi built in. Capabilities such as sensing, and actuation can be added to Tessel with plug-and-play modules, or you can do your own wiring through the GPIO bank.

Tessel was designed for web developers to work in the world of hardware for the first time. However, whether you come from a web development background or have spent the last 40 years working in controls systems, we hope that you find Tessel easy and enjoyable to use.

====

To install and get started with Tessel, launch our First Run Experience.

Tessel 1 API Documentation

Tessel 1 Hardware Documentation

Tessel 1 Tutorials

Modules

If there's anything you can't find, something that isn't working, or documentation that we should add, please don't hesitate to reach out to us on the Tessel forums or on the Tessel Github repos.

Technical Machine is open source, hardware and software. We welcome your pull requests, and we encourage you to design your own modules and products based on our designs. Check out the contribution guide for more details.

Once you've made something (building block or whole system; both are useful), please share it with the community on the Projects Page!

We look forward to seeing what you make.

Sincerely,
the Technical Machine Team
(Jon, Jia, Tim, Kelsey, Eric, Kevin, Ken, and Kwyn)

t1-docs's People

Contributors

anaptfox avatar carlqlange avatar ekolker avatar evansimpson avatar frijol avatar hugohabel avatar jiahuang avatar johnnyman727 avatar kevinmehall avatar natevw avatar nlintz avatar nplus11 avatar olegas avatar olsondev avatar reconbot avatar sidwarkd avatar simoncollins avatar tcr avatar tk120404 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

t1-docs's Issues

Frustrating interlinking between t1 and t2 docs

I'd love it if all the t1 documentation lived here, including module documentation. I have an audio module for which there is apparently no documentation, because the t2 doesn't have the audio module?

Interplay between docs repo and other repos?

E.g. CLI docs for Tessel 2 are currently on the t2-cli repo. This seems appropriate, but there should be some obvious way to get to them from the Docs repo.

What else does this apply to? Modules, runtime, etc.

Running Tessel 1 today

Is there a way to get my Tessel 1 up and running today?

I don't seem to be able to install the CLI, due to deprecations and missing projects.
I tried lowering the node and npm versions, but failed to resolve it. Is there a specific setup that I can follow to get it to install again?

screenshot 2018-10-24 at 21 17 10

Pin references

Make a table somewhere of all of the ways you can refer to each pin: 'A3', analog[3], the number the pin knows itself as (23 or something)

T2 development in a virtual environment

We have a virtualbox for development, discussed a bit here but it would be better to have a readme walking people through setting up virtual development & explaining what is & isn't possible

PWM example typo portFrequency > pwmFrequency

In the example:
var tessel = require('tessel'); // import tessel
var gpio = tessel.port['GPIO']; // select the GPIO port
var myPin = gpio.pwm[0]; // can be gpio.pwm[0] through 3 or gpio.pin['G4'] through โ€˜G6โ€™
// Tell the GPIO port that the frequency of its pwm pins is 980 Hz

gpio.portFrequency(980);
/////////////this is wrong >> should be pwmFrequency////////////////

// Set duty cycle
myPin.pwmDutyCycle(0.6); // set the pin to be on 60% of the time

Navigation not scalable

Navigation on tessel.io/docs needs a redesign so that things are easier to find (especially as we add more documentation)

Wifi docs

We have an outdated doc called wifi.md in this repo (but not on the docs page), and we also talk about wifi in the hardware API doc, which is a bit weird. We should update wifi.md, link it properly into docs, and remove the wifi section from hardwareAPI.md.

Node.js version compatibility

Hello.

Viewing the compatibility document, I didn't see the version of Node you're targeting for parity.

Including this would be helpful when selecting appropriate Node modules for use on the Tessel. It would also be helpful for community members looking to contribute to the Tessel runtime.

My hunch would be v0.10.28, but I'm sure this will change over time and be tied to new firmware releases moving forward.

Cheers!

Pin API docs don't distinguish digital vs analog pin methods

The documentation lists methods like pin.input() without distinguishing that they only exist in digital pin objects and not analog pin objects.

For example, the following script

var tessel = require('tessel');

var gpio = tessel.port['GPIO'];

var pin = gpio.pin['A1'];

pin.input();

produces this error

/app/index.js:7: attempt to call method 'input' (a nil value)

Whereas

var tessel = require('tessel');

var gpio = tessel.port['GPIO'];

var pin = gpio.pin['G1'];

pin.input();

works as expected.

Quick check to see the differences in methods:

var tessel = require('tessel');

var gpio = tessel.port['GPIO'];

var pin1 = gpio.pin['G1'];
var pin2 = gpio.pin['A1'];

var getAllMethods = function(object) {
  return Object.getOwnPropertyNames(object).filter(function(property) {
      return typeof object[property] == 'function';
  });
}

console.log("Digital pin:", getAllMethods(pin1));
console.log("Analog pin:", getAllMethods(pin2));
Digital pin: [ input, rawWrite, readSync, read, pull, output, rawRead, high, once, writeSync, set, toggle, removeListener, pulse, removeAllListeners, mode, setOutput, rawDirection, low, write, pulseIn, readPulse, on, setInput, addListener, setMaxListeners, removeListener, removeAllListeners, on, once, listeners, emit ]
Analog pin: [ write, read, readSync ]

i2c.on does not work

trace:

avery@applejack ~/Desktop/tessel/led_proj $ sudo tessel push led_cmdr.js -l
TESSEL! Connected to TM-00-02-f0009a30-00574742-646c45c2.
WARN Error: No package.json or node_modules found, pushing just this file.
Bundling directory /home/avery/Desktop/tessel/led_proj (~137 bytes)
Deploying bundle (4.50 KB)...
Running script...
/app/led_cmdr.js:14: attempt to call method 'on' (a nil value)
stack traceback:
/app/led_cmdr.js:14: in function 'res'
[T]: src/colony/lua/colony-node.lua:14: in function 'run'
[T]: src/colony/lua/colony-node.lua:14: in function 'require'
/_start.js:14: in function 'res'
[T]: src/colony/lua/colony-node.lua:14: in function 'run'
[T]: src/colony/lua/cli.lua:14: in main chunk
[C]: in function 'require'
[T]: runtime:1: in main chunk

However, for SPI, the SPI.on function works fine.

Unintended text in sidebar

On Chrome & Safari at least, I see the following text at the very bottom (may need to scroll to end of page) of the left sidebar on pages like: https://tessel.io/docs/home:

isMobile()) : ?>

But it's a little odd as the source in question contains:

<!-- Google Plus -->
<?php $detect = new Mobile_Detect(); if (!$detect->isMobile()) : ?>
<img style="display: none;" onLoad="google_plus_user(true)" alt="" src="https://plus.google.com/up/?continue=https://www.google.com/intl/en/images/logos/accounts_logo.png&amp;type=st&amp;gpsrc=ogpy0" />
<?php endif; ?>

But when viewed via Inspect Element it shows as:

<!--?php $detect = new Mobile_Detect(); if (!$detect--->

i.e. the -> seems to get converted to --->.

So, whatever the cause, presumably this section isn't working as intended.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.