Difference between revisions of "AIO Release Notes"
|Line 24:||Line 24:|
=== Added functionality ===
=== Added functionality ===
== V1.0.115 ==
== V1.0.115 ==
Revision as of 15:27, 8 December 2021
- 1 General
- 2 V1.0.118
- 3 V1.0.117
- 4 V1.0.115
- 5 V1.0.114
- 6 V1.0.113
- 7 V1.0.112
- 8 V1.0.111
- 9 V1.0.110
- 10 V1.0.109
- 11 V1.0.108
- 12 V1.0.107
- 13 V1.0.106
- 14 V1.0.105
- 15 V1.0.104
- 16 V1.0.103
- 17 V1.0.102
- 18 V1.0.101
- 19 V1.0.98
- 20 V1.0.89
- 21 V1.0.88
- 22 V1.0.87
- 23 V1.0.86
- 24 V1.0.85
- 25 V1.0.84
- 26 V1.0.83
- 27 V1.0.82
- 28 V1.0.81
- 29 V1.0.80
- 30 V1.0.79
- 31 V1.0.78
- 32 V1.0.75
- 33 V1.0.74
- 34 V1.0.73
- 35 V1.0.72
- 36 V1.0.71
- 37 V1.0.70
- 38 V1.0.69
- 39 V1.0.68
- 40 V1.0.67
- 41 V1.0.66
- 42 V1.0.65
- 43 V1.0.64
- 44 V1.0.63
- 45 V1.0.62
- 46 V1.0.61
- 47 V1.0.60
- 48 V1.0.59
- 49 V1.0.58
- 50 V1.0.57
- 51 V1.0.56
- 52 V1.0.55
- 53 V1.0.54
- 54 V1.0.53
- 55 V1.0.52
- 56 V1.0.51
- 57 V1.0.50
- 58 V1.0.49
- 59 V1.0.48
- 60 V1.0.47
- 61 V1.0.46
- 62 V1.0.45
- 63 V1.0.44
- 64 V1.0.43
- 65 V1.0.42
- 66 V1.0.40
- 67 V1.0.39
- 68 V1.0.38
- 69 V1.0.37
- 70 V1.0.36
- 71 V1.0.35
- 72 V1.0.34
- 73 V1.0.33
The Master firmware for the AIO will be published as Open Source once the module goes on sale.
This firmware is based on the new hardware of the AIO. This Master processor of the AIO is from the Microchip DSPIC33E family and the firmware is written in C
The firmware updates happening in the Openmotics portal (Settings - Update) contain not only the firmware update of the Master, but also the firmware of other modules as well as the updates for the Beagle Bone Black. All these different firmware updates are assembled in a package which get's a general version number. This version number which you see in the portal is not the same as the Firmware Version of the Master. To check which firmware version is installed on the Master, in the Openmotics portal, go to Settings - Maintenance and open maintenance mode by pressing the Connect button. Type the instruction
firmware version to read the Master Firmware version.
Date: In development
- When configuring a duo output as shutter and both outputs are ON, both outputs should be switched OFF at the time of configuration.
- When using "can debug on", situation could occur that a storm of messages appears on the screen. In this release, this is filtered.
- API Instruction PC had the CRC of the Pulsecounter values implemented as little endian and it should be big endian. This has been corrected in this release.
- Factory reset has been added in this release
- A Factory reset will Execute all necessary steps to perform a full wipe:
- Send the necessary instructions on the CAN bus (direct connected CAN and CAN busses connected over a CAN Control) to delete the CAN config of the uCAN's
- Erase the config of the connected RS485 slave modules (all config included the ID of the modules)
- Erase the EEPROM of the Master (except the protected areas like serial number, production data, uptime, logging information etc)
- Erase the FRAM of the Master (except the protected areas like logging)
- Log the erase steps in FRAM
- Send Events to the BB of the different factory reset steps
- Following has been added:
- BA254 2 has been added: Prepare factory reset
- BA254 3 has been added: Execute factory reset
- EV200 0 has been added: For every phase of the factory reset, an event is sent
- A factory reset is irreversible, all configuration will be lost
- FRAM logging, EEPROM logging and Factory settings will not be erased
- When a factory Reset is performed, errors might appear on the CLI console (input error, output error etc), this is normal and can be ignored
- Factory reset is available in following firmwares:
- Master: V1.0.115 or higher
- Input Module: V6.0.25 or higher
- Output Module: V6.0.18 or higher
- Temperature Module: V6.0.16 or higher
- Dim Control Module: V6.0.19 or higher
- CAN Control Module: V6.0.43 or higher
- See https://wiki.openmotics.com/index.php/AIO_Tips_%26_tricks_during_installation_and_troubleshooting#Factory_Reset
- After a factory reset, it might happen that the uCAN's can't be added
- Workaround: perform a reset in the CLI console
- Stabilisation of the DALI functionality via CAN Control:
- Support of DALI output
- Support of DALI motion sensors
- Support of DALI sensors (temp & lux)
- To support DALI over CAN Control, following functionality has been added:
- BA21 20, BA21 21 & BA21 22 have been moved to BA21 40, BA21 41 & BA21 42
- CLI instruction "?" has been removed since it takes a lot of flash memory
- CLI instruction "dali debug on" and "Dali debug off" has been added:
- When this debug function is on, information that is sent and received on the data bus is displayed on the CLI console
- CLI instruction "dali output on" and "dali output off" has been added:
- These instructions allow to sent Dali message on the bus without any configuration. This helps testing the Dali Bus before starting the configuration.
- CLI instruction "add virtual input module" has been added
- CLI instruction "add virtual dimmer module" has been added
- CLI instruction "add virtual output module" has been added
- CLI instruction "add virtual sensor module" has been added
- CLI instruction "can debug on" has been added to debug CAN messages coming from the internal bus or can messages from the CAN control
- CLI instruction "can debug off" has been added
- CLI instruction "can message" has been added to allow CAN messages to be sent via CLI
- For DALI, this version is a beta version:
- DALI functionality in this version is not yet stable and requires further testing and bug fixing
- This version CANNOT be used in production
- The first CD response was using CID 0 instead of the CID being sent by the BB. This has been resolved in this release.
- Output type (see eeprom P1-80 B31-38) was not automatically adapted for Roller/Shutter outputs. In this release, when an Roller/shutter configuration is detected, the output type is automatically adapted in RAM (eeprom value remains unchanged).
- API call CD was not always responding and was generating an UART Error. This has been resolved in this release.
- API call ST type 2 had a wrong message length
- The brightness Event was sent on a regular basis even when brightness sensor was not connected. This release solves this issue.
- When BA20 71 (switch led ON when nr_of_lights_on>x) is used, the led will switch ON but not OFF. This is resolved.
- BA20 70 has the same bug
- BA20 72 had the same bug
- BA20 73 has the same bug
- RS485 communication protocol has been modified to support the Heat Pump module.
- The module type "H" represents the Heatpump module
- Memory model has changed to prepare the implementation of DALI on the CAN Control:
- See Page 1-80 Byte 71..: DALI: Link Output Nr with Dali Nr
- See First Page Byte 15..: DALI: Link Input Nr with Dali Nr
- See Page 239-254 Byte 72: DALI: Link sensor Nr with Dali Nr
- API CD message has been changed: A response is sent by the master with the number of uCAN's before the individual messages are being sent.
- API ST (type=2) message has been changed: Message will contain the number of input, output and sensor modules.
- Event 23 has been added: When API CD message is used and a uCAN is not responding, Event 23 will be sent.
- Event 24 has been added: When API ST (type 2) message is used and the RS485 module is not responding, Event 24 will be sent.
- For installations that have Dali configurations active before this firmware upgrade, please follow this Dali Eeprom Memory Model change procedure
- When API Instruction "FM" is used, the Healthcheckers (except i2c health checker) master reset functionality will be disabled. When an Eeprom activate is executed, the health checker will be enabled again and the health check eeprom bytes will be used to verify if the health checker is active or not.
- Event 254 has been modified: Reset_mode has been added.
- CAN instruction has been added for the test system to read the full serial number without writing
- In the CLI instruction "can ping list", the Hw revision, serial number and production date has been added
- CLI instruction "eeprom read" and "eeprom write" is extended to also read and write the eeprom of the uCAN slave modules. This function requires uCAN Firmware Version 6.0.21 or higher
- Normally, an internal eeprom read has 2 or 3 arguments, an eeprom read of a uCAN has 4 arguments:
eeprom read Id2 ID1 ID0 Eeprom_Loc
el --- Total Uptime: 000216 Hours, Last Startup: 08:02:09 02/09/21 --- --- Module Type: BRAIN, RS485 mode: 0, Board: 27'C --.--V --.--A --- --- PWR RS485/CAN: 1/1, CANTERM: 1, BB Debug: 255, Fw: 1.0.109 --- -------Output------------ID---------Err-------Status--------Pwr--- 00 (l I 000->007) 108.000.000.000 00000 GOOD (000) 1 -------Input-------------ID---------Err-------Status--------Pwr--- 00 (i I 000->007) 105.000.000.000 00000 GOOD (000) 1 01 (b C 008->015) 098.000.000.001 00000 GOOD (000) 1 02 (b C 016->023) 098.000.000.002 00000 GOOD (000) 1 03 (b C 024->031) 098.000.000.003 00000 GOOD (000) 1 04 (b C 032->039) 098.000.000.004 00000 GOOD (000) 1 -------Sensor------------ID---------Err-------Status--------Pwr--- 00 (s C 000->007) 115.000.000.000 00000 GOOD (000) 1 -------Micro CAN---------ID---------Err-------Status--------Pwr--- 00 (m C 000->000) 100.069.253.220 00001 GOOD (000) 1 01 (m C 001->001) 100.052.078.228 00000 GOOD (000) 1 02 (m C 002->002) 220.127.116.11 00000 GOOD (000) 1 03 (m C 003->003) 100.091.059.166 00000 GOOD (000) 1 OK eeprom read 91 59 166 30 15 OK
- An eeprom write of a uCAN has 5 arguments:
eeprom write Id2 ID1 ID0 Eeprom_Loc Data_byte
eeprom write 91 59 166 30 20 20 OK eeprom read 91 59 166 30 20
- For the Brain+, the internal built-in Dim Control functionality was still working at a resolution of 0-63 instead of 0-255. This has been resolved in this release.
- BA20 9 till BA20 19 had a wrong translation to CAN bus message
- Improved and simplified CAN Bus health checker
- Dimming up & down by using a button didn't dim over the full range.
- The eeprom programmed minimum dim value was incorrectly used and always had value 63.
- After a reset, the dim direction was not always set correctly resulting in a second press needed to start dimming.
- During Init mode, the Health checker was still running but uCAN's behind a CAN Control are not reachable as expected. This could trigger the health checker reset and this is resolved in this release.
- Event 247 (PCB temperature) reported his value in the wrong field compared to documentation.
- Event 245 has been added: During init mode, when a existing or double slave module has been found, this event will be sent.
- Event 246 has been added: When an Automatic module search is started, ended or not started (Automatic Discovery is OFF), an event will be sent.
- Event 248 has been modified and now indicates the difference between a regular Eeprom activate and an Eeprom activate just after startup (or reset)
- CLI instructions "input number modules write 0", "output number modules write 0" and "sensor number modules write 0" were accepted by the master but not executed. This has been resolved in this release.
- Instructions (BA20 10, BA20 11 etc) to reprogram an input could generate a factory reset of all connected uCAN's. This has been resolved in this release.
- Improved uCAN health checking
- CLI instruction "can ping list" was having trouble finding uCAN's behind a CAN Control, this has been solved in this release as well.
- CAN speed change for CAN Control has been added:
- Memory model Page0 Byte26-29 has been added (CAN settings for CAN Control)
- During Eeprom activate, CRC of CAN Control settings are calculated before activating
- RS485 instruction has been modified to include the CAN Control CAN settings, see: https://wiki.openmotics.com/index.php/Can_Control_RS485_Communication_Protocol#Nothing_to_report_from_Master.2C_request_if_something_in_the_Queue_of_Can_Control_Module
- CAN speed 250kbps has been added. This speed can be used by applying following instruction:
can speed write 250
- First time setup of a CAN bus gave problems with CAN bus speed (uCAN's were not able to communicate). This release solves this problem.
- Master Firmware version V1.0.104 or higher has an improved search mechanism for slave modules: When a new slave module is found during the automatic search, first the Master will check if the Slave module is responding, when positive the Master will request the slave module to program its slave address, after this the slave module will respond to the master that the slave address is programmed and only then the module is added in the Master list. The automatic search will only work with following slave firmware versions (below is the newer version):
- Output V6.0.15 or higher
- Dim Control V6.0.16 or higher
- Input V6.0.23 or higher
- Temp V6.0.13 or higher
- Can Control V6.0.36 or higher
- When CLI instruction "can config delete" is used, a broadcast message will be sent to all the uCAN slaves (with Firmware version 6.0.17 or higher) to factory reset every connected uCAN.
Factory Reset of a full installation can be done with following guideline
- Use following instruction to delete the CAN config (please make sure you have fw version 6.0.17 or higher for the uCAN's):
can config delete
- Use following instruction to delete the Master eeprom:
eeprom erase 0 511 28883
- On the slave modules, push the init button during power startup until the status led flashes 4 times
- Use the CLI instruction
Manual Init of slave modules with an older firmware version
- Change the search functionality setting
eeprom write 0 11 0
- Perform Eeprom activate to copy Eeprom settings into RAM:
- Use now the manual procedure to add modules:
module discover start
- press the init button on the modules to be added. Once done, leave the discover mode:
module discover stop
- Automatic search can be activated again:
eeprom write 0 11 255
Manual Init of slave modules with an newer firmware version
When the newer firmware version is used (which should be always the case), use below instruction to change to manual search:
- First set the correct Eeprom value:
eeprom write 0 11 2
- Activate the Eeprom value
- Start the manual discovery process
module discover start
- Press the init button of the modules that you want to add, then stop the discovery process
module discover stop
- You can enable the automatic search again:
eeprom write 0 11 255 eeprom activate
- Some error messages in CLI during initialisation were not displayed fully. This has been resolved in this release.
- When an automatic search was ongoing and this was stopped by using "module discover stop", "module discover start" would make the search continue which is not what to be expected
- The automatic search and the adding of modules have been improved
- In some cases, double Module ID's could be created during initialisation and this has been resolved in this release
- Event 254 1 (PCB temperature) has been moved to Event 247 0
- Event 254 x has the firmware version added in the data payload
- API Instruction "AM" has been added
- API Instruction "AM" will be send when a new module (normal or virtual) has been added
- After each startup, the Master will perform an automatic search for new modules. When this search take more time then +/- 10 minutes, the health checker will automatically stop the search and bring the bus in live mode.
- Automatic search function was generating errors during search and sometimes failing to find all modules. This issue has been solved in this release. Please note that the Automatic search can take up to 5 minutes to find all modules.
- Automatic search function has been added for Output modules that are being placed in Roller/Shutter mode before initialization
- Automatic search function has been added for Dim Control modules
- Recovery of failed I2C1 Bus has been improved
- Improved CAN led functionality: When many leds were being set, not all leds did respond correctly
- CAN parameters correction for correct speed
- Health checker has been improved:
- Ping messages only allows timeout of 20ms
- When CAN problems are happening, first try to reset the CAN stack before resetting the processor
- The reset of the CAN stack will also be logged in FRAM
- Improved CAN bus stability: Too fast sending messages on the CAN bus could bring uCAN leds in an wrong state.
- Output group follow actions did not work for "output all off" instructions and BA's
- After a reset, the leds of the inputs are set correctly
- CLI instruction "can speed write" can now be used without parameter
- This allows that customer values being written in Eeprom can be used to distribute custom CAN speeds
- "DALI on" message contained an error due to dimmer value and didn't switch on the concerning light.
- "DALI group" was not switching the appropriate lights
- Some programmed shutters (with outputs >=32) didn't appear and didn't work as expected.
- On the Frontpanel, when input was selected, input 6-8 lights up but those inputs are not connected
- When a uCAN that was initialised previously was resending a sensor message (without an input that was initialised on this uCAN) generating errors on Master level. This is resolved in this release.
- uCAN's sometimes gave communication errors (seen in the "error list")
- During the I2C power reset, the Eeprom and FRAM were still powered through the WP pin so hardware reset was not effective
- CAN parameters have been modified to improve CAN network stability. This release must be done together with Can Control V6.0.32 and uCAN V6.0.14.
- Event and Error logging has been extended:
- Logging is also possible in Eeprom (previously already available in FRAM)
- Startup info is also logged in Eeprom
- I2C2 (I2C Bus of FRAM) problems are logged in Eeprom
- See Eeprom memory model Page 506-511
- See Eeprom memory model Page 0 Byte83-84
- CLI instruction "logging list" has been removed
- CLI instruction "eeprom logging" has been added
- CLI instruction "Fram logging" has been added
- CAN Health Checker:
- Bus off state is detected, will log the problem and reset the Master
- CAN Speed selection: In this release (together with uCAN V6.0.14 or higher), you can change the speed of the CAN bus.
- CLI instruction "can speed read" has been added
- CLI instruction "can speed write" has been added
- Memory model Page 0 Byte 14-26 have been added
- CLI instruction "can ping list" has been modified to display the CAN parameters
- API Instruction "CD" has been modified to include the CAN parameters
- I2C power reset is improved (SDA and SCL line are brought down during power reset)
- Serial number error: CLI instruction "firmware version" didn't display the programmed serial number
- State machine "Update Time/Date" was generating errors from time to time. This was linked to a bug in the Non blocking delay used in this state machine. This also has been solved in this release
- Event 254 3 (Health Checker Info) has been moved to Event 248 3
- Event 248 2 (I2C Power reset) has been added
- Health Checker
- CAN health checker has been added
- CAN problems are logged in FRAM
- CAN recovery is logged in FRAM
- When CAN can't be recovered, a Master Reset is executed
- Before the Master reset is executed, an event is sent and the logged in FRAM
- When a BA loop generates a full BA queue, the I2C bus could get blocked. This release solves this issue.
- When a uCAN was generating errors (for example not connected) and not responding, the error list was indicating after a while that the uCAN was "DEGRADED" or 'OFFLINE". When reconnecting the sensor, the state was not been changed to "GOOD".
- The time to do a full erase of EEPROM or FRAM was not long enough resulting in a partial erase. This is resolved in this release
- Serial number:
- CLI instruction "Firmware version" has been modified: Serial number has been added
- RS485 instruction "FL" has been added
- Network Health Checker:
- I2C health checker:
- First version written but not yet active
- Both I2C busses are checked every 10 seconds
- I2C Bus 1 contains the EEPROMS
- I2C Bus 2 contains the RTC, FRAM, Front panel leds, DA converter (Brain+ only) etc
- Bus 1 is tested by reading the Eeprom
- When the Eeprom is not responding, the state machine gets a reset
- Bus 2 is tested by reading the RTC time
- When the time is not increasing, first reset the state machine
- When the time is still not increasing, reset the master including a power reset of all i2c IC's
- Before a Reset is performed, an API EV message is sent
- Reset information will also be logged in FRAM (only when resetting due to I2C Bus 1)
- EV 254 2 has been modified
- FRAM logging:
- FRAM Page0/Byte 83-84 have been added
- FRAM Page 53-84 have been added
- CLI instruction "logging list" has been added
- Memory model Eeprom Page0/Byte13 has been changed
- FRAM/Eeprom Page protection:
- Some pages are write protected and can only be written by the system itself:
- Eeprom Page 0/Byte>=128
- FRAM Page 0 & Page 50
- CLI instructions (like "eeprom write") will not be able to write in protected pages
- API instructions will not be able to write in protected pages
- Some pages are write protected and can only be written by the system itself:
- Air quality values that are changing will also send an event
- Event 2 3 has been added
- When 2 or more front panel buttons are pressed simultaneously, long term press actions will not be executed.
- BA251 has been added: This BA trigger an event, the payload of this BA will be forwarded via Event 249.
- Event 249 has been added
- Date and time related "IF THEN" BA's have been added:
- BA100 37 has been added
- BA100 38 has been added
- BA100 39 has been added
- BA100 40 has been added
- BA100 41 has been added
- BA100 42 has been added
- BA100 43 has been added
- BA100 44 has been added
- BA100 45 has been added
- BA100 46 has been added
- BA100 47 has been added
- BA100 48 has been added
- PSV memory relocation has been done to solve a bootloader issue
- Event code 0 2 has been added for Output lock change
- Event code 1 2 has been added for Input lock change
- Hardware layout for relay outputs has been made conform to the manual: Relay numbering has been modified
- Testing instructions for front panel has been added: Test system will receive the necessary messages to be able to test the front panel buttons.
In the Hardware design, a 24LC1025 is used as Eeprom. When multiple bytes are written in one I2C instruction, the Eeprom writes the full 128 bytes (half) page. This IC however cannot write in one I2C instruction over this half page boundary. For example, when 6 bytes are written at page 5 byte 126, you would expect that byte 126, 127, 128, 129, 130 and 131 are written. In reality, byte 126, 127, 0, 1, 2 and 3 are written. To resolve this issue, 2 things needs to be done:
- Make sure that the firmware built-in functions cannot overwrite this half page boundary by restructuring some Memory Model pages
- Make sure, in software, that the write are limited
Following changes in Memory Model have been done:
- Memory model change "Input action press 1 second":
- Old position: Second page Byte 112-159
- New position: First page Byte 32-79
- Memory model change "Group Action BA pages"
- Old: 42 Basic Action consecutive per 1 page (256 bytes)
- Group output follow with Argument was not working in combination with Group follow for any output change. This has been resolved in this release.
Not Resolved bugs
- BA20 70 has been added
- BA20 71 has been added
- BA20 72 has been added
- BA20 73 has been added
- CLI instruction "??" and "basic action list" have been removed to optimise PSV memory
- CLI instruction "on" has been added as alias of CLI instruction "output on"
- CLI instruction "off" has been added as alias of CLI instruction "output off"
- CLI instruction "aoff" has been added as alias of CLI instruction "output all off"
- CLI instruction "el" has been added as alias of CLI instruction "error list"
- CLI instruction "ooo" has been added as alias of CLI instruction "output status on"
Not Resolved bugs
- Group action with arguments give the possibility to use the condition of an output for example to switch leds or other outputs without using IF THEN ELSE instructions:
- BA19 2 has been added
- BA0 21 has been added
- BA0 22 has been added
- BA20 50 has been added
- BA20 51 has been added
- Output follow action has been added:
- Memory Model Page 0 Byte 60-61 has been added
- BA19 56 has been added
- In some rare circumstance, the abort function to release blocked state machines was not working properly in some edge circumstances. This could lead for example in situations where the RS485 stopped scanning. This release solves this bug.
- uCAN's changing from 1 CAN bus to another will now automatically be detected. The ping function will be broadcasted and the answer will detect the bus from which the message is coming. If the bus is changed, the CAN bus for that uCAN will be adapted accordingly. This will result in a programmed uCAN that will work on any CAN bus (directly to the Brain(+) or any of the CAN controls) and will be able to boot load independently of the connected CAN bus.
- A bug prevented that the uCAN connected to the Can Control could bootload. This has been solved in this release.
- RS485 instruction "FV" has been made conform to the specs on this wiki (22 bytes long)
- CLI messages have been added for following events
- A new uCAN has been added
- A new uCAN input has been added
- A new uCAN sensor has been added
- BA 253 3 has been changed:
- This BA is now used to switch ON/OFF the CAN power of all connected CAN Control modules
- Broadcast message has been added to switch ON/OFF power of the CAN Control modules
- The CAN Control reports back the power status of the CAN bus
- CLI instruction "error list"
- In the list, for every line, you can see the power status
- When using CLI instruction "firmware version", the title of non-used module types also appeared. This is resolved in this version.
- BB debug mode has been added:
- Eeprom Memory Model Page 0 Byte 13 has been added which sets the BB Debug Mode
- CLI instruction "error list" will also display the BB Debug mode.
- API Instruction "ST" (info_type=0 and info_type=2) has been modified so BB Debug mode is included
- Event 22 0 has been added
- API Instruction "BA" was also accepting messages with length different from 6 (should always be 6). When this happens now, the message will not be accepted and new error 24 will be thrown.
- API Instruction "MR" was only returning 3 correct bytes when reading FRAM, this has been resolved in this release.
- CLI Instruction "firmware version" was not always correctly working
- Further enhancements for using with the OpenMotics Testsystem
- FRAM writing using CLI and UART API has been limited to make sure that protected pages (0 and 50) can't be overwritten by the user or BB.
- When a Brain+ is initialised without Front Panel, it will be configured as a Brain. When the Front Panel is connected afterwards, the initialisation of the internal modules was not redone keeping in the Brain modules instead of the Brain+ modules. This release solves this issue.
- When input link information was directly written to Eeprom (via API), the last input module was not taken into account when performing an Eeprom activate.
- All the necessary CAN and RS485 instructions have been added so the Brain(+) can communicate with the test system to perform an integrated hardware test.
- Hardware E4 version has different input electronics so the firmware has been adapted to cope with this.
- During startup, after firmware loading, i2c errors sometimes happened. This release solves this problem.
- A not working Can Control was wrongly detected by the health check service resulting in the wrong status of the Status led.
- Improved resolving process in case of failed i2c bus
- The indicate function for external modules has been added. With the below instructions and BA's, you can let the led of the requested input, output, dimmer, sensor etc flash. The necessary CLI instructions and BA's have been added:
- BA0 200 has been added: Output indicate (flash corresponding led if available)
- BA1 200 has been added: Input indicate (flash corresponding led if available)
- BA8 200 has been added: Sensor indicate (flash corresponding led if available)
- BA10 200 has been added: Shutter indicate (flash corresponding led if available)
- CLI instruction "input indicate" has been added
- CLI instruction "output indicate" has been added
- CLI instruction "sensor indicate" has been added
- CLI instruction "shutter indicate" has been added
- CLI instruction "register list" has been added: This instruction will return the processors registers that can be used by the development team for debug purposes.
- Status led function has been modified:
- The led will now indicate the status of the RS485 bus and the connected RS485 sales modules:
- OFF: The Power of the RS485 bus is OFF
- GREEN (flashing): No RS485 slave modules have been configured and the POWER of the RS485 bus is ON
- GREEN (non flashing): RS485 modules are communicating correctly and have the health status "GOOD"
- ORANGE (flashing): RS485 in search mode (looking for new RS485 modules)
- ORANGE (non flashing): The initialisation mode is active and modules can be added manually
- RED: No modules are responding and all modules have a non-good status
- The led will now indicate the status of the RS485 bus and the connected RS485 sales modules:
- Health status of the Micro CAN's has been added:
- The CAN Status led of the Brain(+) will act upon the error status of the individual Micro CAN's connected on the internal bus
- OFF: The Power of the Internal CAN bus is OFF
- RED (flashing): The Internal CAN bus has a problem and some Micro CAN modules are not responding.
- RED: No modules are responding to the ping request of the Brain(+) on the internal CAN bus.
- The Brain(+) will also check the health of the Micro CAN modules connected on Can Controls. When health will be checked by sending ping messages via the connected Can Controls. The health status detected by the Brain(+) is forwarded over RS485 API to the CAN Control. The CAN Control status led will be set based on this health information:
- RED (flashing): The external CAN bus has a problem and some Micro CAN modules are not responding.
- RED: No modules are responding to the ping request.
- In the CLI instruction "Error list", the health status can be found as well.
- The CAN Status led of the Brain(+) will act upon the error status of the individual Micro CAN's connected on the internal bus
- In the CLI instruction "error list", the electronic CAN termination status can be found as well.
- Execute list of Basic Actions through UART API:
- API call "ES" has been added
- This API call will allow to execute a series of Basic Actions. A Basic Action consist of following elements:
- Type (byte): Type of action, for example all output actions have Type 0
- Action (byte): This is the action itself, for example switch Output On or OFF
- BA20 105 has been added: Enable/Disable buzzer for an individual uCAN module
- BA20 106 has been added: Enable/Disable Multi Color led for all uCAN modules
- BA20 107 has been added: Enable/Disable buzzer for all uCAN modules
- uCAN modules now receive the necessary feedback from the Brain(+), when an input is pressed, to decide that non-configured inputs must beep and the corresponding leds must be turned on.
- Adding Documention
- See AIO Tips & tricks during installation and troubleshooting
- When on a uCAN a Temperature or Temperature/humidity sensor was connected (with brightness), the brightness sensor always gave the value 255 instead of 65535 (for a non connected brightness sensor)
- API Instruction "SI" (Sensor Information) has been extended with Instruction 6 (request Temperature Offset value)
- BA20 103 has been added (switch ON/OFF buzzer of Micro CAN)
- When input, sensor or module indicate is done of a Micro CAN, the buzzer will also be switch ON together with the led representation
- BA20 104 has been added (switch ON/OFF built-in multi color indication led)
- Event 21 0 has been added to receive uCAN events: For example, when a short circuit or over current situation happens on the 5V out of the uCAN, this Event will be send. When the 5V out is normal again, an other event will be send again.
- Request of Slave Firmware Version:
- The Firmware version is requested to each individual module over RS485
- The responses are displayed on the CLI console or send through RS232 API Instruction
- API Instruction "FW" have been added
- BA 250 has been added
- CRC16 calculation for output (including Dim Control) RS485 writing has been added. This allows better integrity and avoid ghost output behaviour in extreme situations.
- On the different levels, the Dim value range that can be used is changed from 0-63 to 0-255
- Offset function for temperature has been added:
- Offset values are stores in FRAM (page 51)
- Basic Action 7 has been added. BA7 will set the offset and write the according value into FRAM.
- CLI instruction "sensor list" has been modified to also display the Temperature offset
- When I2C information is read, it is only used when no errors have occurred in the I2C communication
- The Core has a new Front panel with modified hardware. This version supports the latest Front Panel Hardware (OMH06 B-1 CE 09/2020)
- "all lights off" functionality switches off all lights system wise but the remote modules did not always follow due to timings issues. This is resolved in this release.
- The Open Collector outputs on the Core did not work yet
- The input names in the CLI did not display correctly
- When requesting the Pulse Counter information from an input module via API or CLI, the error number counter of that module increased with 1. This is resolved in this release.
- CLI instruction "error list" has been modified
- Add Voltage and current (not yet active)
- Add 12V Out state
- 12V switching (ON/OFF) works now
- Internal pulse counters:
- Output Type (Page 1-80 Byte 31-38)
- Output type has been modified to be in line with the Classic Master
- When the number of output modules was put on 0 by using CLI instruction "output number modules write 0", a lot of errors appeared on the CLI console. This release resolves this bug.
- When no uCAN's are yet initialised on the CAN bus, the CAN stays led will remain OFF and will only turn red when CAN network problems or bad connection happens when uCAN's are already initialised on that bus.
- In the Eeprom/FRAM memory model, not all value were kept in big endian. Following changes have been made:
- Eeprom: Page 1-80: Timer Output
- Eeprom: Page 256-259: Start Group
- Eeprom: Page 393-394: Up Timer Shutter
- Eeprom: Page 395-396: Down Timer Shutter
- Eeprom: Page 413-414: Shutter Group value for roller/shutter nr
- Fram: Page 11-18: Current Shutter Position
- Fram: Page 19: Current Shutter Group Position
- Pulse Counter functionality
- API RS485 instruction "Request state of Input Module: Full Pulse Counter Information" has been added
- API RS485 instruction "Request state of Input Module: Input state" has been added
- API instruction "PC" has been added to read a single pulse counter or 8 pulse counters (full module)
- CLI instruction "pulse counter read" has been added
- Error checking and handling has been added for modules not available
- FRAM page 50 has been added
- The Pulse Counters for the internal inputs are incremented when a "press" is detected
- These bytes are written twice in FRAM
- When an Output is switched ON with a timer activated, the timer value is written in FRAM once a second. A reset (hard or soft) did not load the last timer value from FRAM correctly. This is solved in this release.
- Added Input/Output Lock/Unlock functionality:
- Input press/release routines have been modified so they won't be executed when an input is locked
- Output switch ON/OFF routines have been modified so they won't be executed when an output is locked
- Input/Output lock functionality is kept in FRAM
- API Instruction "OD" has been modified and the Output Lock/Unlock status has been added
- API Instruction "IC" has been modified and the Input Lock/Unlock status has been added
- API Instruction "OC" has been added (Output Configuration)
- Locking/Unlocking is fully functional in this release
- For the Core+, 4 dim control outputs are available. The virtual module consist of 8 virtual outputs of which 4 are used for the Dim Control outputs available on the Core+ but the 4 non-used outputs also switched on/off leds on the Front Panel. So in this release, the 4 non used outputs will not switch ON/OFF any leds on the front panel.
- BA 253 2 x - has been added: Switch Power of the internal I2C bus
- BA 253 3 x - has been added: Switch Power of the external 10VDC Output
- BA 253 4 x - has been added: Switch Termination of the CAN bus on the Core/Core+
- BA 254 1 - - has been added: Perform reset of the BB via reset pin of the BB
- Memory Model Page0 Byte12 has been added: Can Bus Termination setting
- Added Input/Output Lock/Unlock functionality:
- Memory Model FRAM: Input Pages "Input Lock/Unlock bytes" have been added
- Memory Model FRAM: Output Pages "Output Lock/Unlock bytes" have been added
- BA 0 250 x y has been added: Unlock/Lock Output x
- BA 1 250 x y has been added: Unlock/Lock Input x
- During startup, the FRAM data is read so the Lock/Unlock status is kept in the right mode
- The CLI command "input list" has been modified that is also displays the lock status
- The CLI command "output list" has been modified that is also displays the lock status
- Locking/Unlocking is still in development in this release and cannot be used yet
- The Front Panel of the Core+ has a built-in Dim Control module with 4 outputs 0-10VDC:
- Added the necessary configuration routines for the DAC5574 AD chip
- Adding virtual module for the internal Dim Control Module
- Linking the virtual Dim Control Module with the DAC5574
- Linking the Front Panel leds with the Virtual Dim Control module
- A configuration without sensor modules generated a lot of errors on the CLI console
- A new type of module has been introduced: "L" and "l"
- "L": Open Collector module
- "l": Virtual or internal (for Core and Core+) Open Collector module
- The Core/Core+ has an additional input (5 instead of 4), this input has been activated in Firmware
- The Front Panel Hardware of the Core+ has been changed. The firmware is adapted to cope with the new hardware
- The Front Panel Hardware of the Core+ has 3 Open Collector outputs that are routed to the Mezzanine connector:
- Front Panel Health detection added:
- Detection when Front Panel issues are happening
- Resolving the Front Panel issue and putting the Front Panel in normal state again
- I2C Frontpanel scanning methods has been adapted:
- In the past, the front panel buttons were scanned every 100ms
- Inconsistent behaviour when adding Micro CAN's on the CAN bus of the Core/Core+
- Using CLI instruction "can ping list", not all responding messages via the CAN Control were captured resulting that the Micro CAN module was indicated as "not available"
- BA20 1 have been added
- Switching ON/OFF all leds of all connected Micro CAN's
- Switching ON/OFF all status leds of all connected Micro CAN's
- Front Panel leds
- In Automatic Module Discovery, the delay for RS485 output modules between 2 scan's wasn't high enough resulting not all modules being added. This release solves this issue.
- When a power or software reset is done of the Master, a search of new RS485 modules will automatically performed. When no new modules are present on the RS485 Bus, the search takes less then 200ms.
- During Automatic Module Discovery, the status led will blink orange
- When CLI instruction "can ping list" was used, the time indicated (in ms) was the time needed for all packets to be transmitted and received. The time now will indicate the round trip of 1 packet.
- Automatic Module Discovery: The system allows to add RS485 modules automatically without pressing any init button (only available for GEN3 hardware)
- BA 200 0 0 1 have been added (start Automatic Module Discovery)
- CLI instruction "module discover search" have been added (start Automatic Module Discovery)
- The Master will detect bus collisions and knows when multiple clients are responding.
- The above feature only works with Slave modules with firmware F6.x.y
- Startup time (without Automatic Module Discovery) has been reduced from 12 to 6 seconds (the time needed to load all Eeprom parameters in RAM)
- Better performance and stability of the RS485 Bus
- Interrupt priorities have been adapted
- RS485 scan algorithm has been adapted to make sure all modules get's equal air time
- Integration of the new Can Control
- Can Control Modules with Firmware version 6.0.23 or higher can be connected
- Max 128 uCAN's can be connected in total for all segments
- Max 7 CAN segments (Core/Core+:1, Can Control Modules:6)
- The Core/Core+ will convert these different CAN segments into 1 large CAN network
- CLI, API and BA instruction "error clear" also clears the Can Control errors
- Queue has been added for all incoming CAN messages from the different CAN Control modules
- BA20 20 have been added
- In some circumstances, sensor values from used sensor could be copied at non-used sensors. This version solves this problem.
- An API Event was sent every minute reporting the onboard temperature. In this release, this is changed towards an event only when the onboard temperature is changed.
- An API Event was sent twice for an output change. This is resolved in this version.
- API Instruction "TW" (Time/Date write) was not yet programmed and is now included in this release
- CLI instruction "shutter list" was not indicating the correct shutter direction (YES UP or YES DWN)
- In the shutter configuration, some bit logic was wrong writing resulting in the wrong configuration
- API Instruction "TC" gave some timing issues on the RS485 Bus resulting in bad information coming from the RS485 Bus
- Error 23 has been added in the error list
- Group actions with only 1 BA didn't work
- Front panel Button functionality has been extended
- When a button is pressed, an API Event 250 will be send
- When a button is released, an API Event 250 will be send
- When a button is pressed for more than 5 seconds, an API Event 250 will be send
- When a button is pressed for more than 8 seconds, an API Event 250 will be send
- A bug existed in the CLI commands to write a names for example "output name write" which wrote only 1 character
- Group Actions:
- Eeprom pages of the Group Name have been changed
- Eeprom pages of the Group BA's have been changed
- CLI instruction "group ba read" has been added
- BA19 201 has been added (write Group end address)
- Documentation has been changed
- When using a Core or Core+ without a connected front panel, frontpanel button actions could be activated (like "module discover start" for example).
- Integration of the New Can Control module that support direct communication channels between the Master and the CAN/DALI Bus over the CAN Controle Module:
- Basic initialisation of the Can Control module is supported
- Variable RS485 message length is supported with integrated CRC calculation
- API Instruction "ST" has been extended:
- Request of Firmware version has been added
- This firmware adds the functionality to bootload slave modules:
- See AIO Bootloading Slave modules
- API Instruction "ST" has been added (Status RS485 mode)
- API Instruction "SM" has been added (Set RS485 mode)
- Front Panel leds functionality for the Core+ has been added
- Detection Front Panel between Core and Core+
- Correct Input/Output modules will be configured when, at startup, a Core or a Core+ is detected
- Button functionality of the Core+ has been added
- See AIO led and button functionality
- API Event "EV" message 251 and 252 (Event for changing status leds on the Front Panel) was being sent every second.
- API Instruction "GC" had the incorrect length assigned
- When shutters are moved up/down or stopped, the API instruction "EV" was not sent. This release solves this issue.
- Power switching:
- Added BA253 0 -> Switch ON/OFF power of the RS485 Bus
- Added BA253 1 -> Switch ON/OFF power of the CAN bus
- Firmware will make sure that all communication is stopped before switching OFF one of the busses
- Event type 253 has been added to indicate a power change status
- I2C has been rewritten to more easily integrate different kind of chips
- Blocking and non-blocking routines work on the same framework now
- Detection of each I2C chip is done at startup
- When a chip is unavailable, the CPU will not try to communicate with it
- Front panel leds and buttons
- ON/OFF/Blinking functionality has been added
- Leds can blink at duty cycle of 25%, 50% or 75%
- BA210 has been added so the Master and BB can control the individual leds
- Leds and buttons of the Core are implemented
- Leds and buttons of the Core+ are not yet implemented
- See AIO led and button functionality
- Detection Core/Core+
- Depending on the Front Panel hardware, detection will be made if it's a Core or Core+ module
- Depending if it's a Core or Core+, the right number of modules will be assigned.
- CLI instruction "error list" has been adapted to indicate which type of module it is
- The necessary modifications are made to support the Can Control module
- "C" module has been added, separate module scanning for the CAN Control has been introduced
- Health status for CAN module
- Adapted CLI instructions like "error list" to display the CAN Control modules
- BA204 has been added
- This release extend the MODBUS support, see MODBUS AIO for configuration example
- API Instruction "CS" has been added
- CLI Instruction "input search can id" has been added
- This release extended the MODBUS support, see MODBUS AIO for configuration example
- Modbus Speed, Type and Model have been added, see Modbus Parameters
- BA20 23 has been added
- BA20 24 has been added
- BA20 25 has been added
- BA20 28 has been added
- BA20 29 has been added
- API Instruction "mR" has been added: Modbus Read
- API Instruction "CD" has been adapted
- This release supports MODBUS thermostats
- See MODBUS AIO
- BA20 26 has been added
- BA20 27 has been added
- CLI instruction “can ping list” has been modified to display the Modbus information
- CLI instruction “can eeprom list” has been modified to display the Modbus information
- In Memory model: Page 383-386: Modbus bytes have been added
- I2C hw reset code has been improved and made more robust
- Helvar and Lunatone uses a different address scheme in their application. To avoid confusion, the Lunatone Dali addressing is used and the code is adapted accordingly.
- The startup time/date and hours online were not recorded correctly anymore, this bug is resolved
- The necessary code has been added to read the onboard temperature sensor so monitoring of the base PCB can be done.
- Temperature is measured every minute
- API "EV" is sent every minute to update the temperature
- CLI instruction "error list" has been modified so the board temperature is displayed as well
- API or CLI instruction "eeprom activate" will read the onboard temperature immediately.
- Basic Actions
- BA21 0 has been added: DALI output OFF
- BA21 1 has been added: DALI output ON
- BA21 2 has been added: DALI Group OFF
- BA21 3 has been added: DALI Group ON
- BA21 20 has been added: Output linked with DALI Output or DALI Group
- BA21 21 has been added: Input linked with DALI (Lunatone or Helvar) input.
- BA21 22 has been added: Sensor linked with DALI (Lunatone) sensor.
- Support of DALI motion sensors has been added
- Support of DALI outputs (dimmed and non-dimmed) has been added
- The use of DALI is described in following page: Dali AIO
- API instructions
- Instruction "IC" is modified and now also contains the Dali Input Link bytes
- Instruction "OD" is modified and now also contains the Dali Output Link bytes
- Instruction "SI" is modified:
- VOC information can be requested
- CO2 information can be requested
- Extra sensor information can be requested
- Sensor configuration
- Extra Sensor configuration
- API instruction "FS": In the "FS" response, the order in which data0..2 was sent in the wrong order
- Basic Actions
- BA10 0 has been added: Shutter x stop
- BA10 1 has been added: Shutter x up
- BA10 2 has been added: Shutter x down
- BA10 3 has been added: Shutter x up-stop-up-stop...
- BA10 4 has been added: Shutter x down-stop-down-stop...
- BA10 5 has been added: Shutter x up-stop-down-stop...
- BA10 20 has been added: Shutter x locked
- BA10 21 has been added: Shutter x stopped & locked
- BA10 22 has been added: Shutter x up & locked
- BA10 23 has been added: Shutter x down & locked
- BA10 24 has been added: Shutter x unlocked
- BA10 100 has been added: Shutter x is linked to output duo nr y
- BA10 104 has been added: For output duo x, set duo as OUTPUT when y=1, set duo as SHUTTER when y=0
- BA10 105 has been added: Link shutter x with shutter group y
- BA10 106 has been added: Unlink shutter x with shutter group y
- CLI instructions
- CLI instruction "shutter list" has been added
- CLI instruction "shutter group link list" has been added
- CLI instruction "shutter name read" has been added
- CLI instruction "shutter name write" has been added
- Output module in Roller/shutter mode
- Shutter groups
- API instructions
- Instruction response "GC" info_type=1 has 2 extra parameters: Max_shutters and Max_group_shutters
- API instruction "sD" has been added
- API instruction "FS" reported the wrong length
- Roller/Shutter functionality
- Eeprom Page 391 is used to link the Roller shutter Nr with the Output Nr
- 32K PSV memory limit
- In this release, The CLI instructions are stored in ROM in stead of PSV.
- FRAM functionality
- API instructions
- Instruction "FM" will now always respond with CID=1
- Functions like "output all off" didn't always switch off all outputs on the RS485 modules.
- API commands "DL" and "GC" didn't respond.
- When an input was pressed or released, the same API "EV" was sent.
- API command "EV" did report the wrong timer value when an output was changed.
- API command "MR" was missing 1 byte in the response string
- FRAM support:
- Add queueing for FRAM writes
- Status outputs (status + dimmer value) are stored in FRAM
- The number of uptime hours are being kept in FRAM. Every hours, this is written in FRAM.
- Uptime, firmware version & startup time/date is displayed in "error list".
- Page 0 is protected now and can't be changed by using CLI/API instructions.
- RS485 bus stability
- Eeprom value (Page0 Byte8) has been added which gives the number of ms between each scan of a module
- With this value, the Bus speed can be modified and tuned if needed.
- The standard value works for the most common environments
- Module Type
- Module type has been added so the BB knows which kind of module is initialised
- Module type has been added in "error list"
- Module type has been added in API instruction "MC"
- API instruction "OD" (Output Detail) has been added, see https://wiki.openmotics.com/index.php/API_Reference_Guide_AIO
- API instruction "IC" (Input Configuration) has been added, see https://wiki.openmotics.com/index.php/API_Reference_Guide_AIO
- API instruction "MC" (Module Configuration) has been added, see https://wiki.openmotics.com/index.php/API_Reference_Guide_AIO
- API instruction "GC" (General Configuration) has been added, see https://wiki.openmotics.com/index.php/API_Reference_Guide_AIO
- API instruction "TW" (Write Time and Date) has been added, see https://wiki.openmotics.com/index.php/API_Reference_Guide_AIO
- API instruction "TR" (Read Time and Date) has been added, see https://wiki.openmotics.com/index.php/API_Reference_Guide_AIO
- API instruction "DL" (Device List, Output and Input status) has been added, see https://wiki.openmotics.com/index.php/API_Reference_Guide_AIO
- Error queueing has been improved
- API Events ("EV") have been added for input press and input release, see https://wiki.openmotics.com/index.php/AIO_API_Event_Codes
- Removing CAN bus when AIO was in ON state and after 10 minutes, reconnecting didn't bring back the CAN bus. CAN bus now comes back after +/-1 minute.
- When the power was applied and the date was not yet set for the first time, the Clock always started at 00:00:00. This release fixes this issue.
- With the CLI instruction "sensor list", in rare events, ghost values appeared (strange values for non connected sensor). The values remained correct in memory but were wrongly displayed. This release fixes this issue.
- API instruction "EV" (Event) has been added, see https://wiki.openmotics.com/index.php/API_Reference_Guide_AIO
- API instruction "ER" (Error) has been added, see https://wiki.openmotics.com/index.php/API_Reference_Guide_AIO
- API instruction "SI" (Sensor Information) has been added, see https://wiki.openmotics.com/index.php/API_Reference_Guide_AIO
- API instruction "MR" (Memory (Eeprom) Read) has been added, see https://wiki.openmotics.com/index.php/API_Reference_Guide_AIO
- API instruction "MW" (Memory (Eeprom) Write) has been added, see https://wiki.openmotics.com/index.php/API_Reference_Guide_AIO
- New state machine checks sensor health every 2 minutes, if a sensor is not responding, API message ERR will be send
- This has been added for uCAN sensors
- This has been added for sensors connected to the Openmotics Temperature module
- If a sensor is not responding, the sensor value will be put on NA
- CLI instruction "health debug on" and "health debug off" has been added, see https://wiki.openmotics.com/index.php/CLI_Reference_Guide_AIO
- When a sensor is not reporting a value, this will be printed on the console when health debug is on
- CLI instruction "change debug on" and "change debug off" has been added, see https://wiki.openmotics.com/index.php/CLI_Reference_Guide_AIO
- Sensor (temperature, humidity, brightness) follow function for non-can sensors has been added including the debug functions.