Multitech xDot Utils
Diff: MultitechDot.cpp
- Revision:
- 4:db99b2a7d062
- Parent:
- 3:7fa5603c10dc
- Child:
- 6:febbdd0d0e55
--- a/MultitechDot.cpp Wed Feb 21 12:52:15 2018 +0200 +++ b/MultitechDot.cpp Mon May 21 18:08:09 2018 +0300 @@ -48,6 +48,9 @@ // to provision your Dot with a 3rd party gateway, see the gateway or network provider documentation this->update_manual_config(config); + // enable or disable Adaptive Data Rate + this->setAdr(config->adr); + // save changes to configuration logInfo("saving configuration"); if (!this->saveConfig()) { @@ -68,411 +71,16 @@ return _config; } -void MultitechDot::display_config() { - // display configuration and library version information - logInfo("====================="); - logInfo("general configuration"); - logInfo("====================="); - logInfo("version ------------------ %s", this->getId().c_str()); - logInfo("device ID/EUI ------------ %s", mts::Text::bin2hexString(this->getDeviceId()).c_str()); - logInfo("frequency band ----------- %s", this->FrequencyBandStr(this->getFrequencyBand()).c_str()); - logInfo("frequency sub band ------- %u", this->getFrequencySubBand()); - logInfo("public network ----------- %s", this->getPublicNetwork() ? "on" : "off"); - logInfo("========================="); - logInfo("credentials configuration"); - logInfo("========================="); - logInfo("device class ------------- %s", this->getClass().c_str()); - logInfo("network join mode -------- %s", this->JoinModeStr(this->getJoinMode()).c_str()); - if (this->getJoinMode() == this->MANUAL || this->getJoinMode() == this->PEER_TO_PEER) { - logInfo("network address ---------- %s", mts::Text::bin2hexString(this->getNetworkAddress()).c_str()); - logInfo("network session key------- %s", mts::Text::bin2hexString(this->getNetworkSessionKey()).c_str()); - logInfo("data session key---------- %s", mts::Text::bin2hexString(this->getDataSessionKey()).c_str()); - } else { - logInfo("network name ------------- %s", this->getNetworkName().c_str()); - logInfo("network phrase ----------- %s", this->getNetworkPassphrase().c_str()); - logInfo("network EUI -------------- %s", mts::Text::bin2hexString(this->getNetworkId()).c_str()); - logInfo("network KEY -------------- %s", mts::Text::bin2hexString(this->getNetworkKey()).c_str()); - } - logInfo("========================"); - logInfo("communication parameters"); - logInfo("========================"); - if (this->getJoinMode() == this->PEER_TO_PEER) { - logInfo("TX frequency ------------- %lu", this->getTxFrequency()); - } else { - logInfo("acks --------------------- %s, %u attempts", this->getAck() > 0 ? "on" : "off", this->getAck()); - } - logInfo("TX datarate -------------- %s", this->DataRateStr(this->getTxDataRate()).c_str()); - logInfo("TX power ----------------- %lu dBm", this->getTxPower()); - logInfo("Antenna gain ------------- %u dBm", this->getAntennaGain()); -} - -void MultitechDot::update_ota_config_name_phrase(std::string network_name, std::string network_passphrase, - uint8_t frequency_sub_band, bool public_network, uint8_t ack) { - std::string current_network_name = this->getNetworkName(); - std::string current_network_passphrase = this->getNetworkPassphrase(); - uint8_t current_frequency_sub_band = this->getFrequencySubBand(); - bool current_public_network = this->getPublicNetwork(); - uint8_t current_ack = this->getAck(); - - if (current_network_name != network_name) { - logInfo("changing network name from \"%s\" to \"%s\"", current_network_name.c_str(), network_name.c_str()); - if (this->setNetworkName(network_name) != this->MDOT_OK) { - logError("failed to set network name to \"%s\"", network_name.c_str()); - } - } - - if (current_network_passphrase != network_passphrase) { - logInfo("changing network passphrase from \"%s\" to \"%s\"", current_network_passphrase.c_str(), - network_passphrase.c_str()); - if (this->setNetworkPassphrase(network_passphrase) != this->MDOT_OK) { - logError("failed to set network passphrase to \"%s\"", network_passphrase.c_str()); - } - } - - if (current_frequency_sub_band != frequency_sub_band) { - logInfo("changing frequency sub band from %u to %u", current_frequency_sub_band, frequency_sub_band); - if (this->setFrequencySubBand(frequency_sub_band) != this->MDOT_OK) { - logError("failed to set frequency sub band to %u", frequency_sub_band); - } - } - - if (current_public_network != public_network) { - logInfo("changing public network from %s to %s", current_public_network ? "on" : "off", - public_network ? "on" : "off"); - if (this->setPublicNetwork(public_network) != this->MDOT_OK) { - logError("failed to set public network to %s", public_network ? "on" : "off"); - } - } - - if (current_ack != ack) { - logInfo("changing acks from %u to %u", current_ack, ack); - if (this->setAck(ack) != this->MDOT_OK) { - logError("failed to set acks to %u", ack); - } - } -} - -void MultitechDot::update_ota_config_id_key(uint8_t *network_id, uint8_t *network_key, uint8_t frequency_sub_band, - bool public_network, uint8_t ack) { - std::vector<uint8_t> current_network_id = this->getNetworkId(); - std::vector<uint8_t> current_network_key = this->getNetworkKey(); - uint8_t current_frequency_sub_band = this->getFrequencySubBand(); - bool current_public_network = this->getPublicNetwork(); - uint8_t current_ack = this->getAck(); - - std::vector<uint8_t> network_id_vector(network_id, network_id + 8); - std::vector<uint8_t> network_key_vector(network_key, network_key + 16); - - if (current_network_id != network_id_vector) { - logInfo("changing network ID from \"%s\" to \"%s\"", mts::Text::bin2hexString(current_network_id).c_str(), - mts::Text::bin2hexString(network_id_vector).c_str()); - if (this->setNetworkId(network_id_vector) != this->MDOT_OK) { - logError("failed to set network ID to \"%s\"", mts::Text::bin2hexString(network_id_vector).c_str()); - } - } - - if (current_network_key != network_key_vector) { - logInfo("changing network KEY from \"%s\" to \"%s\"", mts::Text::bin2hexString(current_network_key).c_str(), - mts::Text::bin2hexString(network_key_vector).c_str()); - if (this->setNetworkKey(network_key_vector) != this->MDOT_OK) { - logError("failed to set network KEY to \"%s\"", mts::Text::bin2hexString(network_key_vector).c_str()); - } - } - - if (current_frequency_sub_band != frequency_sub_band) { - logInfo("changing frequency sub band from %u to %u", current_frequency_sub_band, frequency_sub_band); - if (this->setFrequencySubBand(frequency_sub_band) != this->MDOT_OK) { - logError("failed to set frequency sub band to %u", frequency_sub_band); - } - } - - if (current_public_network != public_network) { - logInfo("changing public network from %s to %s", current_public_network ? "on" : "off", - public_network ? "on" : "off"); - if (this->setPublicNetwork(public_network) != this->MDOT_OK) { - logError("failed to set public network to %s", public_network ? "on" : "off"); - } - } - - if (current_ack != ack) { - logInfo("changing acks from %u to %u", current_ack, ack); - if (this->setAck(ack) != this->MDOT_OK) { - logError("failed to set acks to %u", ack); - } - } -} void MultitechDot::update_manual_config(struct dot_config *config) { - std::vector<uint8_t> current_network_address = this->getNetworkAddress(); - std::vector<uint8_t> current_network_session_key = this->getNetworkSessionKey(); - std::vector<uint8_t> current_data_session_key = this->getDataSessionKey(); - uint8_t current_frequency_sub_band = this->getFrequencySubBand(); - bool current_public_network = this->getPublicNetwork(); - uint8_t current_ack = this->getAck(); - - std::vector<uint8_t> network_address_vector(config->network_address, config->network_address + 4); - std::vector<uint8_t> network_session_key_vector(config->network_session_key, config->network_session_key + 16); - std::vector<uint8_t> data_session_key_vector(config->data_session_key, config->data_session_key + 16); - - if (current_network_address != network_address_vector) { - logInfo("changing network address from \"%s\" to \"%s\"", - mts::Text::bin2hexString(current_network_address).c_str(), - mts::Text::bin2hexString(network_address_vector).c_str()); - if (this->setNetworkAddress(network_address_vector) != this->MDOT_OK) { - logError("failed to set network address to \"%s\"", - mts::Text::bin2hexString(network_address_vector).c_str()); - } - } - - if (current_network_session_key != network_session_key_vector) { - logInfo("changing network session key from \"%s\" to \"%s\"", - mts::Text::bin2hexString(current_network_session_key).c_str(), - mts::Text::bin2hexString(network_session_key_vector).c_str()); - if (this->setNetworkSessionKey(network_session_key_vector) != this->MDOT_OK) { - logError("failed to set network session key to \"%s\"", - mts::Text::bin2hexString(network_session_key_vector).c_str()); - } - } - - if (current_data_session_key != data_session_key_vector) { - logInfo("changing data session key from \"%s\" to \"%s\"", - mts::Text::bin2hexString(current_data_session_key).c_str(), - mts::Text::bin2hexString(data_session_key_vector).c_str()); - if (this->setDataSessionKey(data_session_key_vector) != this->MDOT_OK) { - logError("failed to set data session key to \"%s\"", - mts::Text::bin2hexString(data_session_key_vector).c_str()); - } - } - - if (current_frequency_sub_band != config->frequency_sub_band) { - logInfo("changing frequency sub band from %u to %u", current_frequency_sub_band, config->frequency_sub_band); - if (this->setFrequencySubBand(config->frequency_sub_band) != this->MDOT_OK) { - logError("failed to set frequency sub band to %u", config->frequency_sub_band); - } - } - - if (current_public_network != config->public_network) { - logInfo("changing public network from %s to %s", current_public_network ? "on" : "off", - config->public_network ? "on" : "off"); - if (this->setPublicNetwork(config->public_network) != this->MDOT_OK) { - logError("failed to set public network to %s", config->public_network ? "on" : "off"); - } - } - - if (current_ack != config->ack) { - logInfo("changing acks from %u to %u", current_ack, config->ack); - if (this->setAck(config->ack) != this->MDOT_OK) { - logError("failed to set acks to %u", config->ack); - } - } -} - -void MultitechDot::update_peer_to_peer_config(uint8_t *network_address, uint8_t *network_session_key, - uint8_t *data_session_key, uint32_t tx_frequency, uint8_t tx_datarate, - uint8_t tx_power) { - std::vector<uint8_t> current_network_address = this->getNetworkAddress(); - std::vector<uint8_t> current_network_session_key = this->getNetworkSessionKey(); - std::vector<uint8_t> current_data_session_key = this->getDataSessionKey(); - uint32_t current_tx_frequency = this->getTxFrequency(); - uint8_t current_tx_datarate = this->getTxDataRate(); - uint32_t current_tx_power = this->getTxPower(); - - std::vector<uint8_t> network_address_vector(network_address, network_address + 4); - std::vector<uint8_t> network_session_key_vector(network_session_key, network_session_key + 16); - std::vector<uint8_t> data_session_key_vector(data_session_key, data_session_key + 16); - - if (current_network_address != network_address_vector) { - logInfo("changing network address from \"%s\" to \"%s\"", - mts::Text::bin2hexString(current_network_address).c_str(), - mts::Text::bin2hexString(network_address_vector).c_str()); - if (this->setNetworkAddress(network_address_vector) != this->MDOT_OK) { - logError("failed to set network address to \"%s\"", - mts::Text::bin2hexString(network_address_vector).c_str()); - } - } - - if (current_network_session_key != network_session_key_vector) { - logInfo("changing network session key from \"%s\" to \"%s\"", - mts::Text::bin2hexString(current_network_session_key).c_str(), - mts::Text::bin2hexString(network_session_key_vector).c_str()); - if (this->setNetworkSessionKey(network_session_key_vector) != this->MDOT_OK) { - logError("failed to set network session key to \"%s\"", - mts::Text::bin2hexString(network_session_key_vector).c_str()); - } - } - - if (current_data_session_key != data_session_key_vector) { - logInfo("changing data session key from \"%s\" to \"%s\"", - mts::Text::bin2hexString(current_data_session_key).c_str(), - mts::Text::bin2hexString(data_session_key_vector).c_str()); - if (this->setDataSessionKey(data_session_key_vector) != this->MDOT_OK) { - logError("failed to set data session key to \"%s\"", - mts::Text::bin2hexString(data_session_key_vector).c_str()); - } - } - - if (current_tx_frequency != tx_frequency) { - logInfo("changing TX frequency from %lu to %lu", current_tx_frequency, tx_frequency); - if (this->setTxFrequency(tx_frequency) != this->MDOT_OK) { - logError("failed to set TX frequency to %lu", tx_frequency); - } - } - - if (current_tx_datarate != tx_datarate) { - logInfo("changing TX datarate from %u to %u", current_tx_datarate, tx_datarate); - if (this->setTxDataRate(tx_datarate) != this->MDOT_OK) { - logError("failed to set TX datarate to %u", tx_datarate); - } - } - - if (current_tx_power != tx_power) { - logInfo("changing TX power from %u to %u", current_tx_power, tx_power); - if (this->setTxPower(tx_power) != this->MDOT_OK) { - logError("failed to set TX power to %u", tx_power); - } - } -} - -void MultitechDot::update_network_link_check_config(uint8_t link_check_count, uint8_t link_check_threshold) { - uint8_t current_link_check_count = this->getLinkCheckCount(); - uint8_t current_link_check_threshold = this->getLinkCheckThreshold(); - - if (current_link_check_count != link_check_count) { - logInfo("changing link check count from %u to %u", current_link_check_count, link_check_count); - if (this->setLinkCheckCount(link_check_count) != this->MDOT_OK) { - logError("failed to set link check count to %u", link_check_count); - } - } - - if (current_link_check_threshold != link_check_threshold) { - logInfo("changing link check threshold from %u to %u", current_link_check_threshold, link_check_threshold); - if (this->setLinkCheckThreshold(link_check_threshold) != this->MDOT_OK) { - logError("failed to set link check threshold to %u", link_check_threshold); - } - } -} - -void MultitechDot::join_network() { - int32_t j_attempts = 0; - int32_t ret = this->MDOT_ERROR; - - // attempt to join the network - while (ret != this->MDOT_OK) { - logInfo("attempt %d to join network", ++j_attempts); - ret = this->joinNetwork(); - if (ret != this->MDOT_OK) { - logError("failed to join network %d:%s", ret, this->getReturnCodeString(ret).c_str()); - // in some frequency bands we need to wait until another channel is available before transmitting again - uint32_t delay_s = (this->getNextTxMs() / 1000) + 1; - if (delay_s < 2) { - logInfo("waiting %lu s until next free channel", delay_s); - wait(delay_s); - } else { - logInfo("sleeping %lu s until next free channel", delay_s); - this->sleep(delay_s, this->RTC_ALARM, false); - } - } - } -} - -void MultitechDot::deep_sleep(uint32_t min_delay_s) { - uint32_t delay_s = this->getNextTxMs() / 1000; - - // save the session so we don't need to join again after waking up - // not necessary if going into sleep mode since RAM is retained - logInfo("saving network session to NVM"); - this->saveNetworkSession(); - - if (delay_s < min_delay_s) { - delay_s = min_delay_s; - } - - logInfo("deepsleeping %lus", delay_s); - logInfo("application will execute from beginning after waking up"); - - // go to deepsleep for delay_s seconds and wake using the RTC alarm - this->sleep(delay_s, this->RTC_ALARM, true); -} - -void MultitechDot::sleep_wake_rtc_only(bool deepsleep) { - // in some frequency bands we need to wait until another channel is available before transmitting again - // wait at least 10s between transmissions - uint32_t delay_s = this->getNextTxMs() / 1000; - if (delay_s < 10) { - delay_s = 10; - } - - logInfo("%s sleeping %lus", deepsleep ? "deep" : "", delay_s); - logInfo("application will %s after waking up", deepsleep ? "execute from beginning" : "resume"); - - // lowest current consumption in sleep mode can only be achieved by configuring IOs as analog inputs with no pull resistors - // the library handles all internal IOs automatically, but the external IOs are the application's responsibility - // certain IOs may require internal pullup or pulldown resistors because leaving them floating would cause extra current consumption - // for xDot: UART_*, I2C_*, SPI_*, GPIO*, WAKE - // for mDot: XBEE_*, USBTX, USBRX, PB_0, PB_1 - // steps are: - // * save IO configuration - // * configure IOs to reduce current consumption - // * sleep - // * restore IO configuration - if (!deepsleep) { - // save the GPIO state. - sleep_save_io(); - - // configure GPIOs for lowest current - sleep_configure_io(); - } - - // go to sleep/deepsleep for delay_s seconds and wake using the RTC alarm - this->sleep(delay_s, this->RTC_ALARM, deepsleep); - - if (!deepsleep) { - // restore the GPIO state. - sleep_restore_io(); - } -} - -void MultitechDot::sleep_wake_interrupt_only(bool deepsleep) { - if (deepsleep) { - // for xDot, WAKE pin (connected to S2 on xDot-DK) is the only pin that can wake the processor from deepsleep - // it is automatically configured when INTERRUPT or RTC_ALARM_OR_INTERRUPT is the wakeup source and deepsleep is true in the mDot::sleep call - } else { - // configure WAKE pin (connected to S2 on xDot-DK) as the pin that will wake the xDot from low power modes - // other pins can be configured instead: GPIO0-3 or UART_RX - this->setWakePin(WAKE); - } - - logInfo("%s sleeping until interrupt on %s pin", deepsleep ? "deep" : "", - deepsleep ? "WAKE" : this->pinName2Str(this->getWakePin()).c_str()); - - logInfo("application will %s after waking up", deepsleep ? "execute from beginning" : "resume"); - - // lowest current consumption in sleep mode can only be achieved by configuring IOs as analog inputs with no pull resistors - // the library handles all internal IOs automatically, but the external IOs are the application's responsibility - // certain IOs may require internal pullup or pulldown resistors because leaving them floating would cause extra current consumption - // for xDot: UART_*, I2C_*, SPI_*, GPIO*, WAKE - // for mDot: XBEE_*, USBTX, USBRX, PB_0, PB_1 - // steps are: - // * save IO configuration - // * configure IOs to reduce current consumption - // * sleep - // * restore IO configuration - if (!deepsleep) { - // save the GPIO state. - this->sleep_save_io(); - - // configure GPIOs for lowest current - this->sleep_configure_io(); - } - - // go to sleep/deepsleep and wake on rising edge of configured wake pin (only the WAKE pin in deepsleep) - // since we're not waking on the RTC alarm, the interval is ignored - this->sleep(0, this->INTERRUPT, deepsleep); - - if (!deepsleep) { - // restore the GPIO state. - this->sleep_restore_io(); - } + BaseDot::update_manual_config( + config->network_address, + config->network_session_key, + config->data_session_key, + config->frequency_sub_band, + config->public_network, + config->ack + ); } void MultitechDot::sleep_wake_rtc_or_interrupt(uint32_t delay_s, bool deepsleep) { @@ -527,92 +135,3 @@ RCC_OscInitStruct.PLL.PLLState = RCC_PLL_NONE; HAL_RCC_OscConfig(&RCC_OscInitStruct); } - -void MultitechDot::sleep_save_io() { - logInfo("Save GPIO states"); - xdot_save_gpio_state(); -} - -void MultitechDot::sleep_configure_io() { - logInfo("Configure GPIO for lowest current"); - // GPIO Ports Clock Enable - __GPIOA_CLK_ENABLE(); - __GPIOB_CLK_ENABLE(); - __GPIOC_CLK_ENABLE(); - __GPIOH_CLK_ENABLE(); - - GPIO_InitTypeDef GPIO_InitStruct; - - // UART1_TX, UART1_RTS & UART1_CTS to analog nopull - RX could be a wakeup source - GPIO_InitStruct.Pin = GPIO_PIN_9 | GPIO_PIN_11 | GPIO_PIN_12; - GPIO_InitStruct.Mode = GPIO_MODE_ANALOG; - GPIO_InitStruct.Pull = GPIO_NOPULL; - HAL_GPIO_Init(GPIOA, &GPIO_InitStruct); - - // I2C_SDA & I2C_SCL to analog nopull - GPIO_InitStruct.Pin = GPIO_PIN_8 | GPIO_PIN_9; - GPIO_InitStruct.Mode = GPIO_MODE_ANALOG; - GPIO_InitStruct.Pull = GPIO_NOPULL; - HAL_GPIO_Init(GPIOB, &GPIO_InitStruct); - - // SPI_MOSI, SPI_MISO, SPI_SCK, & SPI_NSS to analog nopull - GPIO_InitStruct.Pin = GPIO_PIN_12 | GPIO_PIN_13 | GPIO_PIN_14 | GPIO_PIN_15; - GPIO_InitStruct.Mode = GPIO_MODE_ANALOG; - GPIO_InitStruct.Pull = GPIO_NOPULL; - HAL_GPIO_Init(GPIOB, &GPIO_InitStruct); - - // iterate through potential wake pins - leave the configured wake pin alone if one is needed - if (this->getWakePin() != WAKE || this->getWakeMode() == this->RTC_ALARM) { - GPIO_InitStruct.Pin = GPIO_PIN_0; - GPIO_InitStruct.Mode = GPIO_MODE_ANALOG; - GPIO_InitStruct.Pull = GPIO_NOPULL; - HAL_GPIO_Init(GPIOA, &GPIO_InitStruct); - } - if (this->getWakePin() != GPIO0 || this->getWakeMode() == this->RTC_ALARM) { - GPIO_InitStruct.Pin = GPIO_PIN_4; - GPIO_InitStruct.Mode = GPIO_MODE_ANALOG; - GPIO_InitStruct.Pull = GPIO_NOPULL; - HAL_GPIO_Init(GPIOA, &GPIO_InitStruct); - } - if (this->getWakePin() != GPIO1 || this->getWakeMode() == this->RTC_ALARM) { - GPIO_InitStruct.Pin = GPIO_PIN_5; - GPIO_InitStruct.Mode = GPIO_MODE_ANALOG; - GPIO_InitStruct.Pull = GPIO_NOPULL; - HAL_GPIO_Init(GPIOA, &GPIO_InitStruct); - } - if (this->getWakePin() != GPIO2 || this->getWakeMode() == this->RTC_ALARM) { - GPIO_InitStruct.Pin = GPIO_PIN_0; - GPIO_InitStruct.Mode = GPIO_MODE_ANALOG; - GPIO_InitStruct.Pull = GPIO_NOPULL; - HAL_GPIO_Init(GPIOB, &GPIO_InitStruct); - } - if (this->getWakePin() != GPIO3 || this->getWakeMode() == this->RTC_ALARM) { - GPIO_InitStruct.Pin = GPIO_PIN_2; - GPIO_InitStruct.Mode = GPIO_MODE_ANALOG; - GPIO_InitStruct.Pull = GPIO_NOPULL; - HAL_GPIO_Init(GPIOB, &GPIO_InitStruct); - } - if (this->getWakePin() != UART1_RX || this->getWakeMode() == this->RTC_ALARM) { - GPIO_InitStruct.Pin = GPIO_PIN_10; - GPIO_InitStruct.Mode = GPIO_MODE_ANALOG; - GPIO_InitStruct.Pull = GPIO_NOPULL; - HAL_GPIO_Init(GPIOA, &GPIO_InitStruct); - } -} - -void MultitechDot::sleep_restore_io() { - logInfo("Restore GPIO states"); - xdot_restore_gpio_state(); -} - -void MultitechDot::send_data(std::vector<uint8_t> data) { - int32_t ret; - - ret = this->send(data); - if (ret != this->MDOT_OK) { - logError("failed to send data to %s [%d][%s]", this->getJoinMode() == this->PEER_TO_PEER ? "peer" : "gateway", - ret, this->getReturnCodeString(ret).c_str()); - } else { - logInfo("successfully sent data to %s", this->getJoinMode() == this->PEER_TO_PEER ? "peer" : "gateway"); - } -}