kaluma-project / local-project-sample Goto Github PK

This is a sample project to setup a local kaluma project.

All local files are from a kaluma cloud project (https://kaluma.io/@niklauslee/internet-clock).

Create a project folder with the below files and directories.

my-local-project/
  kaluma_modules/    # third-party modules
  package.json       # project configuration
  index.js           # entry point
  webpack.config.js  # webpack configuration for bundling

Download modules in dependencies of package.json from kaluma.io and extract them into kaluma_modules as below folder structure.

Please ensure that you are downloaded the correct version of the module from Releases page for each module project.

kaluma_modules/
  @niklauslee/
    ssd1306-i2c/
    font-minimal/
    esp8266-http-client/
  @kaluma/
    logo-mono/

The downloaded modules could have it's dependencies, so the dependencies should be downloaded and extracted into kaluma_modules recursively.

Install webpack and webpack-cli.

$ npm install webpack webpack-cli --save-dev

Don't try npm install. It will try to install all modules in dependencies of package.json from NPM.

Edit webpack.config.js as below:

const path = require('path');

module.exports = {
  mode: 'development',
  entry: './index.js',
  output: {
    filename: 'bundle.js',
    path: __dirname
  },
  resolve: {
    modules: [path.resolve(__dirname, 'kaluma_modules')]
  },
  /* kaluma builtin modules */
  externals: {
    'events': 'commonjs events',
    'gpio': 'commonjs gpio',
    'led': 'commonjs led',
    'button': 'commonjs button',
    'pwm': 'commonjs pwm',
    'adc': 'commonjs adc',
    'i2c': 'commonjs i2c',
    'spi': 'commonjs spi',
    'uart': 'commonjs uart',
    'rp2': 'commonjs rp2',
    'graphics': 'commonjs graphics',
    'at': 'commonjs at',
    'stream': 'commonjs stream',
    'net': 'commonjs net',
    'dgram': 'commonjs dgram',
    'http': 'commonjs http',
    'wifi': 'commonjs wifi',
    'url': 'commonjs url',
  },
  devtool: 'source-map'
};

Bundle all files into a single bundle.js file (with a source-map bundlejs.map).

$ npx webpack

If you installed Kaluma CLI, you can upload the bundled file via serial port.

$ kaluma write bundle.js -p <port>