Add Pico W support

[sfranzyshen]

any discussion about supporting the Pico W and wifi features? What sort of interest is there in do so? ... since the developer has already shown no interest ... #513 I personally would be willing to work on it ... maybe ...

[dwyschka]

I got the LED Working in the W. But i know the code isnt good (im not a embedded dev). But if u want i can share my current work.

[communix]

I just start to add new code to support pico-w.
you can find the new branch for pico-w

you can build the FW with this command node build --board=pico-w
please run node build --clean before you build the FW.

Now only GPIO features are implemented.

Here is the LED test script

const { PICO_CYW43 } = require('pico_cyw43');
const pico_wifi = new PICO_CYW43();
var timeId = setInterval(function() {
    if (pico_wifi.getGpio(0) == false) {
        pico_wifi.putGpio(0, true);
    } else {
        pico_wifi.putGpio(0, false);
    }
}, 1000)

[communix]

Let me share the jobs we need to implement pico-w WIFI function.

1. Implement WiFi and Network device driver in the pico_cyw32 module using cyw43_driver in the PICO SDK.
   Docs for device driver https://kalumajs.org/docs/api/device-driver
2. Implement pico_cyw32 APIs which is the same as pico_lwip and pico_cyw432_arch functions.

case 1) is mandatory option to use Kaluma network and WiFi module.
case 2) is good to have function to easily implement and use pico-w WiFi function but the application code can't be shared to other wifi driver.

For both 1) and 2), any contribution would be appreciated.
I'll start to implement case 1) but it'll take a long time because I don't have a bandwidth for this project now.

I'm waiting for your contribution.

[grazianogrespan]

First of all I wanted to thank you for this fantastic project.
I'm not an embedded developer but just out of curiosity I wanted to try to build the sources.
I managed to add the following functions (not thoroughly tested but working on my side):

• connect (String ssid, String password, String auth_type, Number timeout);
• disconnect();
• isConnected();

Maybe someone could take my sources from this fork as a starting point/inspiration to implement these functions more appropriately.
I would love to help even if I don't think I have the skills.

Here it is a small script to test it:

const { PICO_CYW43 } = require('pico_cyw43');
const pico_wifi = new PICO_CYW43();

// connect(ssid,password,auth_type,timeout);
// auth_type can be either: 
// - "CYW43_AUTH_OPEN",
// - "CYW43_AUTH_WPA_TKIP_PSK"
// - "CYW43_AUTH_WPA2_AES_PSK",
// - "CYW43_AUTH_WPA2_MIXED_PSK"

pico_wifi.connect('your ssid','yoursecretpw','CYW43_AUTH_WPA2_AES_PSK',10000);

// isConnected()
pico_wifi.isConnected();

// disconnect()
pico_wifi.disconnect();

[louisvangeldrop]

Where can I find the .uf2 file from this build?

[communix]

I'm updating the code in the pico-w branch slowly and there's some update in the branch.

• PICO_CYW43 module class name is changed to PicoCYW43.
• init and deinit function was called in wrong place. this issue is fixed now.
• There's error at .reset command - this issue is fixed.
• [Known issue] .load may trigger system lockup after .reset command

[communix]

I'm implementing IEEE 8.02.11 (WiFi) Device driver for PICO_W CYW43 module
scan, connect, disconnect functions are implemented now.

This is the document for the WiFI device driver

[communix]

This is the working branch for PICO-W
https://github.com/kaluma-project/kaluma/tree/pico-w

[communix]

