Setting Static IP #863

tscrip · 2016-06-07T05:16:27Z

I have been looking through the code, but I currently do not see a way to set a static IP. All of the comments for static IP say this feature if for future development. Is that true?

I am currently using a ESP8266 if that makes any difference.

gfwilliams · 2016-06-07T06:40:06Z

Just an ESP8266, or an Espruino board connected to one?

tscrip · 2016-06-07T16:21:58Z

Just the ESP8266. I am using the NodeMCU dev board that is based on the ESP8266.

8eecf0d2 · 2016-06-09T10:17:08Z

I didn't think this was possible yet?

the options should include the ability to set a static IP and associated netmask and gateway, this is a future enhancement.

http://www.espruino.com/Reference#l_Wifi_connect

gfwilliams · 2016-06-10T09:56:41Z

I'm not sure as I don't generally do too much ESP8266 work, but it seems like it isn't available - @tve?

You might have some luck asking on Gitter? https://gitter.im/espruino/Espruino?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge

wilberforce · 2016-06-14T11:46:15Z

@tscrip If this is in a home network you can archive the same thing by using the MAC address of the device and adding that to a dhcp reservation in your router, so it gets allocated the static address you want - still using dhcp - but getting a fixed address.

tve · 2016-06-22T05:58:09Z

Yup & yup. Someone "just" needs to implement the static IP piece and test it...

MaBecker · 2016-07-04T06:30:29Z

@tve something like this ?

add a function to jswrap_esp8266_network.c

/*JSON{
"type" : "staticmethod",
"class" : "Wifi",
"name" : "setIP",
"generate" : "jswrap_ESP8266_wifi_setIP",
"params" : [
["index", "JsVar", "0:STATION, 1:SOFTAP"],
["settings", "JsVar", "Configuration settings"],
["callback", "JsVar", "A function to be called back on completion."]
]
}
The settings object must contain the following properties.

ip IP address as string (e.g. "192.168.5.100")
gw The network gateway as string (e.g. "192.168.5.1")
netmask The interface netmask as string (e.g. "255.255.255.0")

*/
void jswrap_ESP8266_wifi_setIP(JsVar *jsIndex, JsVar *jsSettings, JsVar *jsCallback) {

....... coding ......

}

use in Espruino:

var WIFI = require("Wifi");
Wifi.setIP(0, {ip:"192.168.5.100",gw:"192.168.194.1",netmask:"255.255.255.0"}, function(e){....});

gfwilliams · 2016-07-04T06:59:37Z

IMO it'd be great to put 'index' in the setting object too (and if it's omitted and you're only in AP or Station mode, juse set the right IP automatically) - then it's the same as the other Espruino stuff

MaBecker · 2016-07-04T07:06:46Z

sure - thanks for that hint

tve · 2016-07-04T07:51:45Z

That index stuff doesn't fit into the other Wifi methods at all. Unless you want to change everything around, it should be SetIP and SetAPIP...

gfwilliams · 2016-07-04T08:07:19Z

it should be SetIP and SetAPIP...

Sounds good to me! I'm not sure how the index stuff ever got included - perhaps it's related to NodeMCU or EspressIf's API? Either way it's not very user-friendly :)

MaBecker · 2016-07-04T08:24:51Z

ok it is SetIP and SetAPIP - thanks for your comments.

the index stuff is Espressif API ;-)

MaBecker · 2016-07-05T08:45:47Z

@gfwilliams can you please assist, added a empty function to jswrap_esp8266_network.c and tried to compile .... got some errors I do not know how to fix.

`
//===== Wifi.setIP

/*JSON{
"type" : "staticmethod",
"class" : "Wifi",
"name" : "setIP",
"generate" : "jswrap_ESP8266_wifi_setIP",
"return" : ["JsVar", "true: Success , false: Failure"],
"params" : [
["settings", "JsVar", "Configuration settings"],
["callback", "JsVar", "The callback to invoke when ip is set"]
]
}
The settings object must contain the following properties.

ip IP address as string (e.g. "192.168.5.100")
gw The network gateway as string (e.g. "192.168.5.1")
netmask The interface netmask as string (e.g. "255.255.255.0")

Return

true: Success 
false: Failure

*/

JsVar *jswrap_ESP8266_wifi_setIP(JsVar *jsSettings, JsVar *jsCallback) {
return true;
}

`

make

CC /esptools/Espruino/1v85/Espruino/gen/jswrapper.o

