docs/wipy: Add pins to the I2C constructor.

This commit is contained in:
Daniel Campora 2015-09-13 21:36:40 +02:00
parent 41f6948545
commit 624cdeacc4
2 changed files with 4 additions and 4 deletions

View File

@ -323,7 +323,6 @@ STATIC const mp_arg_t pyb_i2c_init_args[] = {
{ MP_QSTR_baudrate, MP_ARG_KW_ONLY | MP_ARG_INT, {.u_int = 100000} }, { MP_QSTR_baudrate, MP_ARG_KW_ONLY | MP_ARG_INT, {.u_int = 100000} },
{ MP_QSTR_pins, MP_ARG_KW_ONLY | MP_ARG_OBJ, {.u_obj = MP_OBJ_NULL} }, { MP_QSTR_pins, MP_ARG_KW_ONLY | MP_ARG_OBJ, {.u_obj = MP_OBJ_NULL} },
}; };
#define PYB_I2C_INIT_NUM_ARGS MP_ARRAY_SIZE(pyb_i2c_init_args)
STATIC mp_obj_t pyb_i2c_make_new(mp_obj_t type_in, mp_uint_t n_args, mp_uint_t n_kw, const mp_obj_t *all_args) { STATIC mp_obj_t pyb_i2c_make_new(mp_obj_t type_in, mp_uint_t n_args, mp_uint_t n_kw, const mp_obj_t *all_args) {
// parse args // parse args
mp_map_t kw_args; mp_map_t kw_args;
@ -331,8 +330,8 @@ STATIC mp_obj_t pyb_i2c_make_new(mp_obj_t type_in, mp_uint_t n_args, mp_uint_t n
mp_arg_val_t args[MP_ARRAY_SIZE(pyb_i2c_init_args)]; mp_arg_val_t args[MP_ARRAY_SIZE(pyb_i2c_init_args)];
mp_arg_parse_all(n_args, all_args, &kw_args, MP_ARRAY_SIZE(args), pyb_i2c_init_args, args); mp_arg_parse_all(n_args, all_args, &kw_args, MP_ARRAY_SIZE(args), pyb_i2c_init_args, args);
// work out the uart id // work out the i2c id
uint8_t i2c_id; uint i2c_id;
if (args[0].u_obj == mp_const_none) { if (args[0].u_obj == mp_const_none) {
// default id // default id
i2c_id = 0; i2c_id = 0;

View File

@ -181,12 +181,13 @@ Methods
.. only:: port_wipy .. only:: port_wipy
.. method:: i2c.init(mode, \*, baudrate=100000) .. method:: i2c.init(mode, \*, baudrate=100000, pins=(SDA, SCL))
Initialise the I2C bus with the given parameters: Initialise the I2C bus with the given parameters:
- ``mode`` must be ``I2C.MASTER`` - ``mode`` must be ``I2C.MASTER``
- ``baudrate`` is the SCL clock rate - ``baudrate`` is the SCL clock rate
- ``pins`` is an optional tuple with the pins to assign to the I2C bus.
.. method:: i2c.readfrom(addr, nbytes) .. method:: i2c.readfrom(addr, nbytes)