npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@tegh/protocol

v0.5.3

Published

### TeghClient - Connecting to a Tegh 3D Printer

Downloads

6

Readme

A javascript library for making things that work with Tegh 3D printers in node, react native and the browser.

Useage

TeghClient - Connecting to a Tegh 3D Printer

import { TeghClient } from '@tegh/protocol'
import keypair from 'keypair'

// Generate a public and private key using the `keypair` npm module. This will
// identify you to the 3D printer so you only want to save this somewhere and
// re-use it on future connections.
var keys = keypair()
var signallingServer = 'ws://localhost:3000'

// create a tegh client
const teghClient = TeghClient({
  keys: keys,
  // The public key of the 3D printer. This uniquely identifies your 3D printer
  // and allows us to end-to-end encrypt everything you do with it. Usually
  // the public key is retreaved by scanning the QR Code displayed by Tegh on
  // the 3D printer's screen.
  peerPublicKey: '<your 3d printer public key here>',
  // provides access to the underlying SimplePeer object. This can be used to
  // access media tracks. Note: onConnect may be called more then once
  // if the 3d printer is re-connected.
  onConnect: (simplePeer) => {
    // access media tracks here
    console.log('web rtc connected', simplePeer)
  },
})

// the tegh client exposes an API that is compatible with `window.WebSocket` so
// we can use it with existing libaries which were designed for Web Sockets.
// Here we're using it with `subscriptions-transport-ws` for Apollo JS.
var subscriptionClient = new SubscriptionClient(signallingServer, {
  reconnect: true,
}, teghClient)

var wsLink = new WebSocketLink(subscriptionClient)

var apolloClient = new ApolloClient({
  link: wsLink,
  cache: new InMemoryCache(),
})

React.render(
  (
    <ApolloProvider client={ apolloClient }>
      <Query
        query= 'query { printers { name, status }}'
        render= {(query) => {
          <div>
            {printer.name}: {printer.status}
          </div>
        }}
      />
    </ApolloProvider>
  ),
  document.getElementByID('main'),
)

TeghHost - Acting as a Tegh 3D Printer

import { TeghClient } from '@tegh/protocol'
import keypair from 'keypair'

// Generate a public and private key using the `keypair` npm module. This will
// identify you to the 3D printer so you only want to save this somewhere and
// re-use it on future connections.
var keys = keypair()
var signallingServer = 'ws://localhost:3000'

TeghHost({
  signallingServer: signallingServer,
  keys: keys,
  //
  authenticate: (userPublicKey) => {
    // `isAuthorized` is not defined in this example. Use your own authorization
    // function instead and return false if the user is unauthorized to connect.
    if (isAuthorized(userPublicKey)) return false
    return {
      connectedAt: Date.now(),
      userPublicKey: userPublicKey,
    },
  }
})