/esptools/Espruino/1v85/Espruino/gen/jswrapper.c:952:106: error: 'jswrap_ESP8266_wifi_setIP' undeclared here (not in a function)

   {165, JSWAT_JSVAR | (JSWAT_JSVAR << (JSWAT_BITS*1)) | (JSWAT_JSVAR << (JSWAT_BITS*2)), (void (*)(void))jswrap_ESP8266_wifi_setIP},

                                                                                                          ^
/esptools/Espruino/1v85/Espruino/gen/jswrapper.c:952:3: warning: missing initializer for field 'functionPtr' of 'JswSymPtr' [-Wmissing-field-initializers]

   {165, JSWAT_JSVAR | (JSWAT_JSVAR << (JSWAT_BITS*1)) | (JSWAT_JSVAR << (JSWAT_BITS*2)), (void (*)(void))jswrap_ESP8266_wifi_setIP},

   ^
In file included from /esptools/Espruino/1v85/Espruino/gen/jswrapper.c:4:0:

/Volumes/ESPTools/Espruino/1v85/Espruino/src/jswrapper.h:73:10: note: 'functionPtr' declared here
   void (*functionPtr)(void);

          ^

gfwilliams · 2016-07-05T08:53:27Z

Put JsVar *jswrap_ESP8266_wifi_setIP(JsVar *jsSettings, JsVar *jsCallback) in the header file too?

MaBecker · 2016-07-05T09:01:02Z

now - thanks - miss the wood for the trees ;-)

MaBecker · 2016-07-06T19:16:38Z

ok - got three functions, first one is doing the work the other two are calling the worker.

not sure about the unlocks, call back and parameters .... please assist.

void setIP(JsVar *jsSettings, JsVar *jsCallback, int interface) {

  char ipTmp[16];
  int len = 0;

  // fist check parameter 
  if (!jsvIsObject(jsSettings)) {
    EXPECT_OPT_EXCEPTION(jsSettings);
    return;
  }

  // get,check and store ip
  JsVar *jsIP = jsvObjectGetChild(jsSettings, "ip", 0);
  if (jsIP != NULL && !jsvIsString(jsIP)) {
      EXPECT_OPT_EXCEPTION(jsIP);
      jsvUnLock(jsIP);
      return;
  }
  len = jsvGetString(jsIP, ipTmp, sizeof(ipTmp)-1);
  ipTmp[len]='\0';

  DBG(">> ip: %s\n",ipTmp);

  info.ip.addr = networkParseIPAddress(ipTmp); 
  if ( info.ip.addr  == 0) {
    jsExceptionHere(JSET_ERROR, "Not a valid IP address.");
    return;
  }

// get, check and store gw
  JsVar *jsGW = jsvObjectGetChild(jsSettings, "gw", 0);
  if (jsGW != NULL && !jsvIsString(jsGW)) {
      EXPECT_OPT_EXCEPTION(jsGW);
      jsvUnLock(jsGW);
      return;
  }
  len = jsvGetString(jsGW, ipTmp, sizeof(ipTmp)-1);
  ipTmp[len]='\0';

  DBG(">> gw: %s\n",ipTmp);

  info.gw.addr = networkParseIPAddress(ipTmp);
  if (info.gw.addr == 0) {
    jsExceptionHere(JSET_ERROR, "Not a valid Gateway address.");
    return;
  }

  // netmask setting
  JsVar *jsNM = jsvObjectGetChild(jsSettings, "netmask", 0);
  if (jsNM != NULL && !jsvIsString(jsNM)) {
      EXPECT_OPT_EXCEPTION(jsNM);
      jsvUnLock(jsNM);
      return;
  }
  len = jsvGetString(jsNM, ipTmp, sizeof(ipTmp)-1);
  ipTmp[len]='\0';

  DBG(">> netmask: %s\n",ipTmp);

  info.netmask.addr = networkParseIPAddress(ipTmp); 
  if (info.netmask.addr == 0) {
    jsExceptionHere(JSET_ERROR, "Not a valid Netmask.");
    return;
  }

  jsvUnLock(jsIP);
  jsvUnLock(jsGW);
  jsvUnLock(jsNM);

  if (interface == STATION_IF ) {
    wifi_station_dhcpc_stop();
    bool ok = wifi_set_ip_info(STATION_IF, &info);
  }
  else {
    wifi_softap_dhcps_stop();
    bool ok = wifi_set_ip_info(SOFTAP_IF, &info);
    wifi_softap_dhcps_start();
  }

  // Schedule callback

  if (jsvIsFunction(jsCallback != NULL)) {
    JsVar *jsSetIP = jsvNewObject();
    jsvObjectSetChildAndUnLock(jsSetIP, "success",jsvNewFromBool(ok));
    JsVar *params[1];
    params[0] = jsSetIP;
    jsiQueueEvents(NULL, jsCallback, params, 1); 
    jsvUnLock(params[0]);
    jsvUnLock(jsSetIP);
  }

  return;
};

