---
title: "Pybytes library API"
aliases:
---


The Pybytes library is positioned in the [frozen](/advance/frozen/) section of the firmware. 

It can be imported like regular modules:
```python
from _pybytes import Pybytes
from _pybytes_config import PybytesConfig
conf = PybytesConfig().read_config()
pybytes = Pybytes(conf)

pybytes.start()
```
Or on boot
```python
import pycom
import machine
pycom.pybytes_on_boot(True)
machine.reset()
```


## Provisioning

### Pybytes.activate(activationstring)

Provision the device to Pybytes. Use the `activationstring` provided in Pybytes to activate the device.

### pybytes.read_config([filename='/flash/pybytes_config.json', reconnect=False])

Load the Pybytes configuration file. By default, this is found in `/flash/pybytes_config.json`

### pybytes.update_config(key, [value=None, permanent=True, silent=False, reconnect=False])

Update a `key` and `value` of the default configuration file. additional options:
* `permanent`: will call `pybytes.write_config()`. If set `False`, the new value will not be stored in the configuration file and only used this session.
* `silent`: set `silent` to `True` to not print to REPL.
* `reconnect`: calls `pybytes.reconnect()`

### pybytes.set_config([key=None, value=None, permanent=True, silent=False, reconnect=False])

Same as `update_config(...)`

### pybytes.write_config([file='/flash/pybytes_config.json', silent=False])

Writes the updated configuration to the default configuration file. The parameters:
* `file`: The file name and location
* `silent`: set `silent` to `True` to not print to REPL.

### pybytes.print_config()

Print the configuration settings to the REPL.

## Connection

### pybytes.connect()

Connect the device to Pybytes following the loaded configuration file. You will need to load a configuration file before calling this. If you are using the WiFi or LTE connection, and it is already available, Pybytes will use the existing connection.

### pybytes.start([autoconnect=True])

Same as `pybytes.connect()`, with the option to set `autoconnect`. Setting `autoconnect` to `False` will not start the connection immediately. 

### pybytes.enable_lte(carrier=None, cid=None, band=None, apn=None, type=None, reset=None, fallback=False)

Enable the LTE connection to pybytes. Enter the paramters you would normally enter for a LTE connection.

### pybytes.connect_lte()

Connect to Pybytes using LTE and the settings from the configuration file.

### pybytes.connect_wifi()

Connect to Pybytes using WiFi and the settings from the configuration file.

### pybytes.connect_sigfox()

Connect to Pybytes using SigFox and the settings from the configuration file.

### pybytes.connect_lora_otaa([timeout=120, nanogateway=False])

Connect to Pybytes using LoRa OTAA and the settings from the configuration file.

### pybytes.connect_lora_abp([timeout, nanogateway=False])

Connect to Pybytes using LoRa ABP and the settings from the configuration file.

### pybytes.disconnect()

Disconnect from Pybytes gracefully. Closes the MQTT connection and socket.

### pybytes.reconnect()

Calls `pybytes.disconnect()` followed by `pybytes.connect()`

### pybytes.isconnected()

Returns the connection status to Pybytes, can be `True` or `False`.

### pybytes.is_connected()

Same as `pybytes.isconnected()`

### pybytes.enable_ssl()

Enable SSL on the Pybytes connection

>Note that SSL might not be supported by your LTE connection

### pybytes.dump_ca([file='/flash/cert/pycom-ca.pem'])

Write SSL certificate to file.

## Signals

### pybytes.send_signal(signal_number, value)

Send a signal to Pybytes. Arguments are:
* `signal_number`: The signal number in Pybytes, can be any value between 0-254 (255 is reserved)
* `value`: The value you want to send, this can be any type.

> This will also work in Pymesh.

### pybytes.send_ping_message()

Sends a ping (is-alive) message to Pybytes. 

### pybytes.send_info_message()

Send an info message to Pybytes containing the device type and firmware version.

### pybytes.send_battery_level(battery_level)

Sends the battery level to Pybytes. The argument `battery_level` can be any integer.

## Miscellaneous

### pybytes.deepsleep(ms, [pins=None, mode=None, enable_pull=None])

See [machine.deepsleep()](/firmwareapi/pycom/machine/#machinedeepsleeptime_ms) for more details. Additionally, this method disconnects from Pybytes gracefully. The optional arguments operate [machine.pin_sleep_wakeup()](/firmwareapi/pycom/machine/#machinepin_sleep_wakeuppins-mode-enable_pull)

### pybytes.smart_config()

Allows for the usage of `smart_config()`, see `pycom.smart_config()` for more information [here](/firmwareapi/pycom/pycom/#pycomsmart_config_on_bootboolean)


## Debugging
Enable debugging if you are having any issues.
There are multiple debug levels, the lowest is 0 which is for warnings only and 99 is the highest used and will print more debugging messages

#### use:

```
>> import pycom;
>> pycom.nvs_set('pybytes_debug', debugLevel)
```

#### e.g.
```
>> import pycom;
>> pycom.nvs_set('pybytes_debug', 99)
```