Pico-w wifi device driver is implemented in the pico-w branch(https://github.com/kaluma-project/kaluma/tree/pico-w)

This is the example code and please see the WIFI module manual(https://kalumajs.org/docs/api/wifi)

const { PicoCYW43 } = require('pico_cyw43');
const { PicoCYW43WIFI } = require('pico_cyw43');
global.__ieee80211dev = new PicoCYW43WIFI();

const { WiFi } = require('wifi');
const wifi = new WiFi();

// scan network
wifi.scan((err, scanResults) => {
  if (err) {
    console.error(err);
  } else {
    console.log(scanResults);
  }
});

// connect
wifi.connect({ ssid: 'MyHome', password: '12345678' }, (err) => {
  if (err) {
    console.error(err);
  } else {
    // add your code using Wi-fi connection
  }
});

[adrian-burlacu-software]

@communix
Thanks a bunch!! I hope the testing useful, mainly I think the connected event would probably trigger opening of some port so that the pico is discoverable on the network. The Network API should be very few functions at least, and I'm humbled by your ability to integrate the C with the JS.

[ollielindsey]

@adrian-burlacu-software nice find, i'll investigate as well when I have time

[ollielindsey]

ah unfortunately looks like it's the micropython approach rather than the underlying c SDK

[adrian-burlacu-software]

ah unfortunately looks like it's the micropython approach rather than the underlying c SDK

@communix
Sorry, my bad. Looking at the document again: https://datasheets.raspberrypi.com/picow/connecting-to-the-internet-with-pico-w.pdf

I found:

• this library they mentioned: https://savannah.nongnu.org/projects/lwip/
• these code examples: https://github.com/raspberrypi/pico-examples/tree/picow/pico_w. That includes:
  • tcp client: https://github.com/raspberrypi/pico-examples/tree/picow/pico_w/tcp_client
  • tcp server (important): https://github.com/raspberrypi/pico-examples/tree/picow/pico_w/tcp_server
  • access point(weird flex but OK): https://github.com/raspberrypi/pico-examples/tree/picow/pico_w/access_point

If I get a free day or two over the next few weeks, I'll try to give it a shot. I think an important function is the wlan.ifconfig(); that would come in handy, although I have no idea where to stick it in the JS so I can get the pico to print its IP in the console.

[communix]

@adrian-burlacu-software Thank you for your help and information.
I'm implementing network driver based on the pico-example. I hope I can release preliminary version soon.

[communix]

pico-w cyw43 network driver is implemented. one known issue is #538 (I don't think it's big issue to implement tcp server and client). The other features are implemented please try it (https://github.com/kaluma-project/kaluma/tree/pico-w)

Please create github issue with [pico-w] prefix when you find any issue.

[communix]

Now only TCP driver is implemented. please use "STREAM" socket only. Do not use "DGRAM" socket which use UDP protocol.

[AcousticTypewriter]

@communix Is there a timeline for adding polished support - i.e. updating docs, making a .utf file?

[adrian-burlacu-software]

@AcousticTypewriter
Progress has been moving along at a good pace so far, I wouldn't be surprised if this is fully done by April-May. I wouldn't rush the dev any harder...this could very well be usable by Jan 1st.

[AcousticTypewriter]

That sounds great. I'm just wondering because of a project I would like to implement with Kaluma. Thanks to the developer for their work and time.

[communix]

@adrian-burlacu-software @AcousticTypewriter
I'll make a plan to release beta-version FW for Pico-W and it'll have TCP server/client feature. If anyone used the latest pico-w FW, please give me a feedback.

[communix]

I just fix a serious bug for the pico-w and TCP network server and client is working well now.
we are going to release beta version binary based on this code base soon (in this year)
This is the preliminary API document (https://github.com/kaluma-project/kaluma-project.github.io/blob/pico-w/src/markdown-pages/docs/api/pico-cwy43.md)

[communix]

Sorry, the beta version will be released next week.

[adrian-burlacu-software]

@communix
Thanks for keeping those commits coming. Last fix for the hang was nice!

[adrian-burlacu-software]

@communix
I tried the latest version. HTTP.get and createServer are still not operational. Despite of this:

• I can find the Pico W with a LAN scan
• I get three "[CYW43] got unexpected packet -9" when I port scan it.

Thank you, and keep up the great work :)

[adrian-burlacu-software]

@communix
Hey, long time. So I decided to try out the beta 4 of the master branch. I used the following script:

http.get({ host: 'example.com', path: '/' }, function (response) {
  console.log('Response: ' + JSON.stringify(response));

  response.on('data', function (chunk) {
    console.log('received: ', new TextDecoder("utf-8").decode(chunk));
  });
});

I got back a response :D

received:  <?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
         "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
        <head>
                <title>400 - Bad Request</title>
        </head>
        <body>
                <h1>400 - Bad Request</h1>
        </body>
</html>

Now if I try anything else like http://example.com or https://192.168.0.44 I cannot seem to get past the WiFi connected message. Still, love the progress and now I know it's HTML 1.1 protocol at least. Is there any way you can finalize this so it's working? I know, by now you probably thinking about Bluetooth on this chip too, but WiFi is still important. I got this cool DB I want to try querying from the Pico-W: https://github.com/WeWatchWall/stark-db

[communix]

@adrian-burlacu-software Let me quickly check this issue.

[communix]

@adrian-burlacu-software I tried to reproduce your issue but I can't. I can see the message you shared (400 - Bad request). One of the change in the latest release, 1.1.0-beta.4 is wifi security option. the latest PICO-W SDK need wifi security. So please try it after adding this.

storage.setItem('WIFI_SECURITY', 'WPA2_WPA_PSK');

Here is the wifi security options you can try.

security {string} Security. OPEN, WPA2_WPA_PSK, WPA2_PSK, WPA_PSK, WEP_PSK. Defaule: OPEN if password is not set or length of the password is less than 8 characters. WPA2_WPA_PSK if length of the password is greater or equal to 8 characters.

For the new wifi.connect() function, please check this page, https://kalumajs.org/docs/api/wifi#wificonnectconnectinfo-callback

[adrian-burlacu-software]

@communix
Oh okay, I tried to get google.com somewhat successfuly. Any idea why HTTP.get on google.com hangs halfway through the page? The response stops suddenly. I used this code:

// storage.setItem(`WIFI_SSID`,  ...
// storage.setItem(`WIFI_PASSWORD`, ...

const Cyw43 = require('pico_cyw43');
// Cyw43.PicoCYW43.prototype.close();
new Cyw43.PicoCYW43();
const ieee80211dev = new Cyw43.PicoCYW43WIFI();
global.__ieee80211dev = ieee80211dev;
const netdev = new Cyw43.PicoCYW43Network();
global.__netdev = netdev;

const { WiFi } = require('wifi');
const wifi = new WiFi();

var http = require('http');

function chunkArrayInGroups(arr, size) {
  var myArray = [];
  for(var i = 0; i < arr.length; i += size) {
    myArray.push(arr.slice(i, i+size));
  }
  return myArray;
}

wifi.connect((err, connection) => {
  if (err) {
    console.log('Error: ' + err);
  } else {
    console.log('Connected: ' + connection);
  }

  http.get({ host: 'google.com', path: '/' }, function (response) {
    console.log('Response: ' + JSON.stringify(response));

    response.on('data', function (chunk) {
      console.log(`received: ${chunk.length} bytes
`);
      //new TextDecoder("utf-8").decode(chunk);
      const results = chunkArrayInGroups(chunk, 100);
      for (const result of results) {
        console.log(new TextDecoder("utf-8").decode(result));
      }
    });
  });
});

[adrian-burlacu-software]

@communix
Here is my server:

<!DOCTYPE html>
<html>
<body>

<h1>My First Heading</h1>
<p>My first paragraph.</p>

</body>
</html>

I use npx serve and npx http-server

https://www.npmjs.com/package/serve
https://www.npmjs.com/package/http-server

Same issue with both - I get a 400 response with both!!!

I do http.get({ host: '192.168.0.73', port: 3000, path: '/' }, function (response) {.

I get a 400 error and my response object is:

{
  "_events": {},
  "destroyed": false,
  "readableEnded": true,
  "headers": {
    "connection": "close",
    "date": "Sun, 15 Oct 2023 09",
    "transfer-encoding": "chunked"
  },
  "method": null,
  "httpVersion": "1.1",
  "statusCode": 400,
  "statusMessage": "Bad",
  "url": null,
  "complete": true,
  "socket": {
    "_events": {
      "close": [null, null, null],
      "data": [null],
      "end": [null],
      "error": [null],
      "connect": [null]
    },
    "destroyed": false,
    "_wbuf": "",
    "writableEnded": true,
    "writableFinished": true,
    "readableEnded": true,
    "localAddress": "192.168.0.10",
    "localPort": 0,
    "remoteAddress": "192.168.0.73",
    "remotePort": 3000,
    "_fd": 0,
    "_dev": {
      "errno": 0,
      "mac": "28:CD:C1:02:61:80",
      "ip": "192.168.0.10"
    }
  }
}

I tried debugging Express https://expressjs.com/en/guide/debugging.html but nothing even registers when the request gets a 400.

[communix]

@adrian-burlacu-software Sorry. I think I misunderstood your issue. Your issue is example.com response is 400-bad request.
I think you need input parameter of HTTP.get seems to be wrong. please use "{ host: 'example.com', path: '/get', headers: {Host: 'example.com', Accept: '/'}" parameter.

Here's new code.

const Cyw43 = require('pico_cyw43');
// Below codes are not needed anymore. ieee80211dev and netdev is already set to cyw43 as a default.
// Cyw43.PicoCYW43.prototype.close();
// new Cyw43.PicoCYW43();
// const ieee80211dev = new Cyw43.PicoCYW43WIFI();
// global.__ieee80211dev = ieee80211dev;
// const netdev = new Cyw43.PicoCYW43Network();
// global.__netdev = netdev;

const { WiFi } = require('wifi');
const wifi = new WiFi();

var http = require('http');

wifi.connect((err, connection) => {
  if (err) {
    console.log('Error: ' + err);
  } else {
    console.log('Connected: ' + connection);
  }

  http.get({ host: 'example.com', path: '/get', headers: {Host: 'example.com', Accept: '*/*'}}, function (response) {
    console.log('Response: ' + JSON.stringify(response));

    response.on('data', function (chunk) {
      console.log('received: ', new TextDecoder("utf-8").decode(chunk));
    });
  });
});

[adrian-burlacu-software]

@communix
Great job, It works! Another two problems:

1. How do I do SSL?

{
    host: 'example.com',
    path: '/',
    port: 443,
    protocol: 'https',
    headers: {
      Host: 'example.com',
      Accept: '*/*'
    }
  }

2. http.get never calls response end event:

response.on('end', function () {
  console.log('Response ended.');
});

[communix]

@adrian-burlacu-software Sorry, HTTPS is not implemented yet. I think we need to implement it and let me check your issue 2.

[adrian-burlacu-software]

@communix
Thanks! Looking forward to doing multiple requests if you fix that :)

[adrian-burlacu-software]

@communix
Hey, it's been a couple of months. Do you have any idea why the response end event isn't triggering? Have you managed to replicate the issue?

[adrian-burlacu-software]

@communix
I validated that the end event is not triggered using this repository as an example. I guess I can use the close event of the response for now. I hope you end up implementing HTTPS too so that the Pico W can work in secure environments. Anyway, I can prototype cool stuff now :)