//===== Wifi.setIP
/*JSON{
  "type"     : "staticmethod",
  "class"    : "Wifi",
  "name"     : "setIP",
  "generate" : "jswrap_ESP8266_wifi_setIP",
  "params"   : [
    ["settings", "JsVar", "Configuration settings"],
    ["callback", "JsVar", "The callback to invoke when ip is set"]
  ]
}

The `settings` object must contain the following properties.
* `ip` IP address as string (e.g. "192.168.5.100")
* `gw`  The network gateway as string (e.g. "192.168.5.1")
* `netmask` The interface netmask as string (e.g. "255.255.255.0")

Return 

* success : true | false  

*/

void jswrap_ESP8266_wifi_setIP(JsVar *jsSettings, JsVar *jsCallback) {

  DBG("> Wifi.setIP\n");

  setIP(jsSettings, jsCallback, STATION_IF);

  return;
}


//===== Wifi.setAPIP
/*JSON{
  "type"     : "staticmethod",
  "class"    : "Wifi",
  "name"     : "setAPIP",
  "generate" : "jswrap_ESP8266_wifi_setAPIP",
  "params"   : [
    ["settings", "JsVar", "Configuration settings"],
    ["callback", "JsVar", "The callback to invoke when ip is set"]
  ]
}

The `settings` object must contain the following properties.
* `ip` IP address as string (e.g. "192.168.5.100")
* `gw`  The network gateway as string (e.g. "192.168.5.1")
* `netmask` The interface netmask as string (e.g. "255.255.255.0")


Return 

* success : true | false  

*/

void jswrap_ESP8266_wifi_setAPIP(JsVar *jsSettings, JsVar *jsCallback) {

  DBG("> Wifi.setAPIP\n");

  setIP(jsSettings, jsCallback, SOFTAP_IF);

  return;
}

MaBecker · 2016-07-06T20:04:25Z

running some tests and networkParseIPAddress() returns for incomplete ip4 strings a valid result

"255.255.255" to "0.255.255.255"

"192.168.194" to "0.192.168.194"

Is this how networkParseIPAddress() should work ? checking the source code my answer is yes - hmm

Is there a more strict version of networkParseIPAddress() ?

MaBecker · 2016-07-08T06:23:02Z

@gfwilliams and @tve should Wifi.setIP look like WLAN.setIP - please assist.

gfwilliams · 2016-07-08T07:10:32Z

Is there a more strict version of networkParseIPAddress() ?

I don't think so - you could try and make it return a bool or something if the address wasn't correct?

should Wifi.setIP look like WLAN.setIP

I'm trying to move to using callbacks for this stuff, so what you have looks fine (especially if you don't error if there is no callback). In the case of just setting IP I guess on ESP8266 you might be able to get away without it, but on other devices you won't... and you will definitely have trouble if you go for having setIP(undefined) do DHCP like happens on other Espruino devices

MaBecker · 2016-07-08T17:29:46Z

ok - changed coding and started testing

MaBecker · 2016-07-08T17:44:55Z

@tve it is working, Wifi.getIP() shows the new value, but the ESP is not reachable on the ne IP.
What am I missing - please assist.

wilberforce · 2016-07-08T22:24:20Z

@MaBecker
Where is the code - is it here? https://github.com/MaBecker/Espruino ?

MaBecker · 2016-07-09T04:26:43Z

@tve with your hint for ping() the _setIP() and _setAPIP() is working - thanks.

@wilberforce yes - now you can find it there

wilberforce · 2016-07-11T12:10:10Z

@MaBecker

Looks good.

static struct ip_info info;

Does this need to be static or can it be allocated on the stack?

MaBecker · 2016-07-11T13:58:30Z

not sure, used the same style as ping

wilberforce · 2016-07-11T23:35:37Z

@MaBecker

not sure, used the same style as ping

Ok. The difference is that a static object is allocated space at link time, and always takes up that space.
Something allocated in function scope is allocated dynamically on the stack. This means when the function is exited, the space is given back to the system.

wilberforce · 2016-07-11T23:36:36Z

@MaBecker

Will these new settings get preserved in a Wifi.save() ?

