tessel / t2-docs Goto Github PK

Similar to npm, the t2-cli looks for a .tesselinclude dotfile to use in whitelisting files being sent over to Tessel 2 when pushing/running code, especially during the --slim bundling process. Reference

This should be documented in the Tessel docs, probably under the Tessel 2 CLI page.

Find schematics etc. at https://tessel.io/opensource

Find schematics etc. at https://tessel.io/opensource

Should include:

• how to power not over USB
• range of allowed voltages
• hot-swapping
• sleep modes

Extremely low contrast ratio on that (error, value) after function:

https://tessel.io/docs/hardwareAPI#usb-ports

Needs to be updated to https://github.com/tessel/tessel-av

Find schematics etc. at https://tessel.io/opensource

accessing Wifi from the JS

The PWM docs have a decent description and code example but I'm still having trouble understanding how pwmFrequency and pwmDutyCycle work.

I think it would be nice to match the structure of the Pin Interrupts docs:

• add a working Fritzing example to match the code sample (maybe with an RGB LED)
• add a "Usage" section that describes what values pwmFrequency & pwmDutyCyle take as arguments (see the Interrupts usage section as an example)

Check out the t2-firmware source for more info about how each method works:

• pwmFrequency
• pwmDutyCycle

Feel free to ping me or post in Tessel Slack #community channel with question or if review is needed.

These docs needs to be updated to remove this outdated note.

Find schematics etc. at https://tessel.io/opensource

var spi = new port.SPI({
  clockSpeed: 4*1000*1000, // 4MHz
  cpol: 1, // polarity
  cpha: 0, // clock phase
});

Is there a reason for assigning clockSpeed the value of an expression to be evaluated, versus just the number?

var spi = new port.SPI({
  clockSpeed: 4000000, // 4MHz
  cpol: 1, // polarity
  cpha: 0, // clock phase
});

Also, we should deprecate (with aliasing) clockSpeed, cpol and cphase in favor of parameters that are named something less hostile.

Recommending:

As reported by a member of the community on Slack, the example of i2c.transfer is incorrect because it's missing the read length argument.

The TOC at the top lists:

• PWM pins
• SPI
• I2C
• UART/Serial

But the sections are actually:

• PWM pins
• I2C
• Terms Used
• SPI
• UART/Serial

I suggest reordering the sections to:

• PWM pins
• Terms Used
• I2C
• SPI
• UART/Serial

And the TOC to match

There is now another networking utility available through t2-cli: creating access points, i.e. personal wifi networks, on the Tessel 2. It should be documented because it's pretty dang cool. Reference

Find schematics etc. at https://tessel.io/opensource

As discussed in the t2-firmware issue (tessel/t2-firmware#107 (comment)), the Tessel button is now reserved as a reset button instead of being exposed through the tessel module. The docs should be updated to reflect this decision.

I believe the button docs should go in it's own section within Hardware-API page, instead of grouped with the LEDs (https://github.com/tessel/t2-docs/blob/master/hardware-api.md#button-and-leds).

@johnnyman727 what do you think about moving the information from https://github.com/tessel/onboarding into this repo?

Particularly, this could be a great place to keep the technical overview.

Additionally, it seems like the things in that repo generally belong either here or on the Tessel Project repo.

Moving @HipsterBrown's issue from tessel/t2-cli#384:

Similar to npm, the t2-cli looks for a .tesselignore dotfile to use in blacklisting files being sent over to Tessel 2 when pushing/running code. Reference

This should be documented in the Tessel docs, probably under the Tessel 2 CLI page.

Find schematics etc. at https://tessel.io/opensource

In #69 I used a local path to a Fritzing diagram so the link is broken in the hardware API docs.

I can just make a PR to update the URL but I wanted to check in case the team thinks we should host these images elsewhere.

@HipsterBrown

It would be cool if we had a library of quick examples for how to use different APIs.
A good starting set: PubNub, Twilio, Plotly, Firebase, ...

I'm envisioning a setup whereby we have a JSON linking to hackster embed links

(example of hackster embedded: from http://tessel.github.io/t2-start/modules/ambient.html

)

And then a view that pulls from there to some grid layout on tessel.io/docs.

This makes it easy for people who want to showcase their APIs to quickly make an example and show it off on our site, which lends itself to lots of great examples and options for our community.

Related: tessel/t2-start#4

Our current docs are pretty haphazardly and messily imported (see tessel/tessel.io#13 and tessel/tessel.io#14). I strongly suspect using Gitbook instead of rolling our own docs format would be a better experience.

Should be more helpful:

• What is a Tessel, and what's the point of it?
• How can I get more information?

Find schematics etc. at https://tessel.io/opensource

The t2 wifi command was updated to allow connecting to networks without passwords and the ability to pass in a different security option than psk2. Reference

Of course, this is subjective, but there are parts that are actually completely unreadable, like the parameter list syntax of functions.

I suggest that we put all of these into gists that are embedded in the docs

Should have:

• Diagram of T2
• Link to Fritzing part
• Suggestion to contribute & how to get started
• Some kind of "looking for T1?" link

Hello,

I thing docs need to update. I tried on/off commands as t2 wifi, and it works. But not at the t2 ap.

Find schematics etc. at https://tessel.io/opensource

Find schematics etc. at https://tessel.io/opensource

Find schematics etc. at https://tessel.io/opensource

Find schematics etc. at https://tessel.io/opensource

According to the docs:

pin.analogWrite(0.6); // turn pin to 60% of high

But I found that rather than ~2V, it set the pin to 0.6V. Not sure if it's a docs problem or a software problem -- but I did find it surprising (I expected analogWrite(1) to set the pin to 3.3V, not 1V.)

Let's pick: for callbacks, err or error?

The Tessel LEDs are exposed through the tessel npm module. The docs can now be updated to reflect that update.

There are many uses of the master/slave terminology within the hardware API and communication protocols documentation. Much like the django project and many others, we should replace these references with more appropriate and accurate wording, i.e. primary/replica.

/use any USB device on T2

Find schematics etc. at https://tessel.io/opensource

https://github.com/tessel/t2-docs/blob/master/hardware-api.md#pwm-pins

After have some problem listing and using the t2 over LAN [0], I tried to disable the firewall at Ubuntu 14.04 and it solved my problem.

Shouldn't we add required ports (mdns for ex.) to the docs ?

[0] tessel/t2-cli#650

We don't currently list which pins can receive interrupts. Based on this line, it looks like pins 2, 5, 6, and 7 support interrupts. The support interrupts types are listed here.