MaBecker · 2016-08-16T11:41:46Z

hm , I guess yes, but let me test

MaBecker · 2016-09-04T12:43:53Z

@wilberforce: NO - the ip setting is not saved.

read stored information for AP and Station
starting as saved (off/sta/ap/sta+ap)
2.1 AP open on 192.168.4.1 (ap/sta+ap)
2.2 Station connect to saved AP and request ip by dhcp (st/sta+ap)

At the moment I have no use case where _setIP() or _setAPIP() is needed.

MaBecker · 2016-12-12T16:07:44Z

Hi @tve can you please double check, this would be very helpful, because I am not sure about the JSON stuff and if this two function should return a boolean or not.

Next step is to create a PR for this enhancement.

changes to libs/network/esp8266/jswrap_esp8266_network.h

MaBecker@072dcac#diff-f388853956d7ecb9f108259d968da34a

changes to libs/network/esp8266/jswrap_esp8266_network.c

MaBecker@a5124aa#diff-6b36071fdae7819c38bd7144e04f3942

MaBecker · 2017-01-05T09:45:05Z

Hi @gfwilliams

added code to my fork and like to check the description /*JSON{...}... */ .

How to create the http://www.espruino.com/Reference# page ?

gfwilliams · 2017-01-05T10:03:02Z

Just run scripts/build_docs.py - it'll generate functions.html in the main directory

MaBecker · 2017-01-24T13:52:22Z

Hi @gfwilliams

how can I merge this commit into the Espruino/master ?

gfwilliams · 2017-01-24T14:21:02Z

Just done - if you made a branch that tracked the main Espruino repo, did git cherry-pick commit_hash, and then issues a pull request from that branch, that should have worked though

gfwilliams · 2017-01-24T14:21:30Z

Closing this with eabffa4

trusktr · 2017-06-02T06:53:04Z

Can we setIP with Espruino WiFi? Seems like not. That would be nice!

gfwilliams · 2017-06-02T08:52:01Z

This bug is the one for ESP8266 itself. Espruino WiFi doesn't do it yet, but I just filed a new one here with a workaround for it: espruino/EspruinoDocs#363

gfwilliams added the ESP8266 This is only a problem on ESP8266 devices label Jun 10, 2016

tve added the enhancement label Jun 22, 2016

gfwilliams closed this as completed Jan 24, 2017

MaBecker added the implemented label Jun 2, 2017

Setting Static IP #863

Setting Static IP #863

Comments

tscrip commented Jun 7, 2016

gfwilliams commented Jun 7, 2016

tscrip commented Jun 7, 2016

8eecf0d2 commented Jun 9, 2016

gfwilliams commented Jun 10, 2016

wilberforce commented Jun 14, 2016 • edited

tve commented Jun 22, 2016

MaBecker commented Jul 4, 2016

gfwilliams commented Jul 4, 2016

MaBecker commented Jul 4, 2016

tve commented Jul 4, 2016

gfwilliams commented Jul 4, 2016

MaBecker commented Jul 4, 2016 • edited

MaBecker commented Jul 5, 2016

gfwilliams commented Jul 5, 2016

MaBecker commented Jul 5, 2016

MaBecker commented Jul 6, 2016

MaBecker commented Jul 6, 2016 • edited

MaBecker commented Jul 8, 2016 • edited

gfwilliams commented Jul 8, 2016

MaBecker commented Jul 8, 2016

MaBecker commented Jul 8, 2016

wilberforce commented Jul 8, 2016

MaBecker commented Jul 9, 2016

wilberforce commented Jul 11, 2016

MaBecker commented Jul 11, 2016

wilberforce commented Jul 11, 2016 • edited

wilberforce commented Jul 11, 2016

MaBecker commented Aug 16, 2016

MaBecker commented Sep 4, 2016

MaBecker commented Dec 12, 2016

MaBecker commented Jan 5, 2017

gfwilliams commented Jan 5, 2017

MaBecker commented Jan 24, 2017

gfwilliams commented Jan 24, 2017

gfwilliams commented Jan 24, 2017

trusktr commented Jun 2, 2017 • edited

gfwilliams commented Jun 2, 2017 • edited

wilberforce commented Jun 14, 2016 •

edited

MaBecker commented Jul 4, 2016 •

edited

MaBecker commented Jul 6, 2016 •

edited

MaBecker commented Jul 8, 2016 •

edited

wilberforce commented Jul 11, 2016 •

edited

trusktr commented Jun 2, 2017 •

edited

gfwilliams commented Jun 2, 2017 •

edited